Commit Graph

48 Commits

Author SHA1 Message Date
Frank Baker
4146d79af1 [svn-r7159]
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
2003-07-03 14:40:03 -05:00
Frank Baker
63d9172378 [svn-r7143]
Purpose:
    To segregate HDF4/HDF5 conversion tools and add link to H4toH5 Library

Description:
    Restructured indexing at the top of the page into these sections:
        User utilities
        Configuration and library management utilities
        Java-based tools
        HDF5/HDF4 conversion tools
            Added link to http://hdf.ncsa.uiuc.edu/h4toh5/

Platforms tested:
    IE 5
2003-07-02 21:49:49 -05:00
Frank Baker
1091cab2e6 [svn-r7140]
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
2003-07-02 16:28:11 -05:00
Frank Baker
2edd657fa0 [svn-r7076]
Purpose:
    Add new tools:
        h5diff
        h5perf
        h5redeploy
        h5c++
    Corrections to h5import

Description:
    h5diff, h5perf, h5redeploy, h5c++ -- Added these tools.
    h5import -- Corrected the description of the naming convention for
        output datasets.  Other edits based on review comments.
    Copy edits and source code formatting.

Platforms tested:
    IE 5, Safari
2003-06-20 16:53:38 -05:00
Frank Baker
e6b24e1995 [svn-r6927]
Purpose: New tool -- h5import

Description:
    Added h5import.

Platforms tested:
    Safari and IE 5
2003-05-30 10:43:25 -05:00
Frank Baker
60cdbb8288 [svn-r6813]
Purpose:
    Correction of a misleading comment.

Description:
    h5cc & h5fc
        Corrected the same spot in each "Description" where the text,
        literally interpreted, implied that HDF5 could be used as a compiler.

Platforms tested:
    IE 5, Safari
2003-05-06 17:01:56 -05:00
Frank Baker
2bd7a9c819 [svn-r6812]
Purpose:
    New feature -- h5fc

Description:
    Added h5fc entry.
    Took the opportunity to make some relatively minor copy edits and
        grammatical corrections in h5cc entry.

Platforms tested:
    Safari, IE 5
2003-05-06 16:54:54 -05:00
Bill Wendling
4aad34af3e [svn-r6786] Purpose:
Update

Description:
    Updated with description of new h5dumper --string feature.

Platforms tested:
    Mozilla

Misc. update:
2003-04-30 17:43:51 -05:00
Frank Baker
d586a1adb9 [svn-r6478]
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
2003-03-14 14:12:34 -05:00
Albert Cheng
a6b33e6dd7 [svn-r5999] Purpose:
Added an example for the -- option.
Platforms tested:
    Checked with IE browser.
2002-10-14 23:20:51 -05:00
Bill Wendling
92a93ff52f [svn-r4749]
Purpose:
	Feature Description
Description:
	Added the description of the --filedriver option to the h5dump
	explanation section.
Platforms tested:
	w3m
2001-12-21 15:02:15 -05:00
Bill Wendling
16d12b1471 [svn-r4438]
Purpose:
    Feature Add
Description:
    Added description of the H5CC script.
Platforms tested:
    Mozilla
2001-09-13 12:11:31 -05:00
Bill Wendling
d5421b4953 [svn-r4313]
Purpose:
    Feature Add
Description:
    Added description for the --filedriver flag to the h5dump
    description.
2001-08-06 12:23:20 -05:00
Frank Baker
35819c2142 [svn-r4302] Purpose:
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
2001-08-02 11:02:41 -05:00
Frank Baker
1af1fe8d8a [svn-r4123]
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
2001-07-05 21:10:40 -05:00
Frank Baker
b44a58dc42 [svn-r3824]
Purpose:
    Update "Describes HDF5 Release..." footer from R1.4 to
    "Release 1.5, Unreleased Development Branch"
Platforms tested:
    IE 5
2001-04-18 17:09:17 -05:00
Frank Baker
9fbb176d29 [svn-r3821]
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
2001-04-18 12:03:21 -05:00
Bill Wendling
112c684fa5 [svn-r3806] Purpose:
Update
Description:
    Wrote description of the subsetting feature that the h5dumper has.
Platforms tested:
    w3m
2001-04-12 17:20:46 -05:00
Robert E. McGrath
d12fa9b5c5 [svn-r3408] Purpose:
Adding new feature.
Description:
  XML output option to h5dump
Platforms tested:
  SPARC Solaris 2.7, Irix6.5 (32bit), Linux, Win98
2001-02-14 15:48:22 -05:00
Frank Baker
fd05f98e9e [svn-r3387]
Purpose:
    Marking files for "Release 1.4, February 2001."
Description:
    Across doc files
        Updating "Describes HDF5 Release..." entry to "Describes
        HDF5 Release 1.4, February 2001."
    Copyright.html:  Added 2001 to years copyrighted.
    index.html:  Changed header to Release 1.4 (from 1.4 Beta)
Platforms tested:
    IE 5
2001-02-09 13:02:16 -05:00
Frank Baker
cefabf3224 [svn-r3311]
Purpose, Description, and Solution:
    Removed cross-links to Ragged Array doc files (above).
Platforms tested:
    IE 5
