编辑Maven Site时apt页面的编写格式

Translated From:http://maven.apache.org/doxia/references/apt-format.html

---------------------------------------------------------------
------------------------元素说明---------------------------
---------------------------------------------------------------

1.普通文本(plain test)
在行的开头，存在空格，则该行作为没有格式的文本显示
例如：
    this is plan test

2.标题块(title block)
标题块是可选的，没有固定的格式，但是必须出现在文档的第一块，不然就会当做普通文本输出。
例如
             ------
            Title
            ------
            Author
            ------
             Date

3.文本块(Section)
文本块是通过插入文本标题来创建，一些简单的文档也许不需要包含文本块。
一个文本块标题的格式，如下(必须顶行)

Section title

* Sub-section title

** Sub-sub-section title

*** Sub-sub-sub-section title

**** Sub-sub-sub-sub-section title

4.列表（List）
列表是锯齿状的，必须以空格和*开头。当列表中有普通文本时，普通文本需要比列表项更加缩进。同样，存在一个子列表时，也是需要更加缩进。在列表结束时，需要用一个假元素[]来强制结束列表。同样的，[]也可以用来结束子列表。
列表格式有无序列表（示例1），编号列表，定义列表（示例2）。编号列表的标签可以是如下形式
[[1]]   Decimal numbering: 1, 2, 3, 4, etc.
[[a]]   Lower-alpha numbering: a, b, c, d, etc.
[[A]]   Upper-alpha numbering: A, B, C, D, etc.
[[i]]    Lower-roman numbering: i, ii, iii, iv, etc.
[[I]]    Upper-roman numbering: I, II, III, IV, etc.

示例1：
      * List item 1.

      * List item 2.

        Paragraph contained in list item 2.

            * Sub-list item 1.

            * Sub-list item 2.

      * List item 3.
        Force end of list:

      []

--------------------------------------------
Verbatim text not contained in list item 3
--------------------------------------------

示例2：
      [[1]] Numbered item 1.

                [[A]] Numbered item A.

                [] Numbered item B.

      [[2]] Numbered item 2.

[b]5.逐字文本（Verbatim text）
逐字文本是非锯齿状的，通常以至少三个*开始，以类似的行结束。
例如：
----------------------------------------
Verbatim
         text,
                preformatted,
                                escaped.
----------------------------------------

6.图像（Figure）
[]内指定的是图片的路径。
例如：
[images/a.jpg] Figure caption

7.表格（Table）
一个表格块是非缩进的，表格以（*--）开头并且非缩进的行开始，并以类似的行结束。
第一行不仅可以指定一个表格，而且还可以指定表格中列的缩进方式。，如下所示，在第一行的第二个*指定第一列是中间缩进，+指定第二列是左缩进，：指定第三列是右缩进。一个可选的表标题（Table caption）可以紧随表格。
*----------*--------------+----------------:
| Centered | Left-aligned | Right-aligned  |
| cell 1,1 | cell 1,2     | cell 1,3       |
*----------*--------------+----------------:
| cell 2,1 | cell 2,2     | cell 2,3       |
*----------*--------------+----------------:
Table caption

8.平行线（Horizontal rule）
至少有三个===
例如：
=====================

9.文本级别的元素（Text level elements）

9.1.字体
不建议在标题中使用font，因为APT处理程序会对它们自动地应用合适的Font。
例如：
<Italic> font. <<Bold>> font. <<<Monospaced>>> font.

9.2.链接
例如：
  {{http://www.pixware.fr}}
  {{{http://www.pixware.fr}Pixware home page}}

9.3.换行
例如：
   Force line\
   break.

9.4.特殊字符
有些字符有特殊的含义，需要转义。
例如：
\~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.

9.5.注释
例如：
  ~~Commented out.



---------------------------------------------------------------
-------------------------综合示例-------------------------
---------------------------------------------------------------

            ------
            Title
            ------
            Author
            ------
             Date

  Paragraph 1, line 1.
  Paragraph 1, line 2.

  Paragraph 2, line 1.
  Paragraph 2, line 2.

Section title

* Sub-section title

** Sub-sub-section title

*** Sub-sub-sub-section title

**** Sub-sub-sub-sub-section title

      * List item 1.

      * List item 2.

        Paragraph contained in list item 2.

            * Sub-list item 1.

            * Sub-list item 2.

      * List item 3.
        Force end of list:

      []

+------------------------------------------+
Verbatim text not contained in list item 3
+------------------------------------------+

      [[1]] Numbered item 1.

                [[A]] Numbered item A.

                [[B]] Numbered item B.

      [[2]] Numbered item 2.

  List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]].

      [Defined term 1] of definition list.

      [Defined term 2] of definition list.

+-------------------------------+
Verbatim text
                        in a box
+-------------------------------+

  --- instead of +-- suppresses the box around verbatim text.

[Figure name] Figure caption

*----------*--------------+----------------:
| Centered | Left-aligned | Right-aligned  |
| cell 1,1 | cell 1,2     | cell 1,3       |
*----------*--------------+----------------:
| cell 2,1 | cell 2,2     | cell 2,3       |
*----------*--------------+----------------:
Table caption

  No grid, no caption:

*-----*------*
cell | cell
*-----*------*
cell | cell
*-----*------*

  Horizontal line:

=======================================================================

^L
  New page.

  <Italic> font. <<Bold>> font. <<<Monospaced>>> font.

  {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}}.

  Force line\
  break.

  Non\ breaking\ space.

  Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.

  Copyright symbol: \251, \xA9, \u00a9.

~~Commented out.