maven-doxia-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ltheu...@apache.org
Subject svn commit: r596129 - in /maven/doxia/site/src/site: apt/references/apt-format.apt apt/references/doxia-apt.apt site.xml
Date Sun, 18 Nov 2007 20:57:17 GMT
Author: ltheussl
Date: Sun Nov 18 12:57:13 2007
New Revision: 596129

URL: http://svn.apache.org/viewvc?rev=596129&view=rev
Log:
Add a page about Doxia-specific APT features

Added:
    maven/doxia/site/src/site/apt/references/doxia-apt.apt   (with props)
Modified:
    maven/doxia/site/src/site/apt/references/apt-format.apt
    maven/doxia/site/src/site/site.xml

Modified: maven/doxia/site/src/site/apt/references/apt-format.apt
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/references/apt-format.apt?rev=596129&r1=596128&r2=596129&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/apt-format.apt (original)
+++ maven/doxia/site/src/site/apt/references/apt-format.apt Sun Nov 18 12:57:13 2007
@@ -7,17 +7,25 @@
 The APT format
 ~~~~~~~~~~~~~~
 
-  APT stands for "Almost Plain Text". APT is a format that takes the hassle out
-  of writing documentation by striving for simplicity.  APT syntax resembles
-  plain-text more than it resembles markup languages such as HTML, and the
-  following document contains some examples of available APT formatting.
+  APT stands for "Almost Plain Text". APT is a markup language that takes the
+  hassle out of documentation writing by striving for simplicity. Its syntax
+  resembles plain-text more than it resembles most other markup formats
+  (such as HTML).
+
+  This document provides some examples of available APT formatting.
+
+  <<Note:>> The information contained in this document corresponds to the original
+          {{{http://www.xmlmind.com/_aptconvert/docs/userguidetoc.html}APT}}
+          format as published by {{{http://www.xmlmind.com/}Xmlmind}}.
+          Maven Doxia has applied several modifications to this original
+          format, see this separate {{{./doxia-apt.html}document}}
+          for a detailed description.
+
   The following sections contain formatted text that demonstrates the use
   of APT to create paragraphs, headers, sections, lists, code samples,
   figures, tables, rules, breaks, and text level elements such as font styles,
   anchors, and special characters.
-
-  In the following sections, boxes containing text in typewriter-like font are
-  examples of APT source.
+  Boxes containing text in typewriter-like font are examples of APT source.
 
 * Document structure
 ~~~~~~~~~~~~~~~~~~~~
@@ -171,11 +179,11 @@
 
       * List item 2.
 
-	Paragraph contained in list item 2.
+        Paragraph contained in list item 2.
 
-	    * Sub-list item 1.
+            * Sub-list item 1.
 
-	    * Sub-list item 2.
+            * Sub-list item 2.
 
       * List item 3.
 +---------------------------------------+
@@ -272,9 +280,9 @@
 +----------------------------------------+
 ----------------------------------------
 Verbatim 
-	 text,
-		preformatted,
-				escaped.
+         text,
+                preformatted,
+                                escaped.
 ----------------------------------------
 +----------------------------------------+
 
@@ -528,11 +536,11 @@
 
       * List item 2.
 
-	Paragraph contained in list item 2.
+        Paragraph contained in list item 2.
 
-	    * Sub-list item 1.
+            * Sub-list item 1.
 
-	    * Sub-list item 2.
+            * Sub-list item 2.
 
       * List item 3.
         Force end of list:
@@ -559,7 +567,7 @@
 
 +-------------------------------+
 Verbatim text
-			in a box
+                        in a box
 +-------------------------------+
 
   --- instead of +-- suppresses the box around verbatim text.

Added: maven/doxia/site/src/site/apt/references/doxia-apt.apt
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/references/doxia-apt.apt?rev=596129&view=auto
==============================================================================
--- maven/doxia/site/src/site/apt/references/doxia-apt.apt (added)
+++ maven/doxia/site/src/site/apt/references/doxia-apt.apt Sun Nov 18 12:57:13 2007
@@ -0,0 +1,61 @@
+ -----
+ Doxia APT Enhancements
+ -----
+ Lukas Theussl
+ -----
+
+Enhancements to the APT format
+~~~~~~~~~~~~~~
+
+  In the following we provide a list of differences/enhancements to the
+  original {{{./apt-format.html}APT}} format that were incorporated in
+  Doxia. Apart from some exceptions, these differences are usually
+  'backwards-compatible', i.e. any document that gets correctly processed
+  by {{{http://www.xmlmind.com/aptconvert.html}Aptconvert}} should also
+  be a valid Doxia input file and lead to identical results when processed
+  by a Doxia parser.
+
+* Paragraphs in list items
+~~~~~~~~~~~~~~~~~~~~
+
+  Contrary to the original APT parser, the Doxia APT parser does not
+  put list items within paragraphs. Eg, the example given in the APT guide:
+
++---------------------------------------------------------------------------+
+    * List item 1.
++---------------------------------------------------------------------------+
+
+  will, for instance, produce the following html:
+
++---------------------------------------------------------------------------+
+    <li>List item 1.</li>
++---------------------------------------------------------------------------+
+
+  To get the same result as aptconvert, use
+
++---------------------------------------------------------------------------+
+    *
+
+      List item 1.
++---------------------------------------------------------------------------+
+
+  which will produce:
+
++---------------------------------------------------------------------------+
+    <li><p>List item 1.</p></li>
++---------------------------------------------------------------------------+
+
+
+* Table header cells
+~~~~~~~~~~~~~~~~~~~~
+
+  Header cells are defined by an aditional pipe character '|' at the beginning
+  of the cell:
+
++---------------------------------------------------------------------------+
+    *-----------+-----------+
+    || Header 1 || Header 2 |
+    *-----------+-----------+
+    | Cell 1    | Cell 2    |
+    *-----------+-----------+
++---------------------------------------------------------------------------+

Propchange: maven/doxia/site/src/site/apt/references/doxia-apt.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/doxia/site/src/site/apt/references/doxia-apt.apt
------------------------------------------------------------------------------
    svn:keywords = "Author Date Id Revision"

Modified: maven/doxia/site/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/doxia/site/src/site/site.xml?rev=596129&r1=596128&r2=596129&view=diff
==============================================================================
--- maven/doxia/site/src/site/site.xml (original)
+++ maven/doxia/site/src/site/site.xml Sun Nov 18 12:57:13 2007
@@ -64,7 +64,9 @@
 
     <menu name="Documentation">
       <item name="References" href="references/index.html">
-        <item name="Apt Format" href="references/apt-format.html"/>
+        <item name="Apt Format" href="references/apt-format.html">
+          <item name="Doxia Apt Enhancements" href="references/doxia-apt.html"/>
+        </item>
         <item name="FML Format" href="references/fml-format.html"/>
         <item name="Xdoc Format" href="references/xdoc-format.html"/>
       </item>



Mime
View raw message