Purpose:
Description:
index.html: Added link to PDF version of RM, to be posted approximately
one week post-release
RM_H5Front.html: Added note describing Fortran API integration into main RM
Added link to PDF version of RM, to be posted approximately one week
post-release
RM_H5?.html and RM_H5.html (except RM_H5P.html):
Removed notes that Fortran APIs are described in a separate window
RM_H5P.html: Added note that Fortran API integration is complete
throughout RM except in H5P
Solution:
Platforms tested:
Misc. update:
Purpose:
Modifications to enable automatically generating a PDF version of the
HDF5 Reference Manual with HTMLdoc.
Description:
The HTML coding has been revised to provide necessary formatting and
control guidance for HTMLdoc. In the process, of course, the need for
an occasional formatting or copy-edit correction was discovered.
Platforms tested:
HTMLdoc, IE 5, Safari
Purpose:
Changed "HDF5 User's Guide" links (in navigation bars, primarily)
to point to new user's guide, which will reside for a while yet on
the HDF server.
The old user's guide will still go out with the distribution under
the label "HDF5 User's Guide, Release 1.4.5."
Platforms tested:
IE 5
Purpose:
Add short copyright notice.
Update release tag line.
Description:
Added short copyright notice as comment in source files;
does not display in browser.
Updated release tag line in footers to read as follows:
Describes HDF5 Release 1.6.0, July 2003
Platforms tested:
IE 5
Purpose:
Complete "compression" to "filters" revisions.
H5Zregister review feedback.
Description:
Intro -- Finish the "Compression" ==> "Filters" changes.
H5Zregister -- Clarify that the can_apply_func and set_local_func
can be set to null.
-- Define value of filter_id
-- Other smaller revisions.
(all based on review feedback)
Platforms tested:
IE 5, Safari
Purpose:
To facilitate finding functions, particularly in long Reference Manual
sections.
Solution:
Added alphabetized function listings. (NOTE: Aside from the H5I and H5Z
sections, this is not necessarily the final implementation; there will
likely be another revision in the presentation of this listing before it
is released.)
Platforms tested:
Safari, IE 5
Purpose:
Update H5Zregister to describe new approach to filter management.
Description:
H5Zregister -- heavy revisions to reflect new filter-handling approach.
Added H5Z_class_t struct,
H5Z_can_apply_func_t callback function, and
H5Z_set_local_func_t callback function,
and rewrote much of the rest.
Platforms tested:
IE 5, Safari
Purpose:
Link in additional Fortran90 functions.
Description:
Linked 68 new Fortran90 functions to the discussions of the corresponding
C functions. Made the corresponding Fortran index changes in the
function listings at the tops of the RM pages.
Fixed formatting and link typos in RM_H5P.html & fortran/h5p_FORTRAN.html.
Platforms tested:
Safari and IE 5
Purpose:
New filter functionality
Rename section to reflect filters rather than strictly compression
Description:
"Compression Interface" --> "Filter and Compression Interface"
Renamed section as "Filter and Compression Interface".
Extended introductory paragraphs to BRIEFLY describe filter pipeline.
Edit H5Zregister to speak from point of view of filters rather than
compression only.
Add H5Zunregister.
Add H5Zfilter_avail.
Platforms tested:
Safari, IE 5
Purpose:
DreamWeaver (DW) adaptation of the HDF5 doc set, introducing the use of
stylesheets and DW libraries.
Stylesheets -- for consistent format management.
DW libraries -- for managing common elements across documents.
Platforms tested:
IE 5 and 6
Netscape
Purpose:
To bring the H5Z_func_t definition from the old User's Guide
into the Reference Manual.
Description:
Added custom filter function H5Z_func_t definition to the
H5Zregister function description.
This definition will next be edited to bring it up-to-date.
Platforms tested:
IE 5
Purpose:
Bugfix
Description:
Corrected H5Zregister description, syntax, and parameter descriptions.
There is one 'function' parameter, rather than the separate
'compression-function' and 'uncompression-function' parameters that
were previously listed.
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
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.
