format.apt

src版Buffalo最新框架

  first try to load <<</home/joe/docs/mylogo.eps>>>. When the desired format
  is not found, a APT processor tries to convert one of the existing
  formats. In our example, the APT processor tries to convert
  <<</home/joe/docs/mylogo.jpeg>>> to encapsulated PostScript.

*** Table
~~~~~~~~~

  A table block is not indented. It begins with a non indented line containing
  an asterisk and at least 2 dashes (<<<*-->>>). It ends with a
  similar line.

  The first line is not only used to recognize a table but also to specify
  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 colon (<<<:>>>) specifies that column 3 is right aligned.

      []

+---------------------------------------------+
*----------*--------------+----------------:
| 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
+---------------------------------------------+

  Rows are separated by a non indented line beginning with <<<*-->>>.

  An optional table caption (non indented text) may immediately follow the
  table.

  Rows may contain single line or multiple line cells. Each line of cell text
  is separated from the adjacent cell by the pipe character (<<<|>>>).
  (<<<|>>> may be used in the cell text if quoted: <<<\\|>>>.)

  The last <<<|>>> is only used to make the table nicer.  The first <<<|>>> is
  not only used to make the table nicer, but also to specify that a grid is to
  be drawn around table cells.

  The following example shows a simple table with no grid and no caption.

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

*** Horizontal rule
~~~~~~~~~~~~~~~~~~~

+---------------------+
=====================
+---------------------+

  A non indented line containing at least 3 equal signs (<<<===>>>).

*** Page break
~~~~~~~~~~~~~~

+---+
^L
+---+

  A non indented line containing a single form feed character (Control-L).

** Text level elements
~~~~~~~~~~~~~~~~~~~~~~

*** Font
~~~~~~~~

+-----------------------------------------------------+
  <Italic> font. <<Bold>> font. <<<Monospaced>>> font.
+-----------------------------------------------------+

  Text between \< and > must be rendered in italic. Text between \<\< and >>
  must be rendered in bold. Text between \<\<\< and >>> must be rendered using
  a monospaced, typewriter-like font.

  Font elements may appear anywhere except inside other font elements.

  It is not recommended to use font elements inside titles, section titles,
  links and defined terms because a APT processor automatically applies
  appropriate font styles to these elements.

*** Anchor and link
~~~~~~~~~~~~~~~~~~~

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

  Text between curly braces (<<<\{}>>>) specifies an anchor. Text between
  double curly braces (<<<\{\{}}>>>) specifies a link.

  It is an error to create a link element that does not refer to an anchor of
  the same name. The name of an anchor/link is its text with all non
  alphanumeric characters stripped.

  This rule does not apply to links to <external> anchors. Text beginning
  with <<<http:/>>>, <<<https:/>>>, <<<ftp:/>>>, <<<file:/>>>, <<<mailto:>>>,
  <<<../>>>, <<<./>>> (<<<..\\>>> and <<<.\\>>> on Windows) is recognized as
  an external anchor name.

  When the construct <<\{\{\{>><name><<}>><text><<}}>> is used, the link text
  <text> may differ from the link name <name>.

  Anchor/link elements may appear anywhere except inside other anchor/link
  elements.

  Section titles are implicitly defined anchors.

*** Line break
~~~~~~~~~~~~~~

+-------------+
  Force line\
  break.
+-------------+

  A backslash character (<<<\\>>>) followed by a newline character.

  Line breaks must not be used inside titles and tables (which are line
  oriented blocks with implicit line breaks).

*** Non breaking space
~~~~~~~~~~~~~~~~~~~~~~

+----------------------+
  Non\ breaking\ space.
+----------------------+

  A backslash character (<<<\\>>>) followed by a space character.

*** Special character
~~~~~~~~~~~~~~~~~~~~~

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

  In certain contexts, these characters have a special meaning and therefore
  must be escaped if needed as is. They are escaped by adding a backslash in
  front of them. The backslash may itself be escaped by adding another
  backslash in front of it.

  Note that an asterisk, for example, needs to be escaped only if its begins a
  paragraph. (<<<*>>> has no special meaning in the middle of a paragraph.)

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

  Latin-1 characters (whatever is the encoding of the APT document) may be
  specified by their codes using a backslash followed by one to three octal
  digits or by using the <<<\x>>><NN> notation, where <NN> are two hexadecimal
  digits.

  Unicode characters may be specified by their codes using the <<<\u>>><NNNN>
  notation, where <NNNN> are four hexadecimal digits.

*** Comment
~~~~~~~~~~~

+---------------+
~~Commented out.
+---------------+

  Text found after two tildes (<<<\~~>>>) is ignored up to the end of line.

  A line of <<<~>>> is often used to ``underline'' section titles in order to
  make them stand out of other paragraphs.


* The APT format at a glance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

------------------------------------------------------------------------------