evenisse 2004/01/26 00:29:02 Modified: pdf/xdocs changes.xml navigation.xml properties.xml Added: pdf/xdocs faq.fml Log: Documentations update Revision Changes Path 1.7 +20 -33 maven-plugins/pdf/xdocs/changes.xml Index: changes.xml =================================================================== RCS file: /home/cvs/maven-plugins/pdf/xdocs/changes.xml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- changes.xml 15 Jan 2004 13:56:34 -0000 1.6 +++ changes.xml 26 Jan 2004 08:29:02 -0000 1.7 @@ -1,36 +1,23 @@ <?xml version="1.0"?> <document> - <properties> - <title>Changes</title> - <author email="[EMAIL PROTECTED]">dIon Gillard</author> - </properties> - - <body> - <release version="2.0" date="In CVS"> - <action dev="evenisse" type="update"> - MAVEN-MPPDF-1. Completely re-writte of the PDF plug-in. It solves most of the thorniest - issues, such as table formatting, more levels in the table of contents, - and image sizing. The graphic design is also dramatically improved. - </action> - </release> - <release version="1.2" date="2003-09-29"> - <action dev="dion" type="update">update to use maven.docs.*/maven.gen.docs</action> - </release> - - <release version="1.1" date="Unknown"> - <action dev="dion" type="add"> - Upgraded to xerces 2.3.0, xalan 2.4.1 and fop 0.20.5rc2 - </action> - <action dev="dion" type="add"> - Added more documentation - </action> - <action dev="dion" type="add"> - Fix plugin and fo stylesheet to get plugin working again - </action> - <action dev="evenisse" type="add" due-to="Kai Runte"> - Added table support. - </action> - </release> - </body> + <properties> + <title>Changes</title> + <author email="[EMAIL PROTECTED]">dIon Gillard</author> + </properties> + <body> + <release version="2.0" date="In CVS" description="Beta Release."> + <action dev="evenisse" type="fix" issue="MPPDF-3">A new plugin property (maven.pdf.navigationFile) is added to allow the users to have a different navigation file for the site and for the pdf doc.</action> + <action dev="evenisse" type="fix" issue="MPPDF-2">The use of links inside xdocs don't lead to crash the PDF generation.</action> + <action dev="evenisse" type="update" issue="MPPDF-1">MAVEN-MPPDF-1. Completely re-writte of the PDF plug-in. It solves most of the thorniest issues, such as table formatting, more levels in the table of contents, and image sizing. The graphic design is also dramatically improved.</action> + </release> + <release version="1.2" date="2003-09-29"> + <action dev="dion" type="update">update to use maven.docs.*/maven.gen.docs</action> + </release> + <release version="1.1" date="Unknown"> + <action dev="dion" type="add">Upgraded to xerces 2.3.0, xalan 2.4.1 and fop 0.20.5rc2</action> + <action dev="dion" type="add">Added more documentation</action> + <action dev="dion" type="add">Fix plugin and fo stylesheet to get plugin working again</action> + <action dev="evenisse" type="add" due-to="Kai Runte">Added table support.</action> + </release> + </body> </document> - 1.3 +15 -14 maven-plugins/pdf/xdocs/navigation.xml Index: navigation.xml =================================================================== RCS file: /home/cvs/maven-plugins/pdf/xdocs/navigation.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- navigation.xml 19 Mar 2003 05:54:17 -0000 1.2 +++ navigation.xml 26 Jan 2004 08:29:02 -0000 1.3 @@ -1,17 +1,18 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <project name="Maven PDF Plugin"> - - <title>Maven PDF Plugin</title> - - <body> - <links> - <item name="Maven" href="http://maven.apache.org/"/> - <item name="FOP" href="http://xml.apache.org/fop/"/> - </links> - <menu name="Overview"> - <item name="Goals" href="/goals.html" /> - <item name="Properties" href="/properties.html" /> - <item name="Changes" href="/changes.html" /> - </menu> - </body> + <title>Maven PDF Plugin</title> + <body> + <links> + <item name="Maven" href="http://maven.apache.org/"/> + <item name="FOP" href="http://xml.apache.org/fop/"/> + <item name="PDF Documentation" href="/project.pdf"/> + </links> + <menu name="Overview"> + <item name="Goals" href="/goals.html"/> + <item name="Properties" href="/properties.html"/> + <item name="Changes" href="/changes-report.html"/> + <item name="FAQ" href="/faq.html"/> + <item name="Dependencies" href="/dependencies.html"/> + </menu> + </body> </project> 1.2 +112 -49 maven-plugins/pdf/xdocs/properties.xml Index: properties.xml =================================================================== RCS file: /home/cvs/maven-plugins/pdf/xdocs/properties.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- properties.xml 24 Jan 2003 03:45:47 -0000 1.1 +++ properties.xml 26 Jan 2004 08:29:02 -0000 1.2 @@ -1,52 +1,115 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <document> - - <properties> - <title>Maven PDF Plugin Properties</title> - <author email="[EMAIL PROTECTED]">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="[EMAIL PROTECTED]">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> 1.1 maven-plugins/pdf/xdocs/faq.fml Index: faq.fml =================================================================== <?xml version="1.0" encoding="UTF-8"?> <faqs title="Frequently Asked Questions"> <part id="usage"> <title>Plugin Usage</title> <faq id="how-use"> <question>How do I use the PDF Plugin ?</question> <answer> <ul> <li>Firstly you must call the maven target <code>site</code> to generate all the xdocs files and the image ressources.</li> <li>Then you can call the <code>pdf</code> target to generate the pdf documentation for your project.</li> </ul> </answer> </faq> </part> </faqs>
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
