Author: ltheussl
Date: Fri May 8 20:24:38 2009
New Revision: 773083
URL: http://svn.apache.org/viewvc?rev=773083&view=rev
Log:
Update docs with info about cover page configuration.
Modified:
maven/plugins/trunk/maven-pdf-plugin/pom.xml
maven/plugins/trunk/maven-pdf-plugin/src/site/apt/limitations.apt
maven/plugins/trunk/maven-pdf-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-pdf-plugin/src/site/pdf.xml
Modified: maven/plugins/trunk/maven-pdf-plugin/pom.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pdf-plugin/pom.xml?rev=773083&r1=773082&r2=773083&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pdf-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-pdf-plugin/pom.xml Fri May 8 20:24:38 2009
@@ -244,6 +244,7 @@
<id>pdf</id>
<build>
<plugins>
+<!-- START SNIPPET: configuration -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pdf-plugin</artifactId>
@@ -261,6 +262,7 @@
</execution>
</executions>
</plugin>
+<!-- END SNIPPET: configuration -->
</plugins>
</build>
</profile>
Modified: maven/plugins/trunk/maven-pdf-plugin/src/site/apt/limitations.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pdf-plugin/src/site/apt/limitations.apt?rev=773083&r1=773082&r2=773083&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pdf-plugin/src/site/apt/limitations.apt (original)
+++ maven/plugins/trunk/maven-pdf-plugin/src/site/apt/limitations.apt Fri May
8 20:24:38 2009
@@ -39,8 +39,6 @@
* Missing features
- * Cover page not configurable (only title and author).
-
* Menu sub-items are not supported in TOC (every source document starts a
new chapter).
* Known bugs
Modified: maven/plugins/trunk/maven-pdf-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pdf-plugin/src/site/apt/usage.apt?rev=773083&r1=773082&r2=773083&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pdf-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-pdf-plugin/src/site/apt/usage.apt Fri May 8
20:24:38 2009
@@ -46,61 +46,27 @@
* Running the PDF plugin automatically during a build
The PDF plugin can be put into a project's pom.xml so that it gets executed
- everytime the project is built. Below is a sample pom.xml for running the
+ everytime the project is built. Below is a sample configuration
+ (to put into the list of <<<\<plugins\>>>> in the <<<\<build\>>>>
+ section of your <<<pom.xml>>>) for running the
PDF plugin in the <<<site>>> phase everytime the project is built:
-+-----
-<project>
- [...]
- <build>
- <plugins>
- <plugin>
- <artifactId>maven-pdf-plugin</artifactId>
- <executions>
- <execution>
- <id>site-pdf</id>
- <phase>site</phase>
- <goals>
- <goal>pdf</goal>
- </goals>
- <configuration>
-
<outputDirectory>${project.reporting.outputDirectory}</outputDirectory>
- </configuration>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- [...]
-</project>
-+-----
+%{snippet|id=configuration|file=pom.xml}
* 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
+ By default, the pdf plugin processes all source files as specified
+ in the site-plugins's <<<site.xml>>>. 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>
-+-----
+%{snippet|id=docDescriptor|file=src/site/pdf.xml}
- 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.
+ The <<<meta>>> information is only used for the pdf cover page if
+ no <<<cover>>> element is given. The <<<toc>>> generates a Table
+ of Contents and specifies the order of files to include in the pdf.
+ For a complete description of the file format, see the
+ {{{http://maven.apache.org/doxia/doxia/doxia-core/document.html}Document
Model Reference}}.
* Configuration properties
Modified: maven/plugins/trunk/maven-pdf-plugin/src/site/pdf.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-pdf-plugin/src/site/pdf.xml?rev=773083&r1=773082&r2=773083&view=diff
==============================================================================
--- maven/plugins/trunk/maven-pdf-plugin/src/site/pdf.xml (original)
+++ maven/plugins/trunk/maven-pdf-plugin/src/site/pdf.xml Fri May 8 20:24:38
2009
@@ -21,7 +21,8 @@
*/
-->
-<document outputName="maven-pdf-plugin">
+<!-- START SNIPPET: docDescriptor -->
+<document outputName="maven-pdf-plugin-${project.version}">
<meta>
<title>Maven PDF Plugin</title>
@@ -44,3 +45,4 @@
</cover>
</document>
+<!-- END SNIPPET: docDescriptor -->
\ No newline at end of file