2001-01-19 16:51:53 -05:00
Bill Wendling
e108a974a0 [svn-r3301] Purpose:
Bugfix
Description:
    The documentation wasn't correct via the commandline switches for
    some of the h5dump options.
Platforms tested:
    Lynx
2001-01-18 16:31:38 -05:00
Bill Wendling
6db26d370a [svn-r3299] Purpose:
Bug Fix
Description:
    Some <em> tags weren't properly closed.
Solution:
    Changed what was to be the closeing <em> tag to </em>
Platforms tested:
    w3m
2001-01-18 16:09:44 -05:00
Bill Wendling
fbf2fd987f [svn-r3247] Purpose:
h5dump attribute documentation.
Description:
    Described the new flags for the H5 dumper.
Platforms tested:
    Lynx
2001-01-09 15:02:16 -05:00
Frank Baker
af308b715a [svn-r3176]
Purpose:
    Added h4toh5
Platforms tested:
    IE 5
2000-12-21 14:41:30 -05:00
Frank Baker
7fa2bc6700 [svn-r3117]
Purpose:
    Linking the new "Predefined Dataypes" document into the RM.
Description:
    Added PredefDTypes.html link into all RM files.
Platforms tested:
    IE 5
2000-12-12 17:43:02 -05:00
Frank Baker
243c60e8b5 [svn-r3105]
Purpose:
	Thoughout doc set (UG, RM, Intro, FormatSpec, and index/TOC pages):
	    Added/updated "Describes HDF5 Release ..." entry.
	    In many cases, verified/updated "Last modified ..." entry.
Platforms tested:
	IE 5
2000-12-08 17:12:36 -05:00
Bill Wendling
d3fb3fe742 [svn-r2968] Purpose:
Update
Description:
	Updated the description of h5ls flags.
Platforms tested:
	w3m
2000-11-17 13:21:13 -05:00
Frank Baker
bf2685ae4d [svn-r2959] Purpose:
Minor copy-edits and formatting.
Platforms tested:
    IE 5
2000-11-16 17:28:02 -05:00
Bill Wendling
12bddf5589 [svn-r2957] Purpose:
Feature Addition
Description:
	Described the new variable length dumping that the h5dumper does
	in the documentation.
Platforms tested:
	w3m
2000-11-16 16:47:32 -05:00
Bill Wendling
4f5328967e [svn-r2655] Purpose:
Small bug fix (see bug report 528)
Description:
	Added another example us using the h5dumper to dump an attribute
	from the root group.
2000-10-10 12:40:45 -05:00
Bill Wendling
2c7f74e088 [svn-r2642] Purpose:
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.
2000-10-09 14:28:07 -05:00
Patrick Lu
50cd98ffe1 [svn-r2298] removed mention of the xml option 2000-05-30 11:06:18 -05:00
Patrick Lu
0dca4208e4 [svn-r2293] updated the Tools file. added new entries to the dumper section for the new options
(-v = obj id, -w = # of columns, -xml = XML output)
also added opaque to the types that are output
2000-05-26 13:57:09 -05:00
Frank Baker
4d57b9df22 [svn-r2006] RM_H5D.html
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'.
2000-03-08 17:14:46 -05:00
Frank Baker
4ee64d4c71 [svn-r1894] Tools.html h5dump: Added -V option.
Glossary.html     selection: added 2nd definition.
Filters.html      Added reference in section 4 to zlib website.
1999-12-17 10:47:05 -05:00
Frank Baker
658fdbfb98 [svn-r1874] Bringing all changes from R1.2 tree into R1.3 tree.
(except Datatypes.html, H5.format.html, ddl.html)
	This version of HDF5 Ref Manual includes FORTRAN API references.
1999-12-13 15:39:48 -05:00
Patrick Lu
8c11a3a87c [svn-r1378]
added references and enums into the list of datatypes displayed
1999-06-24 14:54:34 -05:00
Frank Baker
a3d84da7df [svn-r1244] Datatypes.html
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.
1999-05-03 16:54:10 -05:00
Ruey-Hsia Li
12d679104c [svn-r1060] Updated the example in ddl.html and supported features in Tools.html. 1999-02-09 13:07:59 -05:00
Frank Baker
ac66b7eae0 [svn-r994] Added h5toh4. 1998-12-28 10:15:16 -05:00
Ruey-Hsia Li
be41a8feed [svn-r986] Defined <data> and <string> in ddl.html.
Updated the current status of dumper.
1998-12-21 17:54:16 -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
04001aa89b [svn-r837] Changed links to DDL.html to read ddl.html. 1998-10-29 20:30:57 -05:00
Frank Baker
cd3b105997 [svn-r830] ======
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.
1998-10-29 17:13:17 -05:00
Frank Baker
ca9639706e [svn-r769] H5.intro.html
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.
1998-10-20 22:33:19 -05:00
Frank Baker
57d3af6e2d [svn-r694] Copying developer's changes to doc/html/ version from doc/src/:
Revised the description of h5dump.
	Changed argument 'files' to 'file'.
	Added ../html/ to the DDL hyperlink.
1998-09-11 13:40:14 -05:00
Frank Baker
3672cb4c1c [svn-r693] Update for beta release. Complete CVS log messages can be found with
the versions of these files that are maintained in hdf5/doc/src/.
1998-09-11 11:00:43 -05:00