Author: ltheussl
Date: Fri Nov 2 06:00:46 2007
New Revision: 591319
URL: http://svn.apache.org/viewvc?rev=591319&view=rev
Log:
Add docs about SiteModule settings.
Modified:
maven/doxia/site/src/site/xdoc/references/index.xml
Modified: maven/doxia/site/src/site/xdoc/references/index.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/xdoc/references/index.xml?rev=591319&r1=591318&r2=591319&view=diff
==============================================================================
--- maven/doxia/site/src/site/xdoc/references/index.xml (original)
+++ maven/doxia/site/src/site/xdoc/references/index.xml Fri Nov 2 06:00:46 2007
@@ -24,7 +24,7 @@
<properties>
<title>Doxia Markup Languages References</title>
<author email="ltheussl_AT_apache_DOT_org">Lukas Theussl</author>
- <author email="vsiveton_AT_apache_DOT_org"></author>
+ <author email="vsiveton_AT_apache_DOT_org">Vincent Siveton</author>
</properties>
<body>
@@ -40,6 +40,14 @@
</p>
<p>
+ The source directory is the directory under which Maven expects source
+ documents in this format (e.g. <code>src/site/apt/</code> for Apt), the
+ extension is the default file extension, and the parser id is gives the
+ unique identifier that is used by plexus to lookup the corresponding
+ component.
+ </p>
+
+ <p>
Please consult the <a href="../modules/index.html">Modules Guide</a>
for links to reference documentation of external formats.
</p>
@@ -52,15 +60,19 @@
<th>Short description</th>
<th align="center">Parser</th>
<th align="center">Sink</th>
- <th>Reference Documentation</th>
+ <th>Source Directory</th>
+ <th>Extension</th>
+ <th>Parser Id</th>
</tr>
<tr>
- <td>Apt</td>
+ <td><a href="./apt-format.html">Apt</a></td>
<td>Almost Plain Text</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
- <td><a href="./apt-format.html">APT Reference</a></td>
+ <td><code>apt</code></td>
+ <td><code>apt</code></td>
+ <td><code>apt</code></td>
</tr>
<tr>
@@ -68,7 +80,9 @@
<td>Confluence Enterprise Wiki</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_error_sml.gif"
alt="Yes"/></td>
- <td></td>
+ <td><code>confluence</code></td>
+ <td><code>confluence</code></td>
+ <td><code>confluence</code></td>
</tr>
<tr>
@@ -76,15 +90,19 @@
<td>DocBook XML Standard</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
- <td></td>
+ <td><code>docbook</code></td>
+ <td><code>xml</code></td>
+ <td><code>doc-book</code></td>
</tr>
<tr>
- <td>FML</td>
+ <td><a href="./fml-format.html">FML</a></td>
<td>FAQ Markup Language</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_error_sml.gif"
alt="Yes"/></td>
- <td><a href="./fml-format.html">FML Reference</a></td>
+ <td><code>fml</code></td>
+ <td><code>fml</code></td>
+ <td><code>fml</code></td>
</tr>
<tr>
@@ -93,6 +111,8 @@
<td align="center"><img src="../images/icon_error_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td></td>
+ <td></td>
+ <td></td>
</tr>
<tr>
@@ -101,6 +121,8 @@
<td align="center"><img src="../images/icon_error_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td></td>
+ <td></td>
+ <td></td>
</tr>
<tr>
@@ -109,6 +131,8 @@
<td align="center"><img src="../images/icon_error_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td></td>
+ <td></td>
+ <td></td>
</tr>
<tr>
@@ -116,15 +140,19 @@
<td>TWiki Structured Wiki</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_error_sml.gif"
alt="Yes"/></td>
- <td></td>
+ <td><code>twiki</code></td>
+ <td><code>twiki</code></td>
+ <td><code>twiki</code></td>
</tr>
<tr>
- <td>Xdoc</td>
+ <td><a href="./xdoc-format.html">Xdoc</a></td>
<td>XML Documentation Format</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
- <td><a href="./xdoc-format.html">Xdoc Reference</a></td>
+ <td><code>xdoc</code></td>
+ <td><code>xml</code></td>
+ <td><code>xdoc</code></td>
</tr>
<tr>
@@ -132,6 +160,8 @@
<td>Extensible Hypertext Markup Language</td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
<td align="center"><img src="../images/icon_success_sml.gif"
alt="Yes"/></td>
+ <td></td>
+ <td></td>
<td></td>
</tr>
</table>
