summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>1999-07-02 02:54:33 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>1999-07-02 02:54:33 (GMT)
commita129c4d54ee930cc1dd5472177035d94cab19def (patch)
tree6e700705df31689d73eb9f1b57bc7ad4fc7e2180 /doc
parent2e69c87e6bb087451a1bd80c0274ff35ab5de340 (diff)
downloadhdf5-a129c4d54ee930cc1dd5472177035d94cab19def.zip
hdf5-a129c4d54ee930cc1dd5472177035d94cab19def.tar.gz
hdf5-a129c4d54ee930cc1dd5472177035d94cab19def.tar.bz2
[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.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/Datatypes.html2
-rw-r--r--doc/html/H5.format.html93
-rw-r--r--doc/html/H5.user.PrintGen.html135
-rw-r--r--doc/html/H5.user.PrintTpg.html75
-rw-r--r--doc/html/H5.user.html1
5 files changed, 302 insertions, 4 deletions
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.
- <p>A data conversion function is of type <code>H5T_conv_t</em>
+ <p>A data conversion function is of type <code>H5T_conv_t</code>
which is defined as:
<p>
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
</title>
</head>
- <body>
+ <body bgcolor="#FFFFFF">
<center><h1>HDF5: Disk Format Implementation</h1></center>
<ol type=I>
@@ -81,10 +81,97 @@
<P>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.
+ <P>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.
+
+ <P>At the lowest level, an HDF5 file is made up of the following
+ objects:
+ <ul>
+ <li>A bool block
+ <li>B-tree nodes (containing either symbol nodes or raw data chunks)
+ <li>Object headers
+ <li>Collections
+ <li>Local heaps
+ <li>Free space
+ </ul>
+ 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.
+
+<!--
+<blockquote>
+<pre>
+
+---------- Edit from here... -------------
+
+
+Once you know about all these low-level objects you can build bigger
+and better things, which is what most people are interested in and
+which are the objects that the hdf5 library exposes in the API. They
+are:
+
+ * Groups
+ * Datasets
+ * Datatypes
+ * Data spaces
+
+For instance, a group is an object header that contains a message that
+points to a local heap and to a B-tree which points to symbol nodes.
+A dataset is an object header that contains messages that describe
+data type, space, layout, filters, external files, fill value, etc
+with the layout message pointing to either a raw data chunk or to a
+B-tree that points to raw data chunks.
+
+Elena> Would it be more logical to discuss things in this order?
+
+Elena> Intro ( What is HDF5 file, etc.)
+Elena> File Header
+Elena> File Body
+Elena> Objects
+Elena> Object Header
+Elena> Object Header Message Data
+Elena> NOTE: give reference to the detailed discussion of the B-trees
+Elena> when needed. Right now we do not have specification (only general one)
+Elena> for the Symbol Table B-trees and B-trees used to manage chunked datasets.
+Elena> B-trees
+Elena> General Discussion
+Elena> Object related discussions
+Elena> Symbol Tables
+Elena> Global heap
+Elena> "Free-space object"
+
+That might be a good order for someone that's familiar with the API
+but if you're trying to get all the way down to the file format level
+it results in a lot of forward references in the documentation. It
+might be better to do a bottom-up documentation similar to the order I
+used above:
+
+ * General file layout
+ * Boot block
+ * Format-level objects (B-trees, symbol nodes, object headers, etc).
+ * Object header messages
+ * High-level objects (datasets, groups, named types and spaces, etc)
+
+where "high-level objects" description mostly describes which object
+header messages are required, optional, mutually exclusive, etc. for
+each high-level object.
+
+---------- ...to here. -------------
+
+</pre>
+</blockquote>
+-->
+
+
<P>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 @@
+<html>
+ <head>
+ <title>
+ HDF5 User's Guide -- Single Print
+ </title>
+ </head>
+
+ <body bgcolor="#FFFFFF">
+
+
+<hr>
+
+
+ <center><h1>A User's Guide for HDF5</h1></center>
+
+This page provides a means of printing the <cite>HDF5 User's Guide</cite>
+with a single print command as follows:
+<ol><li>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.)
+ <li>On the <strong>File</strong> menu, select <strong>Print</strong>.
+ <li>In the <strong>Print</strong> dialogue box, select
+ <strong>Print all linked documents</strong>.
+ <li>Select <strong>OK</strong>. 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.
+ <li>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
+ <cite>HDF5 User's Guide</cite>.
+</ol>
+
+
+<br><br>
+<center>
+<table border=0 width=85%>
+
+ <tr><td valign=top><a href="H5.user.PrintTpg.html" target="PrintWin">Title Page</a>
+ </td><td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
+ <td valign=top>Title page.
+ </td></tr>
+ <tr><td valign=top><a href="Copyright.html" target="PrintWin">Copyright</a>
+ </td><td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
+ <td valign=top>The HDF5 copyright notice, contact information,
+ and other <i>back-of-the-title-page</i> material.
+ </td></tr>
+ <tr><td valign=top><a href="H5.user.html" target="PrintWin">TOC</a>
+ </td><td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
+ <td valign=top>Table of contents.
+ </td></tr>
+ <tr><td valign=top><a href="Files.html" target="PrintWin">HDF5 Files</a>
+ </td><td>&nbsp;&nbsp;&nbsp;&nbsp;</td>
+ <td valign=top>A guide to the <strong>H5F</strong> interface.
+ </td></tr>
+ <tr><td valign=top><a href="Datasets.html" target="PrintWin">Datasets</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5D</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Datatypes.html" target="PrintWin">Data Types</a> and
+ <br>&nbsp;&nbsp;&nbsp;&nbsp;
+ <a href="DatatypesEnum.html" target="PrintWin">Enumeration Data Types</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5T</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Dataspaces.html" target="PrintWin">Dataspaces</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5S</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Groups.html" target="PrintWin">Groups</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5G</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="References.html" target="PrintWin">References and
+ Identifiers</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5R</strong>
+ and <strong>H5I</strong> interfaces.
+ </td></tr>
+ <tr><td valign=top><a href="Attributes.html" target="PrintWin">Attributes</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5A</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Properties.html" target="PrintWin">Property Lists</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5P</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Errors.html" target="PrintWin">Error Handling</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5E</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Filters.html" target="PrintWin">Filters</a>
+ </td><td></td><td valign=top>A guide to the <strong>H5Z</strong>
+ interface.
+ </td></tr>
+ <tr><td valign=top><a href="Caching.html" target="PrintWin">Caching</a>
+ </td><td></td><td valign=top>A guide for meta and raw data caching.
+ </td></tr>
+ <tr><td valign=top><a href="Chunking.html" target="PrintWin">Dataset Chunking</a>
+ </td><td></td><td valign=top>A guide to the issues and pitfalls
+ of dataset chunking.
+ </td></tr>
+ <tr><td valign=top><a href="Debugging.html" target="PrintWin">Debugging</a>
+ </td><td></td><td valign=top>A guide to debugging HDF5 API calls.
+ </td></tr>
+ <tr><td valign=top><a href="Environment.html" target="PrintWin">Environment Variables
+ and Configuration Parameters</a>
+ </td><td></td><td valign=top>A list of HDF5 environment variables
+ and <br>&nbsp;&nbsp;&nbsp;configuration parameters.
+ </td></tr>
+ <tr><td valign=top><a href="ddl.html" target="PrintWin">DDL for HDF5</a>
+ </td><td></td><td valign=top>A DDL in BNF for HDF5.
+ </td></tr>
+ <tr><td valign=top><hr noshade size=1><a href="Ragged.html" target="PrintWin">Ragged Arrays</a>
+ </td><td></td><td valign=top><hr noshade size=1>A guide to the
+ <strong>H5RA</strong> interface.
+ &nbsp;&nbsp;<em><font color=red>(Experimental)</font></em>
+ </td></tr>
+</table>
+</center>
+
+
+<br><br>
+
+<hr>
+
+
+<address>
+<table width=100% border=0>
+<tr><td align=left valign=top>
+<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
+<br>
+Last modified: 1 June 1999
+
+</table>
+
+ </body>
+</html>
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 @@
+<html>
+ <head>
+ <title>
+ HDF5 User's Guide
+ </title>
+ </head>
+
+ <body bgcolor="#FFFFFF">
+
+
+<hr>
+<br>
+<br><br>
+
+<center>
+
+<font size=7>
+A User's Guide for HDF5
+</font>
+
+<br><br><br>
+<hr>
+<hr>
+<br><br><br>
+
+<font size=6>
+Release 1.0
+<br>
+January 1999
+</font>
+
+<br><br><br><br>
+
+<font size=3>
+Hierarchical Data Format (HDF) Group
+<br>
+National Center for Supercomputing Applications (NCSA)
+<br>
+University of Illinois at Urbana-Champaign (UIUC)
+</font>
+
+</center>
+
+<br><br><br>
+<hr>
+<hr>
+<br><br><br>
+<br><br><br>
+
+<blockquote>
+<strong>A Note to the Reader:</strong>
+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:
+<ul>
+<li>Some have requested a version that can be reasonably printed in a
+ single print operation.
+<li>Others have requested an easily searchable version.
+</ul>
+This PDF file has been created expressly to meet these needs.
+<p>
+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.
+</blockquote>
+
+
+<br><br>
+<hr>
+
+
+
+</body>
+</html>
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
</td></tr>
</table>
</center>
+<br>
<!--
<p>The following documents form a loosely organized developer's guide to