dion 2004/02/02 16:41:30
Modified: pdf/xdocs properties.xml index.xml
pdf plugin.properties plugin.jelly
pdf/src/plugin-resources project2fo.xslt
Log:
Apply MPPDF-4
Revision Changes Path
1.6 +48 -33 maven-plugins/pdf/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/pdf/xdocs/properties.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- properties.xml 27 Jan 2004 17:24:29 -0000 1.5
+++ properties.xml 3 Feb 2004 00:41:30 -0000 1.6
@@ -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,47 +17,53 @@
<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>
@@ -64,55 +71,63 @@
<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>maven.pdf.navigationFile</td>
<td>Yes</td>
- <td>Debug pdf generation process. Defaults to
<code>false</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.navigationFile</td>
+ <td>maven.pdf.projectLogo</td>
<td>Yes</td>
- <td>Filename for the navigation file used to generate the PDF.
Defaults to <code>navigation.xml</code>.</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>
1.2 +13 -24 maven-plugins/pdf/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/pdf/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 24 Jan 2003 03:45:47 -0000 1.1
+++ index.xml 3 Feb 2004 00:41:30 -0000 1.2
@@ -1,28 +1,17 @@
<?xml version="1.0"?>
<document>
-
- <properties>
- <title>Maven PDF Plug-in</title>
- <author email="[EMAIL PROTECTED]">Jason van Zyl</author>
- <author email="[EMAIL PROTECTED]">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="[EMAIL PROTECTED]">Jason van Zyl</author>
+ <author email="[EMAIL PROTECTED]">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>
1.9 +0 -1 maven-plugins/pdf/plugin.properties
Index: plugin.properties
===================================================================
RCS file: /home/cvs/maven-plugins/pdf/plugin.properties,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- plugin.properties 27 Jan 2004 17:24:29 -0000 1.8
+++ plugin.properties 3 Feb 2004 00:41:30 -0000 1.9
@@ -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
1.15 +0 -2 maven-plugins/pdf/plugin.jelly
Index: plugin.jelly
===================================================================
RCS file: /home/cvs/maven-plugins/pdf/plugin.jelly,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- plugin.jelly 27 Jan 2004 14:48:59 -0000 1.14
+++ plugin.jelly 3 Feb 2004 00:41:30 -0000 1.15
@@ -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}"/>
1.8 +0 -1 maven-plugins/pdf/src/plugin-resources/project2fo.xslt
Index: project2fo.xslt
===================================================================
RCS file: /home/cvs/maven-plugins/pdf/src/plugin-resources/project2fo.xslt,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- project2fo.xslt 26 Jan 2004 05:55:44 -0000 1.7
+++ project2fo.xslt 3 Feb 2004 00:41:30 -0000 1.8
@@ -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>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]