[svn-r5742]

Purpose:
    Update variable-length datatype info.
Description:
    Added "Bit Field for Variable-length Types (Class 9)" table.
    Added "Properties for Variable-length Types (Class 9)" table.
    Fixed a few minor typos.
Platforms tested:
    IE 5

1 files changed, 118 insertions, 7 deletions

diff --git a/doc/html/H5.format.html b/doc/html/H5.format.html
index 518b91a..8553452 100644
--- a/doc/html/H5.format.html
+++ b/doc/html/H5.format.html
@@ -2543,7 +2543,7 @@ Elena>               "Free-space object"
     <center>
       <table border cellpadding=4 width="80%">
 	<caption align=top>
-	  <b>Bit Field for Bitfield types (Class 4)</b>
+	  <b>Bit Field for Bitfield Types (Class 4)</b>
 	</caption>
 
 	<tr align=center>
@@ -2576,7 +2576,7 @@ Elena>               "Free-space object"
     <center>
       <table border cellpadding=4 width="80%">
 	<caption align=top>
-	  <b>Properties for Bitfield types (Class 4)</b>
+	  <b>Properties for Bitfield Types (Class 4)</b>
 	</caption>
 
 	<tr align=center>
@@ -2597,7 +2597,7 @@ Elena>               "Free-space object"
     <center>
       <table border cellpadding=4 width="80%">
 	<caption align=top>
-	  <b>Bit Field for Opaque types (Class 5)</b>
+	  <b>Bit Field for Opaque Types (Class 5)</b>
 	</caption>
 
 	<tr align=center>
@@ -2616,7 +2616,7 @@ Elena>               "Free-space object"
     <center>
       <table border cellpadding=4 width="80%">
 	<caption align=top>
-	  <b>Properties for Opaque types (Class 5)</b>
+	  <b>Properties for Opaque Types (Class 5)</b>
 	</caption>
 
 	<tr align=center>
@@ -2729,7 +2729,7 @@ Elena>               "Free-space object"
     <center>
       <table border cellpadding=4 width="80%">
 	<caption align=top>
-	  <b>Bit Field for Enumeration types (Class 8)</b>
+	  <b>Bit Field for Enumeration Types (Class 8)</b>
 	</caption>
 
 	<tr align=center>
@@ -2754,7 +2754,7 @@ Elena>               "Free-space object"
     <center>
       <table border cellpadding=4 width="80%">
 	<caption align=top>
-	  <b>Properties for Enumeration types (Class 8)</b>
+	  <b>Properties for Enumeration Types (Class 8)</b>
 	</caption>
 
 	<tr align=center>
@@ -2800,6 +2800,117 @@ Elena>               "Free-space object"
       </table>
     </center>
 
+
+   <p>
+    <center>
+      <table border cellpadding=4 width="80%">
+	<caption align=top>
+	  <b>Bit Field for Variable-length Types (Class 9)</b>
+	</caption>
+
+	<tr align=center>
+	  <th width="10%">Bits</th>
+	  <th width="90%">Meaning</th>
+	</tr>
+
+	<tr valign=top>
+	  <td>0-3</td>
+	  <td><dl><dt><b>Type</b></dt>
+	    <dt>0 Variable-length sequence</dt>
+              <dd>This variable-length datatype can be of any sequence 
+              of data.  Variable-length sequences do not have padding 
+              or character set information.</dd>
+            <dt>1 Variable-length string</dt>
+              <dd>This variable-length datatype is composed of a series of 
+              characters.  Variable-length strings have padding and 
+              character set information.</dd></dl>
+          </td>
+	</tr>
+
+	<tr valign=top>
+	  <td>4-7</td>
+	  <td><dl><dt><b>Padding type</b> (variable-length string only)</dt>
+              <dd>This four-bit value determines the type of padding 
+              used for variable-length strings.  The values are the same 
+              as for the string padding type, as follows:</dd>
+	    <dt>0 Null terminate</dt>
+              <dd>A zero byte marks the end of a string and is guaranteed 
+              to be present after converting a long string to a short 
+              string.  When converting a short string to a long string, 
+              the value is padded with additional null characters 
+              as necessary.
+            <dt>1 Null pad</dt>
+              <dd>Null characters are added to the end of the value 
+              during conversion from a short string to a longer string.  
+              Conversion from a long string to a shorter string 
+              simply truncates the value.</dd>
+            <dt>2 Space pad</dt>
+              <dd>Space characters are added to the end of the value 
+              during conversion from a short string to a longer string.
+              Conversion from a long string to a shorter string simply 
+              truncates the value.
+              This is the Fortran representation of the string.
+              </dd>
+            <dt>3-15 Reserved</dt>
+              <dd>These values are reserved for future use.</dd></dl>
+          </td>
+	</tr>
+
+	<tr valign=top>
+	  <td>8-11</td>
+	  <td><dl><dt><b>Character set</b> (variable-length string only)</dt>
+              <dd>This four-bit value specifies the character set 
+              to be used for encoding the string.</dd>
+	    <dt>0 8-bit ASCII</dt>
+              <dd>As of this writing (June 2002, Release 1.4.4), 
+              8-bit ASCII is the only character set supported.
+              Therefore, no translations have been defined.</dd></dl>
+          </td>
+	</tr>
+
+	<tr valign=top>
+	  <td>12-23</td>
+	  <td>Reserved (zero).</td>
+	</tr>
+      </table>
+    </center>
+
+    <p>
+    <center>
+      <table border cellpadding=4 width="80%">
+        <caption align=top>
+          <b>Properties for Variable-length Types (Class 9)</b>
+        </caption>
+
+        <tr align=center>
+          <th width="25%">Byte</th>
+          <th width="25%">Byte</th>
+          <th width="25%">Byte</th>
+          <th width="25%">Byte</th>
+        </tr>
+
+        <tr align=center>
+          <td colspan=4><br>Parent Type<br><br></td>
+        </tr>
+
+      </table>
+    </center>
+
+    <center>
+      <table border=0 cellpadding=4 width="80%">
+        <tr align=left valign=top>
+          <td valign=top width=20%>Parent Type:</td>
+          <td valign=top>Each variable-length type is based on 
+            some parent type.  The information for that parent type is 
+            described recursively by this field.</td>
+        </tr>
+      </table>
+    </center>
+
+
+
+   <p>
+
 <!--
     <p>Datatype examples are <a href="Datatypes.html">here</a>.
 -->
@@ -3965,7 +4076,7 @@ in the structure, with each item formatted according to its datatype.
 -->
 <address><a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a></address>
 <!-- hhmts start -->
-Last modified: 25 April 2002
+Last modified: 1 July 2002
 <!-- hhmts end -->
 
 <br>