Apply MPPDF-4
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114665 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
dion committed
1 parent
78f1aafd8b
commit
13f3df14f9
5 files changed
+63
-63
No files matched your search
@@ -12,7 +12,6 @@
|
||||
<j:set var="docsToc" value="${pom.getPluginContext('maven-xdoc-plugin').getVariable('maven.docs.src')}/${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.navigationFile')}"/>
|
||||
<j:set var="confidential" value="${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.confidential')}"/>
|
||||
<j:set var="paperType" value="${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.paperType')}"/>
|
||||
<j:set var="companyName" value="${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.companyName')}"/>
|
||||
<j:set var="companyIncName" value="${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.companyIncName')}"/>
|
||||
<j:set var="publicationYear" value="${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.copyrightYear')}"/>
|
||||
<j:set var="coverProjectCompany" value="${pom.getPluginContext('maven-pdf-plugin').getVariable('maven.pdf.cover.projectCompany')}"/>
|
||||
@@ -58,7 +57,6 @@
|
||||
<param name="basePath" expression="${docsPdf}"/>
|
||||
<param name="confidential" expression="${confidential}"/>
|
||||
<param name="paperType" expression="${paperType}"/>
|
||||
<param name="companyName" expression="${companyName}"/>
|
||||
<param name="companyIncName" expression="${companyIncName}"/>
|
||||
<param name="publicationYear" expression="${publicationYear}"/>
|
||||
<param name="coverProjectCompany" expression="${coverProjectCompany}"/>
|
||||
|
||||
@@ -5,7 +5,6 @@
|
||||
# -------------------------------------------------------------------
|
||||
maven.pdf.confidential=false
|
||||
maven.pdf.paperType=A4
|
||||
maven.pdf.companyName=${pom.organization.name}
|
||||
maven.pdf.companyIncName=${pom.organization.name}
|
||||
maven.pdf.copyrightYear=${pom.inceptionYear}
|
||||
maven.pdf.imageDpi=150
|
||||
|
||||
@@ -8,7 +8,6 @@
|
||||
<xsl:include href="fo-table-column-widths.xslt"/>
|
||||
<xsl:param name="basePath">.</xsl:param>
|
||||
<xsl:param name="paperType">US</xsl:param>
|
||||
<xsl:param name="companyName">The Jakarta Project</xsl:param>
|
||||
<xsl:param name="companyIncName">Apache Software Foundation, Inc.</xsl:param>
|
||||
<xsl:param name="confidential">false</xsl:param>
|
||||
<xsl:param name="publicationYear">2003</xsl:param>
|
||||
|
||||
+13
-24
@@ -1,28 +1,17 @@
|
||||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Maven PDF Plug-in</title>
|
||||
<author email="jason@zenplex.com">Jason van Zyl</author>
|
||||
<author email="dion@apache.org">dIon Gillard</author>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Maven PDF Plug-in">
|
||||
<p>
|
||||
This plug-in allows you to generate a PDF version of your project's
|
||||
documentation.
|
||||
</p>
|
||||
<p>
|
||||
There is a known problem with the PDF generation tool (Apache's FOP)
|
||||
<properties>
|
||||
<title>Maven PDF Plug-in</title>
|
||||
<author email="jason@zenplex.com">Jason van Zyl</author>
|
||||
<author email="dion@apache.org">dIon Gillard</author>
|
||||
</properties>
|
||||
<body>
|
||||
<section name="Maven PDF Plug-in">
|
||||
<p>This plug-in allows you to generate a PDF version of your project's
|
||||
documentation.</p>
|
||||
<p>There is a known problem with the PDF generation tool (Apache's FOP)
|
||||
in that it doesn't allow for table structures with automatic column
|
||||
widths to be generated. This means that currently, documents with
|
||||
tables will be missing content.
|
||||
</p>
|
||||
<p>
|
||||
Another issue is that the documentation is only the top level of
|
||||
the documentation generated.
|
||||
</p>
|
||||
</section>
|
||||
</body>
|
||||
widths to be generated. Widths are uniformly distributed.</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
+50
-35
@@ -6,7 +6,8 @@
|
||||
</properties>
|
||||
<body>
|
||||
<section name="Maven PDF Plugin Settings">
|
||||
<p>This properties are used by the plugin and can be redifned by the user.</p>
|
||||
<p>This properties are used by the plugin and can be redifned by
|
||||
the user.</p>
|
||||
<table>
|
||||
<tr>
|
||||
<th>Property name</th>
|
||||
@@ -16,104 +17,118 @@
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>Usage <b>not yet implemented.</b> Defaults to <code>false</code>.</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.companyName</td>
|
||||
<td>Yes</td>
|
||||
<td>Defaults to <code>${pom.organization.name}</code>.</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>Defaults to <code>${pom.organization.name}</code>.</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.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>
|
||||
<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>
|
||||
</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>
|
||||
<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>Usage <b>not yet implemented.</b>Defaults to <code>${pom.name}</code>.</td>
|
||||
<td>Project name .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>
|
||||
<td>Type of documentation. 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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
Reference in new issue
Block a user