Commit Graph

21 Commits

Author SHA1 Message Date
Frank Baker
a901d24a8b [svn-r7158]
Purpose:
    Renamed old "HDF5 User's Guide" as "HDF5 User's Guide, Release 1.4.5".
    Added navigation bar link to new user's guide on HDF server.
    Changed release tag line (in old UG only) back to
        "Describes HDF5 Release 1.4.5, February 200 3"

Platforms tested:
    IE 5
2003-07-03 14:35:53 -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
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
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
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
447c7e4d37 [svn-r3802]
Purpose:
    Importing UG changes from 1.4 release branch into development branch (1.5)
2001-04-11 17:30:56 -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
31f539a564 [svn-r3187]
Purpose:
    Removed index links to Palettes.html (removed from doc set) in
    all User Guide files.
Platforms tested:
    IE 5
2000-12-22 08:25:43 -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
b026b7b063 [svn-r3102]
Purpose:
    Minor copy edit.
Platforms tested:
    IE 5
2000-12-08 14:44:23 -05:00
Frank Baker
57f2c42858 [svn-r2003] Changed 'boot block' to 'super block'.
Minor formatting fixes.
2000-03-08 17:03:49 -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
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
Robb Matzke
b5e2752ad6 [svn-r673] Changes since 19980908
----------------------

./COPYING
	Reformatted as text instead of C.  Removed zlib crew from the
	list of contributors since no zlib code is actually in the
	hdf5 library.

./INSTALL
./INSTALL.ascired
./MANIFEST
	Minor updates for Beta release including version number
	change.

./INSTALL_MAINT
	Added information about making a release.

./RELEASE
	Updated function list based on public header files.

./bin/checkposix
	Got rid of complaints about some obvious things.

./doc/html/H5.api.html
./doc/html/RM_H5F.html
./src/H5F.c
./src/H5Fpublic.h
./test/tfile.c
	Changed H5Fget_create_template() and H5Fget_access_template()
	to H5Fget_create_plist() and H5Fget_access_plist() since that
	conforms better to lots of other names.

./doc/html/Datatypes.html
./doc/html/ExternalFiles.html
./doc/html/Files.html
./doc/html/H5.api.html
./doc/html/H5.sample_code.html
./doc/html/RM_H5F.html
./doc/html/RM_H5Front.html
	Changed `template' to `property list', etc.

./doc/html/Ragged.html	   [NEW]
	Documentation for ragged arrays.

./src/H5Iprivate.h
./src/H5Ipublic.h
./src/H5I.c
	Changed the scope of some symbols to be more local.

./src/H5.c
./src/H5AC.c
./src/H5D.c
./src/H5E.c
./src/H5F.c
./src/H5Ffamily.c
./src/H5Fistore.c
./src/H5Flow.c
./src/H5Fsec2.c
./src/H5Fsplit.c
./src/H5Fstdio.c
./src/H5G.c
./src/H5Gnode.c
./src/H5HG.c
./src/H5I.c
./src/H5O.c
./src/H5Ocomp.c
./src/H5Odtype.c
./src/H5Oefl.c
./src/H5Omtime.c
./src/H5Oname.c
./src/H5P.c
./src/H5S.c
./src/H5Shyper.c
./src/H5Tbit.c
./src/H5Tconv.c
./src/H5V.c
./src/H5Z.c
./src/H5private.h
	Fixed some violations of our naming scheme by adding HD to the
	beginning of all Posix functions.
1998-09-08 14:15:44 -05:00
Frank Baker
ac784dcef4 [svn-r648] Make subheading numbering consistent and fix error in level 3 header
numbering sequence.

Add internal named link to "File Families" section (for references
from Reference Manual).
1998-09-01 16:18:42 -05:00
Robb Matzke
acd04a1aa6 [svn-r579] Changes since 19980806
----------------------

./config/solaris2.5
	Hopefully set up now so it honors the CC and CFLAGS variables
	and understands solaris cc flags.

./test/big.c
	Checks to see if creating lots of large sparse files exceeds
	the user disk quota and skips the test.  It also checks that
	we can actually open ~64 files at once.

./doc/html/Files.html
./src/H5A.c
./src/H5Aprivate.h
./src/H5F.c
./src/H5Fpublic.h
	Added the H5Fflush() function which takes any object as an
	argument as long as the object is in some way associated with
	a file.  This required an H5A_entof()

./src/H5.c
./src/H5Flow.c
	The `%a' format of HDfprintf() now allows a field width and
	justification flag etc, like the other formats.  The old
	H5F_addr_print() was recoded to call HDfprintf() instead of
	vice versa.
1998-08-06 16:32:33 -05:00
Quincey Koziol
bd1e676c52 [svn-r467] Restructuring documentation. 1998-07-08 09:54:54 -05:00