Bringing 'last minute' release branch edits into development branch.
Description:
index.html
Added index-level link to "HDF5 Tools."
Tools.html
Added link to "HDF5 Java tools."
Added h52gif and gif2h5.
Platforms tested:
IE 5
Purpose:
Bugfix (Tools.html) and spelling correction (Files.html)
Description:
Tools.html
h5dump -- Removed "interactively" from first description sentence.
(As a user has pointed out, an application that runs and exits
without opportunity for user input is not "interactive".)
Fixes bug #474.
Rewrote introductory sentence to "Tools" page.
Files.html -- Spelling correction
Platforms tested:
IE 5
Purpose:
Repair damaged HTML coding (caused by the Netscape editor)
and restore additions since that damage occured.
Add h5dump subsetting material.
Description:
Reverted to earlier version to restore HTML coding.
Re-entered h5dump XML material and explanatory comment re h5dump
flag parameters.
Added h5dump subsetting material.
Other editing and formatting within h5dump description.
Platforms tested:
IE 5
Purpose:
Linking the new "Predefined Dataypes" document into the RM.
Description:
Added PredefDTypes.html link into all RM files.
Platforms tested:
IE 5
Bug fix
Description:
The documentation on how to dump attribute data was not complete
enough. Some people got confused on the commandline syntax (you
have to specify the "path" from the root group to the attribute
to dump it). I put some examples in to show how to correctly dump
attributes.
Platforms tested:
Viewed with Netscrape.
H5Dopen: Corrected description of 'loc_id' parameter.
RM_H5T.html
H5Tset_strpad:
Corrected string padding values list (replaced 'H5T_STR_NULL &
H5T_STR_SPACE' with ''H5T_STR_NULLTERM, 'H5T_STR_NULLPAD, &
H5T_STR_SPACEPAD'.
Added notes re conversion from shorter to longer strings and
from longer to shorter strings.
Other minor edits and formatting.
H5Tget_class
Corrected H5T_ENUM and H5T_REFERENCE entries in class
identifiers table (they were reversed).
Tools.html
h5dump: Added note that '-bb' option is not yet implemented.
Changed 'boot block' to 'super block'.
DatatypesEnum.html
EnumMap.gif
Added enumeration datatypes -- First pass, only minimal editing.
Intro paragraph in Datatypes.html; details in DatatypesEnum.html.
EnumMap.gif is a figure for DatatypesEnum.html.
Tools.html
Added new h5toh4 supported object and data type.
H5.intro.html
Corrected transposed "start coordinates" in Example 1.
been checked into "HDF5 Development" branch.
General
=======
Various "copy edit" types of repairs.
Revisions to document cross-linking.
Added structural links tying all docs together (banners
at top and bottom of documents, similar to Reference Manual
banners of the Beta release).
Set background color to white in all documents.
NCSAfooterlogo.gif
hdf2.jpg
New image files to make the documents more self-contained
(i.e., to prevent loading images from NCSA and HDF home servers).
index.html
Redesigned to isolate links external to the installation
in a single location.
Intro to HDF5
=============
H5.intro.html
Fixed banner linking Intro to other docs.
Set all URLs to be relative within the distribution; nothing
points back to the HDF server.
Updates to "Limits of the Current Release" and "Changes in
the Current Release."
HDF5 User's Guide
=================
Changed several User Guide section titles such that all
sections that are primarily about a particular interface
are now titled in the format "The xxxxx Interface (H5x)".
H5.user.html
Commented out links to developer docs since they are marked
in MANIFEST as not being for distribution in the release.
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
Datatypes.html
Removed the sentence "I'm deferring definition until later
since they're probably not as important as the other data
types." from Section 3.3, "Properties of Date and Time
Atomic Types."
Added info regarding 'char' versus 'string' datatypes. Added
as Section 3.7, "Character and String Datatype Issues."
References.html
Commented out substantial material (at end of document) from
References planning document that is not appropriate for
the User Guide but that is worth keeping around.
Groups.html
Final edits from elimination of "current working group."
HDF5 Reference Manual
=====================
Removed "Draft" from the <title>__</title> lines.
RM_H5Front.html
Removed 2nd and 3rd indices from page.
Changed "freeform" lists of sections (TOCs) to aligned tables.
RM_H5F.html
RM_H5P.html
Add file mounting information.
Intro
======
H5.intro.html
Major rewrite to Groups section. New Example 7 (groups).
Added TOC and requisite links.
Numbered sections.
Labelled figures and centered those that were not.
Fixed table formatting.
===========
User Guide
===========
H5.user.html
Linked in Chunking.html.
Linked in References.html.
Linked in DDL.html.
Chunking.html
Minor edits.
DDL.html
References.html
New documents.
Datatypes.html
Added "R Reference" to base name description and
"H5T_STD_ROBJ -- Reference to an entire object
in a file" to list of datatype names.
Files.html
H5Fflush
Added scope parameter.
Groups.html
Removed references to "current working group."
Removed H5Gpush, H5Gpop, and H5Gset functions.
Removed note that H5Glink and H5Gunlink were not implemented.
=================
Reference Manual
=================
RM_*.html and Tools.html
Updated Reference Manual internal cross-linking (the link
banner at the top and bottom of each page).
Changed
Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
to read
Returns a non-negative value if successful;
otherwise returns a negative value.
and several derived changes where circumstances differred
only slightly.
Minor copy edits throughout.
RM_H5.html
Corrected H5open "Purpose" statement.
RM_H5A.html
Changed H5Aget_name return type to hssize_t.
RM_H5F.html
H5Fflush
Added scope parameter.
Added H5Freopen.
RM_H5Front.html
Reordered listing of interfaces to alphabetical order (H5,
H5A, H5D, ...)
Added H5I, H5R, and H5RA.
RM_H5G.html
H5Gopen
Edited "Description."
H5Gget_objinfo
Added named datatype to list of valid values for loc_id.
RM_H5I.html Identifier Interface
New section.
RM_H5P.html
Added H5Pset_fill_value and H5Pget_fill_value.
Several minor copy edits.
RM_H5R.html Reference Interface
New section.
H5RA.html
Essentially a new section. It was in the tree previously,
but it did not actually have content.
RM_H5S.html
Changed H5Sget_select_npoints return type to hssize_t.
Tools.html
Updated h5dump documentation.
Revised and extended hyperslab selection image.
Added section "Selecting a union of hyperslabs."
IH_map*.gif (6 new files)
New images for "Intro to HDF5."
As a composite, these replace H5.intro.datamap.gif.
H5.intro.datamap.gif
Removed. Replaced by the composite IH_map*.gif.
RM_H5RA.html (new file)
RM_H5Front.html
Tools.html
Ragged.html
H5.user.html
Changed all H5R functions to H5RA.
Changed Ragged Array API references from H5R to H5RA.
Changed links to RM_H5R.html to RM_H5RA.html.
RM_H5R.html
Removed. Replaced by RM_H5RA.html.
Bill Wendling
Frank Baker
Robert E. McGrath
Patrick Lu
Ruey-Hsia Li