commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mben...@apache.org
Subject svn commit: r802063 - /commons/sandbox/flatfile/trunk/src/site/xdoc/userguide.xml
Date Fri, 07 Aug 2009 16:06:55 GMT
Author: mbenson
Date: Fri Aug  7 16:06:55 2009
New Revision: 802063

URL: http://svn.apache.org/viewvc?rev=802063&view=rev
Log:
xdoc and preformatting are not pals

Modified:
    commons/sandbox/flatfile/trunk/src/site/xdoc/userguide.xml

Modified: commons/sandbox/flatfile/trunk/src/site/xdoc/userguide.xml
URL: http://svn.apache.org/viewvc/commons/sandbox/flatfile/trunk/src/site/xdoc/userguide.xml?rev=802063&r1=802062&r2=802063&view=diff
==============================================================================
--- commons/sandbox/flatfile/trunk/src/site/xdoc/userguide.xml (original)
+++ commons/sandbox/flatfile/trunk/src/site/xdoc/userguide.xml Fri Aug  7 16:06:55 2009
@@ -56,12 +56,12 @@
           <tr>
             <td><code>FieldOption</code></td>
             <td>Marker interface for "field" options</td>
-            <td><i>Various and open-ended</i></td>
+            <td><em>Various and open-ended</em></td>
           </tr>
           <tr>
             <td><code>EntityCollection</code></td>
             <td>An <code>Entity</code> that is a collection of child Entities</td>
-            <td><i>implemented via subinterfaces</i></td>
+            <td><em>implemented via subinterfaces</em></td>
           </tr>
           <tr>
             <td><code>IndexedEntityCollection</code></td>
@@ -79,7 +79,7 @@
             <td><code>CloningEntityFactory</code>, <code>CompositeEntityFactory</code>,
<code>ParserEntityFactory</code></td>
           </tr>
         </table>
-        <i>See also <a href="../javadoc/index.html">Flatfile API</a></i>
+        <em>See also <a href="../javadoc/index.html">Flatfile API</a></em>
       </p>
     </section>
 
@@ -88,47 +88,45 @@
         <p>The package provides an EntityFactory implementation that associates Entity
definitions
            with String identifiers, read from a custom DSL which is loosely based on COBOL's
            data definition format.  Here are some definitions in this format:
-          <pre>
-<i>/* Java multi-line comments are supported */</i>
-<i>// Java single-line comments are supported</i>
-
-<i>// type <b>foo</b>, length 1:</i>
-foo (1), <i>//the comma is optional</i>
+        <pre>
+<em>/* Java multi-line comments are supported */</em><br />
+<em>// Java single-line comments are supported</em><br />
+<em>// type <strong>foo</strong>, length 1:</em>
+foo (1), <em>//the comma is optional</em><br />
 
-<i>// type <b>bar</b>, length 3, default value "bar":</i>
+<em>// type <strong>bar</strong>, length 3, default value "bar":</em>
 bar (3) "bar"
 
-<i>// type <b>baz</b>, default value "baz", length (3) implicit:</i>
+<em>// type <strong>baz</strong>, default value "baz", length (3) implicit:</em>
 baz "baz"
 
-<i>// type <b>blah</b>, immutable value "blah", length (4) implicit:</i>
+<em>// type <strong>blah</strong>, immutable value "blah", length (4) implicit:</em>
 blah "blah"!
 
-<i>// type <b>simpleArray</b>, 3 occurrences of 2 bytes each:</i>
+<em>// type <strong>simpleArray</strong>, 3 occurrences of 2 bytes each:</em>
 simpleArray (2) [3]
 
-<i>// complex type <b>dateYYYYMMDD</b>:</i>
+<em>// complex type <strong>dateYYYYMMDD</strong>:</em>
 dateYYYYMMDD {
   year (4)
   month (2)
   day (2)
 }
 
-<i>// complex type <b>dateRange</b> with type references:</i>
+<em>// complex type <strong>dateRange</strong> with type references:</em>
 dateRange {
   start $dateYYYYMMDD
-  ? '-'!<i>// anonymous (filler) child with immutable value and implicit length (1)</i>
+  ? '-'!<em>// anonymous (filler) child with immutable value and implicit length (1)</em>
   end $dateYYYYMMDD
 }
 
-<i>// type <b>complexArray</b>, 3 occurrences of a named entity collection:</i>
+<em>// type <strong>complexArray</strong>, 3 occurrences of a named entity
collection:</em>
 complexArray {
   a (1)
   b (2)
   c (3)
 } [3]
-
-</pre>
+        </pre>
         </p>
       </subsection>
 
@@ -164,10 +162,10 @@
 
           Example:
           <pre>
-  <i>//define an integer field:</i>
+  <em>//define an integer field:</em>
   intField (9) pad='0' justify=RIGHT
 
-  <i>//define a field for which overflow is permitted:</i>
+  <em>//define a field for which overflow is permitted:</em>
   truncateMe (20) overflow=IGNORE
 </pre>
 
@@ -232,10 +230,10 @@
           intermingled with fields of predetermined length or value. Here is an example:
           <pre>
   structure {
-    "foo="! fooValue (*) <i>// any length</i>
-    "bar="! barValue (1..) <i>// at least length 1</i>
-    "baz="! bazValue (..10) <i>// at most length 10</i>
-    "blah="! blahValue (3..4) <i>// 3 or 4</i>
+    "foo="! fooValue (*) <em>// any length</em>
+    "bar="! barValue (1..) <em>// at least length 1</em>
+    "baz="! bazValue (..10) <em>// at most length 10</em>
+    "blah="! blahValue (3..4) <em>// 3 or 4</em>
   } delim="\r\n"
 </pre>
           Dynamically-sizable fields, or <code>DynamicField</code>s, support
the following options:
@@ -293,7 +291,7 @@
           You can use these constants, prefaced by an "at" (<code>@</code>) symbol
to set default
           options for any type supported, at the top of the resource:
           <pre>
-@field justify=CENTER pad=' '; <i>// semicolon indicates end</i>
+@field justify=CENTER pad=' '; <em>// semicolon indicates end</em>
 @dynamicField underflow=IGNORE
 </pre>
         </p>
@@ -341,7 +339,7 @@
         graphs and POJO graphs. By inserting <code>Entity</code>-aware <code>Reflector</code>s
and
         <code>Transformer</code>s at opportune points in a Morph configuration,
it is possible to
         achieve a surprising amount of basic functionality. More complex things can be accomplished
-        by extending the APIs. <i>We need to provide examples!</i>
+        by extending the APIs. <em>We need to provide examples!</em>
       </p>
     </section>
   </body>



Mime
View raw message