Commit Graph

9 Commits

Author SHA1 Message Date
Frank Baker
8e8550af43 [svn-r2356] Navigational cross-linking fixes within the distributed HDF5 doc set
and from index.html to the HDF5 website.
2000-06-07 11:36:06 -05:00
Frank Baker
51d2cdb1d0 [svn-r2338] Updating structural cross-links within doc set. 2000-06-05 10:44:34 -05:00
Frank Baker
14a07c3f3e [svn-r2092] Datasets.html
Removed H5Pset_compression (commented it out, actually) and
	changed example which used it to use H5Pset_deflate.
H5.format.html
	Fixed centered paragraph formatting error and moved first two
	figures to right margin.
FF-IH_FileGroup.gif  ('File-Group' image for Format Spec)
	Changed 'Boot Block' to 'Super Block'.
2000-04-07 14:45:08 -05:00
Frank Baker
044a84e972 [svn-r1775] HDF5 User's Guide files
Added Performance.html to TOC lists.
 	Made "data type" and "datatype" consistently one word.
1999-10-17 15:41:58 -05:00
Frank Baker
229cac82de [svn-r1528]
All HDF5 User's Guide files
	Integrated Palettes.html.
	Integrated MountingFiles.html.
	Cleaned up page footers.
	Made <title>---</title> entries somewhat more consistent.

Files.html
Errors.html
Datasets.html
	Fixed minor formatting errors.

Palettes.html
MountingFiles.html
	These new sections were added to the HDF5 User's Guide.

Environment.html
	Deleted duplicate text.
1999-07-22 15:58:29 -05:00
Frank Baker
2f3da042cf [svn-r1524]
RM_H5R.html
   H5Rget_region
	Removed "Not yet implemented" note.
	Corrected syntax to agree with description in H5R.c
	Added mention of valid 'ref_type' value; deleted reference to User's Guide.
   H5Rdereference
	Added list of valid 'ref_type' values; deleted reference to User's Guide.

RM_H5T.html
   H5Tget_class
	Added H5T_ENUM and H5T_REFERENCE to list of return values.
   H5Topen
	Corrected description of 'loc_id'; clarified description of 'name'.
   H5Tinsert
	Corrected 'offset' datatype.

RM_H5P.html
Datasets.html
   Fixed minor formatting errors.
   H5Pset_layout
   H5Pget_layout
	Added comment that H5D_COMPACT layout type is not yet implemented.
   H5Pset_external
	Added note regarding setting 'size' to H5F_UNLIMITED.
   H5Pset_family                                           (RM_H5P.html only)
	Removed extra function entry ('original version').
   H5Pget_split                                            (RM_H5P.html only)
	Corrected pair of typos in 'meta_ext' description.
1999-07-21 15:46:42 -05:00
Frank Baker
82fb21b613 [svn-r985] Checking in changes from "HDF5 Release 1.0" CVS branch that have not yet
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.
1998-12-21 17:52:56 -05:00
Frank Baker
dd99ecc1bc [svn-r680] H5.user.html
A little editorial cleanup.
   Added link to Ragged.html, Ragged Arrays.
   Added link to Environment.html, Environmental Variables and
	Configuration Parameters.
   Added link to Copyright.html.

Ragged.html
   Added "Use at your own risk" notice.

Environment.html
   New file for environmental variables and configuration parameters.

Datatypes.html
   Added the following datatypes:
	H5T_NATIVE_HSIZE
	H5T_NATIVE_HSSIZE
	H5T_NATIVE_HERR
	H5T_NATIVE_HBOOL
   Section 8, "Data Conversions"
	Added named link tag to catch hyperlink from RM.
	Revised "Note:" to emphasize limited inate data-conversion capability.

Copyright.html
   New file.
   Copyright statement, linked into User's Guide and Reference Manual.

Glossary.html
   Unlinked for Beta.

General
   Changed email link at bottom of "user guide level documents"
	(as contrasted with "developer guide level documents"
	listed on the lower half of the User's Guide front page)
	to HDF Help Desk, hdfhelp@ncsa.uiuc.edu.
   Changed the following function names:
	From:                       To:
	H5version                   H5get_libversion
	H5vers_check                H5check_version
	H5Anum_attrs                H5Aget_num_attrs
	H5Fget_create_template()    H5Fget_create_plist()
	H5Fget_access_template()    H5Fget_access_plist()
	H5Gstat                     H5Gget_stat
	H5Sextent_npoints           H5Sget_simple_extent_npoints
	H5Sextent_ndims             H5Sget_simple_extent_ndims
	H5Sextent_dims              H5Sget_simple_extent_dims
	H5Sget_class                H5Sget_simple_extent_type
	H5Sselect_npoints           H5Sget_select_npoints
1998-09-09 17:48:37 -05:00
Quincey Koziol
bd1e676c52 [svn-r467] Restructuring documentation. 1998-07-08 09:54:54 -05:00