From b05adefb081762649497f4d2e0c354756ae2bfa5 Mon Sep 17 00:00:00 2001 From: evenisse Date: Mon, 26 Jan 2004 08:29:02 +0000 Subject: [PATCH] Documentations update git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114612 13f79535-47bb-0310-9956-ffa450edef68 --- pdf/xdocs/changes.xml | 53 +++++-------- pdf/xdocs/faq.fml | 15 ++++ pdf/xdocs/navigation.xml | 29 +++---- pdf/xdocs/properties.xml | 161 +++++++++++++++++++++++++++------------ 4 files changed, 162 insertions(+), 96 deletions(-) create mode 100644 pdf/xdocs/faq.fml diff --git a/pdf/xdocs/changes.xml b/pdf/xdocs/changes.xml index 273a874e..49056b78 100644 --- a/pdf/xdocs/changes.xml +++ b/pdf/xdocs/changes.xml @@ -1,36 +1,23 @@ - - Changes - dIon Gillard - - - - - - 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. - - - - update to use maven.docs.*/maven.gen.docs - - - - - Upgraded to xerces 2.3.0, xalan 2.4.1 and fop 0.20.5rc2 - - - Added more documentation - - - Fix plugin and fo stylesheet to get plugin working again - - - Added table support. - - - + + Changes + dIon Gillard + + + + 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. + The use of links inside xdocs don't lead to crash the PDF generation. + 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. + + + update to use maven.docs.*/maven.gen.docs + + + Upgraded to xerces 2.3.0, xalan 2.4.1 and fop 0.20.5rc2 + Added more documentation + Fix plugin and fo stylesheet to get plugin working again + Added table support. + + - diff --git a/pdf/xdocs/faq.fml b/pdf/xdocs/faq.fml new file mode 100644 index 00000000..64053423 --- /dev/null +++ b/pdf/xdocs/faq.fml @@ -0,0 +1,15 @@ + + + + Plugin Usage + + How do I use the PDF Plugin ? + +
    +
  • Firstly you must call the maven target site to generate all the xdocs files and the image ressources.
    • +
  • Then you can call the pdf target to generate the pdf documentation for your project.
    • +
+ + + + diff --git a/pdf/xdocs/navigation.xml b/pdf/xdocs/navigation.xml index 165f1b66..335682a9 100644 --- a/pdf/xdocs/navigation.xml +++ b/pdf/xdocs/navigation.xml @@ -1,17 +1,18 @@ - - Maven PDF Plugin - - - - - - - - - - - - + Maven PDF Plugin + + + + + + + + + + + + + + diff --git a/pdf/xdocs/properties.xml b/pdf/xdocs/properties.xml index 3372f5fc..c2f8076c 100644 --- a/pdf/xdocs/properties.xml +++ b/pdf/xdocs/properties.xml @@ -1,52 +1,115 @@ - - - Maven PDF Plugin Properties - dIon Gillard - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Property nameOptional?Description
maven.docs.srcYes - The source directory for your navigation.xml. - Defaults to ${basedir}/xdocs. -
maven.docs.destYes - The destination directory for documentation. Defaults to - ${maven.build.dir}/docs/ -
maven.docs.outputencodingYes - The output encoding of the generated documentation - Defaults to ISO-8859-1. -
maven.gen.docsYes - The directory for generated xdocs. Defaults to - ${maven.build.dir}/generated-xdocs/ -
-
- + + Maven PDF Plugin Properties + dIon Gillard + + +
+

This properties are used by the plugin and can be redifned by the user.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property nameOptional?Description
maven.docs.srcYesThe source directory for the ${maven.pdf.navigationFile} file and the user xml documentations files. Defaults to ${basedir}/xdocs.
maven.docs.destYesThe destination directory for PDF documentation. Images are copied fom this directory. Defaults to ${maven.build.dir}/docs/.
maven.docs.outputencodingYesThe output encoding of the generated documentation. Defaults to ISO-8859-1.
maven.gen.docsYesThe directory for generated xdocs. Defaults to ${maven.build.dir}/generated-xdocs/.
maven.pdf.confidentialYesUsage not yet implemented. Defaults to false.
maven.pdf.paperTypeYesPaper type for the generated PDF file. Defaults to A4.
maven.pdf.companyNameYesDefaults to ${pom.organization.name}.
maven.pdf.companyIncNameYesDefaults to ${pom.organization.name}.
maven.pdf.copyrightYearYesDefaults to ${pom.inceptionYear}.
maven.pdf.imageDpiYesDefaults to 150.
maven.pdf.debugYesDebug pdf generation process. Defaults to false.
maven.pdf.navigationFileYesFilename for the navigation file used to generate the PDF. Defaults to navigation.xml.
maven.pdf.cover.projectCompanyYesUsage not yet implemented.Defaults to ${pom.organization.name}.
maven.pdf.cover.projectNameYesUsage not yet implemented.Defaults to ${pom.name}.
maven.pdf.cover.typeYesUsage not yet implemented.Defaults to Project Documentation.
maven.pdf.cover.versionYesUsage not yet implemented.Defaults to ${pom.currentVersion}.
maven.pdf.cover.dateYesUsage not yet implemented.Defaults to June 2, 2003.
maven.pdf.projectLogoYesUsage not yet implemented.Defaults to ${pom.url}${pom.logo}.
maven.pdf.companyLogoYesUsage not yet implemented.Defaults to ${pom.organization.url}${pom.organization.logo} +
+
+