Author: hboutemy
Date: Sun Feb 13 22:27:04 2011
New Revision: 1070315
URL: http://svn.apache.org/viewvc?rev=1070315&view=rev
Log:
improved documentation about formats
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fml/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-rtf/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/pom.xml
maven/doxia/doxia/trunk/doxia-modules/doxia-module-xhtml/pom.xml
maven/doxia/doxia/trunk/doxia-modules/src/site/site.xml
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-apt</artifactId>
<name>Doxia :: APT Module</name>
- <description>A Doxia module for Almost Plain Text source
documents.</description>
+ <description>
+ A Doxia module for Almost Plain Text source documents.
+ APT format is supported both as source and target formats.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-apt/</url>
<!-- START SNIPPET: test -->
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
---
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
(original)
+++
maven/doxia/doxia/trunk/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java
Sun Feb 13 22:27:04 2011
@@ -29,7 +29,7 @@ import org.apache.maven.doxia.sink.SinkE
import org.codehaus.plexus.util.StringUtils;
/**
- * APT Sink implementation.
+ * APT generator implementation.
* <br/>
* <b>Note</b>: The encoding used is UTF-8.
*
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/pom.xml
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-confluence/pom.xml Sun
Feb 13 22:27:04 2011
@@ -30,7 +30,10 @@ under the License.
<artifactId>doxia-module-confluence</artifactId>
<name>Doxia :: Confluence Module</name>
- <description>A Doxia module for Confluence source documents.</description>
+ <description>
+ A Doxia module for Confluence documents.
+ Confluence format is supported both as source and target formats.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-confluence/</url>
<dependencies>
Modified:
maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/pom.xml
(original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-docbook-simple/pom.xml
Sun Feb 13 22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-docbook-simple</artifactId>
<name>Doxia :: Simplified DocBook Module</name>
- <description>A Doxia module for Simplified DocBook source
documents.</description>
+ <description>
+ A Doxia module for Simplified DocBook documents.
+ DocBook format is supported both as source and target formats.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-docbook-simple/</url>
<dependencies>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-fml/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fml/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-fml/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-fml/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-fml</artifactId>
<name>Doxia :: FML Module</name>
- <description>A Doxia module for FML source documents.</description>
+ <description>
+ A Doxia module for FML source documents.
+ FML format is only supported as source format.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fml/</url>
<dependencies>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-fo/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-fo</artifactId>
<name>Doxia :: FO Module</name>
- <description>A Doxia module for FO (Formatting Objects) source
documents.</description>
+ <description>
+ A Doxia module for FO (Formatting Objects) source documents.
+ FO format is only supported as target format.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fo/</url>
<developers>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-itext/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-itext</artifactId>
<name>Doxia :: iText Module</name>
- <description>A Doxia module for iText source documents.</description>
+ <description>
+ A Doxia module for iText source documents.
+ iText format is only supported as target format.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-itext/</url>
<developers>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-latex/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-latex</artifactId>
<name>Doxia :: Latex Module</name>
- <description>A Doxia module for LaTeX source documents.</description>
+ <description>
+ A Doxia module for LaTeX source documents.
+ LaTeX format is only supported as target format.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-latex/</url>
<dependencies>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-rtf/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-rtf/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-rtf/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-rtf/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-rtf</artifactId>
<name>Doxia :: RTF Module</name>
- <description>A Doxia module for Rich Text Format source
documents.</description>
+ <description>
+ A Doxia module for Rich Text Format source documents.
+ RTF format is only supported as target format.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-rtf/</url>
<dependencies>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-twiki/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-twiki</artifactId>
<name>Doxia :: TWiki Module</name>
- <description>A Doxia module for Twiki source documents.</description>
+ <description>
+ A Doxia module for Twiki source documents.
+ Twiki format is supported both as source and target formats.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-twiki/</url>
<developers>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-xdoc</artifactId>
<name>Doxia :: XDoc Module</name>
- <description>A Doxia module for Xdoc source documents.</description>
+ <description>
+ A Doxia module for Xdoc source documents.
+ Xdoc format is supported both as source and target formats.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xdoc/</url>
<dependencies>
Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-xhtml/pom.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xhtml/pom.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/doxia-module-xhtml/pom.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-xhtml/pom.xml Sun Feb 13
22:27:04 2011
@@ -32,7 +32,10 @@ under the License.
<artifactId>doxia-module-xhtml</artifactId>
<name>Doxia :: XHTML Module</name>
- <description>A Doxia module for Xhtml source documents.</description>
+ <description>
+ A Doxia module for Xhtml source documents.
+ Xhtml format is supported both as source and target formats.
+ </description>
<url>http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xhtml/</url>
<dependencies>
Modified: maven/doxia/doxia/trunk/doxia-modules/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/src/site/site.xml?rev=1070315&r1=1070314&r2=1070315&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-modules/src/site/site.xml (original)
+++ maven/doxia/doxia/trunk/doxia-modules/src/site/site.xml Sun Feb 13 22:27:04
2011
@@ -28,6 +28,11 @@
<menu ref="parent"/>
+ <menu name="Documentation" inherit="bottom">
+ <item name="Format References"
href="http://maven.apache.org/doxia/references/index.html"/>
+ <item name="Doxia Modules Guide"
href="http://maven.apache.org/doxia/modules/index.html"/>
+ </menu>
+
<menu ref="modules"/>
<menu ref="reports"/>
