Apply MPPDF-5 and MPPDF-6 form Arnaud Heritier
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114708 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
evenisse
@@ -8,128 +8,193 @@
|
||||
<section name="Maven PDF Plugin Settings">
|
||||
<p>This properties are used by the plugin and can be redefined 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 also copied from 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.pdfName</td>
|
||||
<td>Yes</td>
|
||||
<td>The name of pdf file. Defaults to
|
||||
<code>${pom.artifactId}.pdf</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.confidential</td>
|
||||
<td>Yes</td>
|
||||
<td>Add a confidential text to the footer of each page.
|
||||
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.companyIncName</td>
|
||||
<td>Yes</td>
|
||||
<td>The company name printed on each page footer beside the copyrigths.
|
||||
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.debug</td>
|
||||
<td>Yes</td>
|
||||
<td>Debug the pdf generation process. Defaults to
|
||||
<code>false</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.imageDpi</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to <code>150</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.projectLogo</td>
|
||||
<td>Yes</td>
|
||||
<td>Project logo URL (or relative path). Defaults to
|
||||
<code>${pom.url}${pom.logo}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.companyLogo</td>
|
||||
<td>Yes</td>
|
||||
<td>Company logo URL (or relative path). Defaults to
|
||||
<code>${pom.organization.url}${pom.organization.logo}</code>
|
||||
<subsection name="PDF content customization">
|
||||
<table>
|
||||
<tr>
|
||||
<th width="25%">Property name</th>
|
||||
<th>Description</th>
|
||||
<th width="10%">Optional?</th>
|
||||
<th>Default value</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.confidential</td>
|
||||
<td>Add a confidential text to the footer of each page.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>false</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.paperType</td>
|
||||
<td>Paper type for the generated PDF file. Available formats are :
|
||||
<ul>
|
||||
<li>
|
||||
<code>A4</code> : 8.25in x 11.70in</li>
|
||||
<li>
|
||||
<code>US</code> : 8.5in x 14in</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>A4</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.companyIncName</td>
|
||||
<td>The company name printed on each page footer beside the copyrigth.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.organization.name}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.copyrightYear</td>
|
||||
<td>The year for the copyright.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.inceptionYear}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.imageDpi</td>
|
||||
<td>Images resolution.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>75</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.navigationFile</td>
|
||||
<td>Filename for the navigation file used to generate the
|
||||
PDF. It allows to separate the content of the site
|
||||
and the content of the PDF documentation.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>navigation.xml</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.projectLogo</td>
|
||||
<td>Project logo URL (or relative path).</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.url}${pom.logo}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.companyLogo</td>
|
||||
<td>Company logo URL (or relative path).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.projectCompany</td>
|
||||
<td>Yes</td>
|
||||
<td>Company name printed on the cover. Defaults to
|
||||
<code>${pom.organization.name}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.projectName</td>
|
||||
<td>Yes</td>
|
||||
<td>Project name .Defaults to
|
||||
<code>${pom.name}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.type</td>
|
||||
<td>Yes</td>
|
||||
<td>Type of documentation. Defaults to
|
||||
<code>Project Documentation</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.version</td>
|
||||
<td>Yes</td>
|
||||
<td>Project/Document version printed on the cover. Defaults
|
||||
to <code>${pom.currentVersion}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.pdf.cover.date</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to current day.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.organization.url}${pom.organization.logo}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.cover.projectCompany</td>
|
||||
<td>Company name printed on the cover.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.organization.name}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.cover.projectName</td>
|
||||
<td>Project name .</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.name}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.cover.type</td>
|
||||
<td>Type of documentation. </td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>Project Documentation</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.cover.version</td>
|
||||
<td>Project/Document version printed on the cover.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.currentVersion}</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.cover.date</td>
|
||||
<td>Defaults to current day.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>Empty.</code> The build date is used.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
<subsection name="Project parameters">
|
||||
<table>
|
||||
<tr>
|
||||
<th width="25%">Property name</th>
|
||||
<th>Description</th>
|
||||
<th width="10%">Optional?</th>
|
||||
<th>Default value</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.docs.src</td>
|
||||
<td>The source directory for the
|
||||
<code>${maven.pdf.navigationFile}</code> file and the user
|
||||
xml documentations files.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${basedir}/xdocs</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.docs.dest</td>
|
||||
<td>The destination directory for PDF documentation. Images
|
||||
are also retreived from this directory.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${maven.build.dir}/docs/</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.gen.docs</td>
|
||||
<td>The directory for generated xdocs used to create the pdf document.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${maven.build.dir}/generated-xdocs/</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.pdfName</td>
|
||||
<td>The name of the generated pdf file.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>${pom.artifactId}.pdf</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
<subsection name="Technical parameters">
|
||||
<table>
|
||||
<tr>
|
||||
<th width="25%">Property name</th>
|
||||
<th>Description</th>
|
||||
<th width="10%">Optional?</th>
|
||||
<th>Default value</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="25%">maven.pdf.debug</td>
|
||||
<td>Debug the pdf generation process.</td>
|
||||
<td width="10%">Yes</td>
|
||||
<td>
|
||||
<code>false</code>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
||||
Reference in New Issue
Block a user