Documentations update
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114612 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
evenisse
@@ -1,52 +1,115 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven PDF Plugin Properties</title>
|
||||
<author email="dion@apache.org">dIon Gillard</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven PDF Plugin Settings">
|
||||
<table>
|
||||
<tr>
|
||||
<th>Property name</th>
|
||||
<th>Optional?</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.docs.src</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The source directory for your <code>navigation.xml</code>.
|
||||
Defaults to <code>${basedir}/xdocs</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.docs.dest</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The destination directory for documentation. Defaults to
|
||||
<code>${maven.build.dir}/docs/</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.docs.outputencoding</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The output encoding of the generated documentation
|
||||
Defaults to <code>ISO-8859-1</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.gen.docs</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The directory for generated xdocs. Defaults to
|
||||
<code>${maven.build.dir}/generated-xdocs/</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
<properties>
|
||||
<title>Maven PDF Plugin Properties</title>
|
||||
<author email="dion@apache.org">dIon Gillard</author>
|
||||
</properties>
|
||||
<body>
|
||||
<section name="Maven PDF Plugin Settings">
|
||||
<p>This properties are used by the plugin and can be redifned by the user.</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>Property name</th>
|
||||
<th>Optional?</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.docs.src</td>
|
||||
<td>Yes</td>
|
||||
<td>The source directory for the <code>${maven.pdf.navigationFile}</code> file and the user xml documentations files. Defaults to <code>${basedir}/xdocs</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.docs.dest</td>
|
||||
<td>Yes</td>
|
||||
<td>The destination directory for PDF documentation. Images are copied fom this directory. Defaults to <code>${maven.build.dir}/docs/</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.docs.outputencoding</td>
|
||||
<td>Yes</td>
|
||||
<td>The output encoding of the generated documentation. Defaults to <code>ISO-8859-1</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.gen.docs</td>
|
||||
<td>Yes</td>
|
||||
<td>The directory for generated xdocs. Defaults to <code>${maven.build.dir}/generated-xdocs/</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.confidential</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b> Defaults to <code>false</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.paperType</td>
|
||||
<td>Yes</td>
|
||||
<td>Paper type for the generated PDF file. Defaults to <code>A4</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.companyName</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to <code>${pom.organization.name}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.companyIncName</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to <code>${pom.organization.name}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.copyrightYear</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to <code>${pom.inceptionYear}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.imageDpi</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to <code>150</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.debug</td>
|
||||
<td>Yes</td>
|
||||
<td>Debug pdf generation process. Defaults to <code>false</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.navigationFile</td>
|
||||
<td>Yes</td>
|
||||
<td>Filename for the navigation file used to generate the PDF. Defaults to <code>navigation.xml</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.projectCompany</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>${pom.organization.name}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.projectName</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>${pom.name}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.type</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>Project Documentation</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.version</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>${pom.currentVersion}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.date</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>June 2, 2003</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.projectLogo</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>${pom.url}${pom.logo}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.companyLogo</td>
|
||||
<td>Yes</td>
|
||||
<td>Usage <b>not yet implemented.</b>Defaults to <code>${pom.organization.url}${pom.organization.logo}</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
Reference in New Issue
Block a user