PR: MPPDF-10

Submitted By:	M. Sean Gilligan
Reviewed By:	Arnaud Heritier
Add USLetter (8.5"x11") as a paperType


git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115479 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier committed 2004-06-13 22:56:55 +00:00
1 parent 5ff4d9185d
commit 26e6e261a6
4 files changed
+196 -194

No files matched your search

+1 -3
View File
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
@@ -17,7 +16,6 @@
* limitations under the License.
*/
-->
<project>
<extend>${basedir}/../plugin-parent/project.xml</extend>
<pomVersion>3</pomVersion>
@@ -25,7 +23,7 @@
<artifactId>maven-pdf-plugin</artifactId>
<id>maven-pdf-plugin</id>
<name>Maven PDF Plug-in</name>
<currentVersion>2.1</currentVersion>
<currentVersion>2.2-SNAPSHOT</currentVersion>
<description>PDF Documentation generator</description>
<shortDescription>Generator of project documentation in PDF Format.</shortDescription>
<url>http://maven.apache.org/reference/plugins/pdf/</url>
+2
View File
@@ -22,6 +22,7 @@
<xsl:variable name="pageWidth">
<xsl:choose>
<xsl:when test="$paperType = 'US'">8.5</xsl:when>
<xsl:when test="$paperType = 'USLetter'">8.5</xsl:when>
<xsl:when test="$paperType = 'A4'">8.25</xsl:when>
<xsl:otherwise>8.5</xsl:otherwise>
</xsl:choose>
@@ -30,6 +31,7 @@
<xsl:variable name="pageHeight">
<xsl:choose>
<xsl:when test="$paperType = 'US'">14</xsl:when>
<xsl:when test="$paperType = 'USLetter'">11</xsl:when>
<xsl:when test="$paperType = 'A4'">11.70</xsl:when>
<xsl:otherwise>14</xsl:otherwise>
</xsl:choose>
+3 -2
View File
@@ -1,5 +1,4 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
@@ -17,13 +16,15 @@
* limitations under the License.
*/
-->
<document>
<properties>
<title>Changes</title>
<author email="dion@apache.org">dIon Gillard</author>
</properties>
<body>
<release version="2.2-SNAPSHOT" date="In CVS">
<action dev="aheritier" type="add" issue="MPPDF-10" due-to="M. Sean Gilligan">Add USLetter (8.5"x11") as a paper type.</action>
</release>
<release version="2.1" date="2004-05-15">
<action dev="brett" type="fix">
<p>Add xml-apis and xalan dependencies for JDK 1.3.</p>
+190 -189
View File
@@ -16,203 +16,204 @@
* limitations under the License.
*/
-->
<document>
<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 redefined by
<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 redefined by
the user.</p>
<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 :
<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
<li>
<code>A4</code> : 8.25in x 11.70in</li>
<li>
<code>US</code> : 8.5in x 14in</li>
<li>
<code>USLetter</code> : 8.5in x 11in</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 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>
<td width="10%">Yes</td>
<td>
<code>${pom.organization.url}${pom.organization.logo}</code>
<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>
<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
</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
<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>
<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>