Author: dennisl
Date: Sat Nov 10 09:59:38 2007
New Revision: 593800
URL: http://svn.apache.org/viewvc?rev=593800&view=rev
Log:
o Sync in some changes from /maven/site/guides/mini/guide-apt-format.
Modified:
maven/doxia/site/src/site/apt/references/apt-format.apt
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=593800&r1=593799&r2=593800&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/apt-format.apt (original)
+++ maven/doxia/site/src/site/apt/references/apt-format.apt Sat Nov 10 09:59:38
2007
@@ -7,7 +7,16 @@
The APT format
~~~~~~~~~~~~~~
- In the following section, boxes containing text in typewriter-like font are
+ 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.
+ 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.
* Document structure
@@ -31,7 +40,7 @@
First line of first paragraph.
Second line of first paragraph.
Third line of first paragraph.
-
+
Line 1 of paragraph 2 (separated from first paragraph by an open line).
Line 2 of paragraph 2.
+------------------------------------------------------------------------+
@@ -58,11 +67,11 @@
+-------------------------------------------------------+
First paragraph has its first line indented by four
-spaces. Then the author did even bother to indent the
+spaces. Then the author did not even bother to indent the
other lines of the paragraph.
- Second paragraph contains several lines which are all
- indented by two spaces. This style is much nicer than
+ Second paragraph contains several lines which are all
+ indented by two spaces. This style is much nicer than
the one used for the previous paragraph.
+-------------------------------------------------------+
@@ -81,12 +90,12 @@
document.
+----------------------------------------------------------------------------+
- ------
- Title
- ------
- Author
- ------
- Date
+ ------
+ Title
+ ------
+ Author
+ ------
+ Date
+----------------------------------------------------------------------------+
A title block is indented (centering it is nicer). It begins with a line
@@ -106,12 +115,12 @@
with no declared author.
+----------------------------------------------------------------------------+
- ------
- Title
- ------
- ------
- Date
- ------
+ ------
+ Title
+ ------
+ ------
+ Date
+ ------
+----------------------------------------------------------------------------+
The last line is ignored. It is just there to make the block nicer.
@@ -129,8 +138,8 @@
Paragraph 2, line 2.
+----------------------+
- Paragraphs are indented. They have already been described in the {{document
- structure}} section.
+ Paragraphs are indented. They have already been described in the
+ {{Document_structure}} section.
*** Section
~~~~~~~~~~~
@@ -171,7 +180,7 @@
* List item 3.
+---------------------------------------+
- List items are indented and begin with a asterisk (<<<*>>>).
+ List items are indented and begin with a asterisk (<<<*>>>).
Plain paragraphs more indented than the first list item are nested in that
list. Displays such as tables (not indented) are always nested in the
@@ -207,11 +216,11 @@
* List item 2.
- * Sub-list item 1.
+ * Sub-list item 1.
- * Sub-list item 2.
+ * Sub-list item 2.
- []
+ []
-------------------------------------------------------------------
Verbatim text contained in list item 2, but not in sub-list item 2
@@ -315,12 +324,12 @@
similar line.
The first line is not only used to recognize a table but also to specify
- column justification. In the following example,
+ column justification. In the following example,
* the second asterisk (<<<*>>>) is used to specify that column 1 is
centered,
- * the plus sign (<<<+>>>) specifies that column 2 is left aligned,
+ * the plus sign (<<<+>>>) specifies that column 2 is left aligned,
* the colon (<<<:>>>) specifies that column 3 is right aligned.
@@ -401,7 +410,7 @@
~~~~~~~~~~~~~~~~~~~
+-----------------------------------------------------------------+
- {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
+ {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
Link to {{{anchor}showing alternate text}}.
Link to {{{http://www.pixware.fr}Pixware home page}}.
+-----------------------------------------------------------------+
@@ -492,12 +501,12 @@
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
------------------------------------------------------------------------------
- ------
- Title
- ------
- Author
- ------
- Date
+ ------
+ Title
+ ------
+ Author
+ ------
+ Date
Paragraph 1, line 1.
Paragraph 1, line 2.
@@ -550,7 +559,7 @@
+-------------------------------+
Verbatim text
- in a box
+ in a box
+-------------------------------+
--- instead of +-- suppresses the box around verbatim text.
@@ -582,7 +591,7 @@
<Italic> font. <<Bold>> font. <<<Monospaced>>> font.
- {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
+ {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
Link to {{{anchor}showing alternate text}}.
Link to {{{http://www.pixware.fr}Pixware home page}}.
