Commit Graph

28 Commits

Author SHA1 Message Date
Frank Baker
5adc5f7a5e [svn-r7655]
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:
2003-10-16 17:13:35 -05:00
Frank Baker
70a72e25b4 [svn-r7651]
Purpose:
    Expand H5open/h5open_f and H5close/h5close_f descriptions
    to indicate that these two calls are mandatory in Fortran90
    applications (though optional in C).

Platforms tested:
    Safari, IE 5
2003-10-16 14:43:38 -05:00
Frank Baker
db240fe802 [svn-r7636]
Purpose:
    Update release tagline to read:
        Describes HDF5 Release 1.6.1, October 2003

Platforms tested:
    Safari, IE 5
2003-10-15 13:15:21 -05:00
Frank Baker
77da80dd1b [svn-r7596]
Purpose:
    Integrate Fortran90 interfaces into C RM.

Solution:
    Remove "Non-C APIs" sections.
    Add "Fortran90 Interface" sections with F90 descriptions.

Platforms tested:
    IE 5, Safari
2003-10-10 10:30:13 -05:00
Frank Baker
478ed94629 [svn-r7536]
Purpose:
    Alphabetized RM function entries

Platforms tested:
    Safari, IE 5
2003-10-03 15:07:00 -05:00
Frank Baker
2d7eaf4363 [svn-r7485]
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
2003-09-16 15:37:33 -05:00
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
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
19d5d5f2d3 [svn-r7086]
Purpose:
    H5set_free_list_limits review feedback.
    Link corresponding F90 function.

Description:
    Added explanations of regular, array, and block free lists.
    Copy edits.         (both in response to review comments)
    Linked in corresponding F90 function.

Platforms tested:
    IE 5, Safari
2003-06-23 15:35:51 -05:00
Frank Baker
ca33a5498c [svn-r7014]
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
2003-06-10 10:38:46 -05:00
Frank Baker
e68390cdc5 [svn-r6704]
Purpose:
    Add new function.

Description:
    Added H5set_free_list_limits.

Platforms tested:
    Safari, IE 5
2003-04-17 16:02:41 -05:00
Frank Baker
4c6122a53c [svn-r6600]
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
2003-04-08 16:33:50 -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
Frank Baker
bdce101e9f [svn-r4300] Purpose:
Bringing 'last minute' release branch edits into development branch.
Description:
    Updated H5check_version per recent expansion of the source comments.
Platforms tested:
    IE 5
2001-08-02 10:59:10 -05:00
Frank Baker
ad81c8163e [svn-r3823]
Purpose:
    Update "Describes HDF5 Release..." footer from R1.4 to
    "Release 1.5, Unreleased Development Branch"
Platforms tested:
    IE 5
2001-04-18 17:03:09 -05:00
Frank Baker
8dd2c0ad9e [svn-r3822]
Purpose:
    Update "Describes HDF5 Release..." footer from R1.4 to
    "Release 1.5, Unreleased Development Branch"
Platforms tested:
    IE 5
2001-04-18 16:50:43 -05:00
Frank Baker
365b06f606 [svn-r3803]
Purpose:
    Importing RM changes from 1.4 release branch into development branch (1.5)
2001-04-11 17:45:26 -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
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
Frank Baker
0012ab9639 [svn-r2430] RM_H5.html
Added new function H5garbage_collect.
2000-07-17 12:54:48 -05:00
Frank Baker
f17e2d273e [svn-r1885] RM_H5.html H5check_version: Grammar correction.
RM_H5A.html   H5Acreate: Restructured and expanded the Description section,
 	      with particular attention to the fact that the attribute name
	      specified in H5Acreate must be unique.
1999-12-17 10:33:08 -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
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
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
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
Frank Baker
c8e75d27b0 [svn-r503] HDF5 Reference Manual
Updated for Alpha2.
1998-07-14 23:51:50 -05:00