From a129c4d54ee930cc1dd5472177035d94cab19def Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 1 Jul 1999 21:54:33 -0500 Subject: [svn-r1404] H5.format.html Copy edits Beginning of revisions to bring the Specification up-to-date and move it to present tense Couple of new intro paragraphs, designed largely to offer the user a bit more context H5.user.html Datatypes.html Font correction and minor formatting changes. H5.user.PrintGen.html H5.user.PrintTpg.html New files to enable creating a searchable and printable version of the HDF5 User's Guide. These files enable the creation of a PDF file containing the entire document. H5.user.PrintGen.html controls the print job; H5.user.PrintTpg.html is the title page for the PDF volume. --- doc/html/Datatypes.html | 2 +- doc/html/H5.format.html | 93 +++++++++++++++++++++++++++- doc/html/H5.user.PrintGen.html | 135 +++++++++++++++++++++++++++++++++++++++++ doc/html/H5.user.PrintTpg.html | 75 +++++++++++++++++++++++ doc/html/H5.user.html | 1 + 5 files changed, 302 insertions(+), 4 deletions(-) create mode 100644 doc/html/H5.user.PrintGen.html create mode 100644 doc/html/H5.user.PrintTpg.html diff --git a/doc/html/Datatypes.html b/doc/html/Datatypes.html index e6aaeb8..8d0b674 100644 --- a/doc/html/Datatypes.html +++ b/doc/html/Datatypes.html @@ -1252,7 +1252,7 @@ hid_t dset4 = H5Dcreate (file, "dset4", t2, space, H5P_DEFAULT); conversion path, then the hard function is favored and when multiple soft functions apply, the one defined last is favored. -

A data conversion function is of type H5T_conv_t +

A data conversion function is of type H5T_conv_t which is defined as:

diff --git a/doc/html/H5.format.html b/doc/html/H5.format.html index a098deb..59bc28d 100644 --- a/doc/html/H5.format.html +++ b/doc/html/H5.format.html @@ -4,7 +4,7 @@ HDF5 Disk-Format Specification - +

HDF5: Disk Format Implementation

    @@ -81,10 +81,97 @@

    The format of a HDF5 file on disk encompasses several key ideas of the current HDF4 & AIO file formats as well as - addressing some short-comings therein. The new format will be - more self-describing than the HDF4 format and will be more + addressing some short-comings therein. The new format is + more self-describing than the HDF4 format and is more uniformly applied to data objects in the file. +

    An HDF5 file can be thought of as a directed graph. + The nodes of this graph are the higher-level HDF5 objects, + including groups, datasets, datatypes, and dataspaces. + This document describes the lower-level data objects used by + the HDF5 library to represent those higher-level objects and + their properties. + +

    At the lowest level, an HDF5 file is made up of the following + objects: +

      +
    • A bool block +
    • B-tree nodes (containing either symbol nodes or raw data chunks) +
    • Object headers +
    • Collections +
    • Local heaps +
    • Free space +
    + As indicated above, the HDF5 library uses and interprets these + low-level objects to describe the high-level HDF5 objects that + are revealed to the user, and to higher-level applications, + through the HDF5 APIs. + + + +

    Three levels of information compose the file format. The level 0 contains basic information for identifying and diff --git a/doc/html/H5.user.PrintGen.html b/doc/html/H5.user.PrintGen.html new file mode 100644 index 0000000..be1a537 --- /dev/null +++ b/doc/html/H5.user.PrintGen.html @@ -0,0 +1,135 @@ + + + + HDF5 User's Guide -- Single Print + + + + + + +

    + + +

    A User's Guide for HDF5

    + +This page provides a means of printing the HDF5 User's Guide +with a single print command as follows: +
    1. Open this page in Internet Explorer, version 4.0 or or later. + (Sorry, but as of this writing, Netscape does not offer the required + print feature.) +
    2. On the File menu, select Print. +
    3. In the Print dialogue box, select + Print all linked documents. +
    4. Select OK. Depending on the print settings of your + browser, this will produce a 100- to 200-page set of documents, + one chapter or section at a time. +
    5. Once the print job is complete, discard the first page printed (this page). + The rest of the printout should form a complete copy of the + HDF5 User's Guide. +
    + + +

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + +
    Title Page +     Title page. +
    Copyright +     The HDF5 copyright notice, contact information, + and other back-of-the-title-page material. +
    TOC +     Table of contents. +
    HDF5 Files +     A guide to the H5F interface. +
    Datasets + A guide to the H5D + interface. +
    Data Types and +
         + Enumeration Data Types +     		A guide to the H5T + interface. +
    Dataspaces + A guide to the H5S + interface. +
    Groups + A guide to the H5G + interface. +
    References and + Identifiers + A guide to the H5R + and H5I interfaces. +
    Attributes + A guide to the H5A + interface. +
    Property Lists + A guide to the H5P + interface. +
    Error Handling + A guide to the H5E + interface. +
    Filters + A guide to the H5Z + interface. +
    Caching + A guide for meta and raw data caching. +
    Dataset Chunking + A guide to the issues and pitfalls + of dataset chunking. +
    Debugging + A guide to debugging HDF5 API calls. +
    Environment Variables + and Configuration Parameters + A list of HDF5 environment variables + and
       configuration parameters. +
    DDL for HDF5 + A DDL in BNF for HDF5. +
    Ragged Arrays +
    A guide to the + H5RA interface. +   (Experimental) +
    +
    + + +

    + +
    + + +
    + +
    +HDF Help Desk +
    +Last modified: 1 June 1999 + +
    + + + diff --git a/doc/html/H5.user.PrintTpg.html b/doc/html/H5.user.PrintTpg.html new file mode 100644 index 0000000..1b018e0 --- /dev/null +++ b/doc/html/H5.user.PrintTpg.html @@ -0,0 +1,75 @@ + + + + HDF5 User's Guide + + + + + + +
    +
    +

    + +
    + + +A User's Guide for HDF5 + + +


    +
    +
    +


    + + +Release 1.0 +
    +January 1999 +     + +



    + + +Hierarchical Data Format (HDF) Group +
    +National Center for Supercomputing Applications (NCSA) +
    +University of Illinois at Urbana-Champaign (UIUC) +     + +
    + +


    +
    +
    +


    +


    + +
    +A Note to the Reader: +The primary HDF5 user documents are the online HTML documents +distributed with the HDF5 code and binaries and found on the HDF5 website. +Several users have expressed a desire for documents in an alternative format: +
      +
    • Some have requested a version that can be reasonably printed in a + single print operation. +
    • Others have requested an easily searchable version. +
    +This PDF file has been created expressly to meet these needs. +

    +The reader will note that each section of this document looks very much +as the corresponding HTML page would look in a web browser. That is not +accidental as the HTML version remains the HDF5 development team's primary +documentation vehicle. +

    + + +

    +
    + + + + + diff --git a/doc/html/H5.user.html b/doc/html/H5.user.html index e49e6a4..f15e164 100644 --- a/doc/html/H5.user.html +++ b/doc/html/H5.user.html @@ -148,6 +148,7 @@ And in this document, the +