Author: ltheussl
Date: Sun Sep 9 14:52:53 2007
New Revision: 574085
URL: http://svn.apache.org/viewvc?rev=574085&view=rev
Log:
update user docs
Modified:
maven/doxia/site/src/site/apt/book/index.apt
maven/doxia/site/src/site/apt/developers/index.apt
maven/doxia/site/src/site/apt/references/index.apt
maven/doxia/site/src/site/fml/faq.fml
Modified: maven/doxia/site/src/site/apt/book/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/book/index.apt?rev=574085&r1=574084&r2=574085&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/book/index.apt (original)
+++ maven/doxia/site/src/site/apt/book/index.apt Sun Sep 9 14:52:53 2007
@@ -32,7 +32,7 @@
This example illustrates how to configure the Doxia Maven plugin. It will
render the book in three different formats.
By default the output will be under <<<target/generated-site/<format>/<book
id> >>>.
- Actually, the out-of-box format ids are: <<<xdoc>>>, <<<pdf>>>, <<<latex>>>,
<<<rtf>>>
+ The currently supported format ids are: <<<xdoc>>>, <<<pdf>>>, <<<latex>>>,
<<<rtf>>>, <<<xhtml>>>, <<<doc-book>>>
A sample pom.xml is given below:
Modified: maven/doxia/site/src/site/apt/developers/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/developers/index.apt?rev=574085&r1=574084&r2=574085&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/developers/index.apt (original)
+++ maven/doxia/site/src/site/apt/developers/index.apt Sun Sep 9 14:52:53 2007
@@ -186,4 +186,8 @@
* {{{../macros/index.html}Doxia Macros Guide}}
+ * {{{../doxia/apidocs/index.html}Doxia API Reference}}
+
+ * {{{../doxia-sitetools/apidocs/index.html}Doxia Sitetools API Reference}}
+
[]
Modified: maven/doxia/site/src/site/apt/references/index.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/references/index.apt?rev=574085&r1=574084&r2=574085&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/index.apt (original)
+++ maven/doxia/site/src/site/apt/references/index.apt Sun Sep 9 14:52:53 2007
@@ -28,12 +28,33 @@
Doxia Markup Languages References
- You will find here several markup languages references used by Doxia to write
well done documentation.
+ The following table gives an overview of the markup languages currently
supported by Doxia.
+ If a Parser is available for a given format, it means that you can write your
documentation in this language
+ and Doxia can generate output from it. If a Sink is available, it means you
can generate output in this format.
- * {{{./apt-format.html}APT (Almost Plain Text) Format}}
+ Please consult the {{{../modules/index.html}Modules Guide}} for links to
reference documentation of external formats.
- * {{{./fml-format.html} FML (FAQ Markup Language) Format}}
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+|| Format || Short description || Parser || Sink || Reference
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| Apt | Almost Plain Text | Yes | Yes |
{{{./apt-format.html}APT Reference}} |
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| Confluence | | Yes | No |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| Docbook | | Yes | Yes |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| FML | FAQ Markup Language | Yes | No |
{{{./fml-format.html} FML Reference}} |
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| IText | | No | Yes |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| Latex | | No | Yes |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| RTF | MS Rich Text Format | No | Yes |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| TWiki | | Yes | No |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| Xdoc | | Yes | Yes |
{{{./xdoc-format.html} Xdoc Reference}} |
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
+| XHTML | | Yes | Yes |
|
+*----------------+-----------------------+-----------*----------*----------------------------------------------+
- * {{{./xdoc-format.html} Xdoc Format}}
-
- []
Modified: maven/doxia/site/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/fml/faq.fml?rev=574085&r1=574084&r2=574085&view=diff
==============================================================================
--- maven/doxia/site/src/site/fml/faq.fml (original)
+++ maven/doxia/site/src/site/fml/faq.fml Sun Sep 9 14:52:53 2007
@@ -49,11 +49,8 @@
<p>
Doxia also has a fairly simple tool for writing books. It comes
complete with a Maven plugin
to produce PDFs, LaTeX documents and Xdoc for direct integration in
your Maven site.
- </p>
- <p>
- The Doxia Book code is still in the
- <a
href="http://svn.apache.org/repos/asf/maven/sandbox/trunk/doxia/doxia-book/";>Doxia
sandbox</a>,
- but it is fully functional allthough limited.
+ The <a
href="http://svn.apache.org/repos/asf/maven/doxia/doxia/trunk/doxia-book/";>Doxia
Book code</a>
+ is still limited but fully functional.
</p>
<p>
See <a href="./book/index.html">Writing Books in Doxia</a> for more
information.
