You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by lt...@apache.org on 2009/02/19 13:56:13 UTC
svn commit: r745844 - in
/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt: index.apt
limitations.apt usage.apt
Author: ltheussl
Date: Thu Feb 19 12:56:12 2009
New Revision: 745844
URL: http://svn.apache.org/viewvc?rev=745844&view=rev
Log:
Update docs
Modified:
maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt
maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt
maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/usage.apt
Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt?rev=745844&r1=745843&r2=745844&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt (original)
+++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/index.apt Thu Feb 19 12:56:12 2009
@@ -42,3 +42,7 @@
Instructions on the basic usage of the PDF Plugin can be found
{{{./usage.html}here}}.
+
+* Example
+
+ Have a look at the {{{./maven-pdf-plugin.pdf}pdf}} version of this web site.
\ No newline at end of file
Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt?rev=745844&r1=745843&r2=745844&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt (original)
+++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/limitations.apt Thu Feb 19 12:56:12 2009
@@ -32,14 +32,15 @@
* Current limitations
- * Works only with Maven \>\= 2.1 using doxia-1.1.
+ * Current prerequisite is Maven \>\= 2.0.6. It's using Doxia-1.1 via the shade-plugin
+ (see {{{http://jira.codehaus.org/browse/MNG-3402}MNG-3402}}).
* Maven generated pages (reports) are ignored.
- * Xdoc tables don't work due to a bug in the xdoc parser.
-
* Links to other source documents have to start with "./" or "../".
+ * Xdoc sections need to be consecutive, see {{{http://jira.codehaus.org/browse/DOXIA-241}DOXIA-241}}.
+
* Missing features
* Cover page not configurable (only title and author).
Modified: maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/usage.apt?rev=745844&r1=745843&r2=745844&view=diff
==============================================================================
--- maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/usage.apt (original)
+++ maven/sandbox/trunk/plugins/maven-pdf-plugin/src/site/apt/usage.apt Thu Feb 19 12:56:12 2009
@@ -63,6 +63,9 @@
<goals>
<goal>pdf</goal>
</goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
+ </configuration>
</execution>
</executions>
</plugin>
@@ -70,4 +73,31 @@
</build>
[...]
</project>
-+-----
\ No newline at end of file
++-----
+
+* Document descriptor
+
+ By default, the pdf plugin processes all source files (in unspecified order)
+ found under the site source directory (apt, xdoc, fml,...). You can customize
+ which files to include in which order by using a document descriptor
+ (by default <<<src/site/pdf.xml>>>). An example is given below:
+
++-----
+<document outputName="maven-pdf-plugin">
+
+ <meta>
+ <title>Maven PDF Plugin</title>
+ <author>The Apache Maven Project</author>
+ </meta>
+
+ <toc name="Table of Contents">
+ <item name="Introduction" ref="index.apt"/>
+ <item name="Usage" ref="usage.apt"/>
+ </toc>
+
+</document>
++-----
+
+ The <<<meta>>> information is used for the pdf cover page, while the
+ <<<toc>>> generates a Table of Contents and specifies the order of
+ files to include in the pdf.
\ No newline at end of file