svn commit: r628305 - in /maven/doxia/site/src/site/apt/references: apt-format.apt doxia-apt.apt

[lt...@apache.org]

Author: ltheussl
Date: Sat Feb 16 06:27:22 2008
New Revision: 628305

URL: http://svn.apache.org/viewvc?rev=628305&view=rev
Log:
[DOXIA-99, DOXIA-138] Document more differences with aptconvert

Modified:
    maven/doxia/site/src/site/apt/references/apt-format.apt
    maven/doxia/site/src/site/apt/references/doxia-apt.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=628305&r1=628304&r2=628305&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/apt-format.apt (original)
+++ maven/doxia/site/src/site/apt/references/apt-format.apt Sat Feb 16 06:27:22 2008
@@ -14,12 +14,16 @@
 
   This document provides some examples of available APT formatting.
 
-  <<Note:>> The information contained in this document corresponds to the original
+  [Differences with aptconvert]
+          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.
+          for a detailed description. Notable differences are highlighted below
+          with a {{{./doxia-apt.html}\[Change\]}} link.
+
+  []
 
   The following sections contain formatted text that demonstrates the use
   of APT to create paragraphs, headers, sections, lists, code samples,
@@ -309,7 +313,7 @@
   The figure name is the pathname of the file containing the figure but
   without an extension. Example: if your figure is contained in
   <<</home/joe/docs/mylogo.jpeg>>>, the figure name is
-  <<</home/joe/docs/mylogo>>>.
+  <<</home/joe/docs/mylogo>>>. {{{./doxia-apt.html#Figure_extensions}\[Change\]}}
 
   If the figure name comes from a relative pathname (recommended practice)
   rather than from an absolute pathname, this relative pathname is taken to be
@@ -428,7 +432,7 @@
 
   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.
+  alphanumeric characters stripped. {{{./doxia-apt.html#Anchor_construction}\[Change\]}}
 
   This rule does not apply to links to <external> anchors. Text beginning
   with <<<http:/>>>, <<<https:/>>>, <<<ftp:/>>>, <<<file:/>>>, <<<mailto:>>>,
@@ -442,6 +446,7 @@
   elements.
 
   Section titles are implicitly defined anchors.
+  {{{./doxia-apt.html#Anchors_for_section_titles}\[Change\]}}
 
 *** Line break
 ~~~~~~~~~~~~~~

Modified: 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=628305&r1=628304&r2=628305&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/doxia-apt.apt (original)
+++ maven/doxia/site/src/site/apt/references/doxia-apt.apt Sat Feb 16 06:27:22 2008
@@ -5,7 +5,7 @@
  -----
 
 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
@@ -15,8 +15,8 @@
   be a valid Doxia input file and lead to identical results when processed
   by a Doxia parser.
 
-* Paragraphs in list items
-~~~~~~~~~~~~~~~~~~~~
+* {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:
@@ -46,8 +46,8 @@
 +---------------------------------------------------------------------------+
 
 
-* Table header cells
-~~~~~~~~~~~~~~~~~~~~
+* {Table header cells}
+~~~~~~~~~~~~~~~~~~~~~~
 
   Header cells are defined by an aditional pipe character '|' at the beginning
   of the cell:
@@ -58,4 +58,34 @@
     *-----------+-----------+
     | Cell 1    | Cell 2    |
     *-----------+-----------+
++---------------------------------------------------------------------------+
+
+* {Anchors and links}
+~~~~~~~~~~~~~~~~~~~~~
+
+** {Anchors for section titles}
+
+  Contrary to the original APT format, section titles are <<not>> implicitly
+  defined anchors. If you want an anchor for a section title you need to
+  define it explicitly as such:
+
++---------------------------------------------------------------------------+
+* {Anchors for section titles}
++---------------------------------------------------------------------------+
+
+** {Anchor construction}
+
+  Contrary to the original APT format, an anchor/link is <<not>> its text with
+  all non alphanumeric characters stripped. Instead, all non alphanumeric
+  characters are replaced by an underscore '_', so the anchor for the section
+  title in the previous example would be <<<Anchors_for_section_titles>>>.
+
+* {Figure extensions}
+~~~~~~~~~~~~~~~~~~~~~
+
+  Contrary to the original APT format, a figure name has to be given fully
+  <<with>> extension. For instance:
+
++---------------------------------------------------------------------------+
+[/home/joe/docs/mylogo.jpeg] Figure caption
 +---------------------------------------------------------------------------+