diff --git a/pdf/maven.xml b/pdf/maven.xml index 1d59b1f6..6051742e 100644 --- a/pdf/maven.xml +++ b/pdf/maven.xml @@ -1,8 +1,6 @@ - - + - - \ No newline at end of file + diff --git a/pdf/plugin.jelly b/pdf/plugin.jelly index 22ac551f..e5317505 100644 --- a/pdf/plugin.jelly +++ b/pdf/plugin.jelly @@ -1,9 +1,5 @@ - + @@ -20,7 +16,7 @@ - + @@ -28,7 +24,7 @@ - + @@ -37,7 +33,7 @@ - + diff --git a/pdf/plugin.properties b/pdf/plugin.properties index 2e701210..d894e4fa 100644 --- a/pdf/plugin.properties +++ b/pdf/plugin.properties @@ -7,7 +7,7 @@ maven.pdf.confidential=false maven.pdf.paperType=A4 maven.pdf.companyIncName=${pom.organization.name} maven.pdf.copyrightYear=${pom.inceptionYear} -maven.pdf.imageDpi=150 +maven.pdf.imageDpi=72 maven.pdf.debug=false maven.pdf.navigationFile=navigation.xml maven.pdf.pdfName=${pom.artifactId}.pdf @@ -15,6 +15,6 @@ maven.pdf.cover.projectCompany=${pom.organization.name} maven.pdf.cover.projectName=${pom.name} maven.pdf.cover.type=Project Documentation maven.pdf.cover.version=${pom.currentVersion} -#maven.pdf.cover.date=June 2, 2003 +#maven.pdf.cover.date=Not defined by default maven.pdf.projectLogo=${pom.logo} maven.pdf.companyLogo=${pom.organization.logo} diff --git a/pdf/project.properties b/pdf/project.properties index d1e77395..66ca8920 100644 --- a/pdf/project.properties +++ b/pdf/project.properties @@ -5,5 +5,5 @@ maven.xdoc.date=left maven.xdoc.version=${pom.currentVersion} maven.license.licenseFile=${basedir}/../../../LICENSE.txt -maven.pdf.projectLogo=http://maven.apache.org/images/maven.gif -maven.pdf.companyLogo=http://maven.apache.org/images/asf_logo_wide_clear.gif +maven.pdf.projectLogo=${maven.docs.src}/images/maven.gif +maven.pdf.companyLogo=${maven.docs.src}/images/asf_logo_wide_clear.gif \ No newline at end of file diff --git a/pdf/src/plugin-resources/fo-body.xslt b/pdf/src/plugin-resources/fo-body.xslt index 980dc0a7..a0bc8ed9 100644 --- a/pdf/src/plugin-resources/fo-body.xslt +++ b/pdf/src/plugin-resources/fo-body.xslt @@ -1,153 +1,5 @@ - - - - Garamond,serif - - - Helvetica,sans-serif - #000000 - always - - - monospace - - - - 11pt - 12pt - true - - - 10pt - - - 8pt - wrap - false - black - dotted - 0.5pt - - 1.0em - 1.25em - 0.75em - 0.75em - inherited-property-value(start-indent) + 2.5em - inherited-property-value(end-indent) + 3em - 0.75em - 1em - - - Helvetica,sans-serif - 9.0pt - - - 16pt - bold - - - 12pt - bold - 18pt - 6pt - - - 9.5pt - bold - 18pt - 5pt - - - 9.5pt - 15pt - 3pt - - - 9.5pt - 9pt - 3pt - - - 9.5pt - italic - 3pt - - - - 10pt - 6pt - - - 100% - dots - 1pt - - - - - 9.5pt - - 10pt - right - - - - 2pt - Helvetica,sans-serif - 6pt - - - - 2pt - Helvetica,sans-serif - 6pt - - left - - - Helvetica,sans-serif - 9.5pt - right - black - - - - blue - - - - 3pt - 6pt - - - - inherited-property-value(start-indent) - 1em - 1em - - - - inherited-property-value(start-indent) + .5em - 0.15em - 0.25em - - - 1em - 1em - - - 1em - 1em - - - 1em - 1em - 0.6em - 0.6em - @@ -346,7 +198,7 @@ - + @@ -358,7 +210,7 @@ - + @@ -370,7 +222,7 @@ - + diff --git a/pdf/src/plugin-resources/fo-cover.xslt b/pdf/src/plugin-resources/fo-cover.xslt index d21f6bf8..390bbf65 100644 --- a/pdf/src/plugin-resources/fo-cover.xslt +++ b/pdf/src/plugin-resources/fo-cover.xslt @@ -1,81 +1,117 @@ - - - Helvetica,sans-serif - #000000 - always - 16pt - bold - - - Helvetica,sans-serif - #000000 - always - 12pt - bold - - - 100% - rule - 0.5pt - black - + + + + 0.5 + 0.3 + 0.014 + - - - + + - + - - + + + + + + + + + + + + + + + - - - - - + + + + + + + + + + + + + + + - - - - + + + + - + - + + + + + + + + + + + + + + + + + + v. + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - v. - - - - - - - - - - - - - + + diff --git a/pdf/src/plugin-resources/fo-layouts.xslt b/pdf/src/plugin-resources/fo-layouts.xslt index 4e184910..dee226a4 100644 --- a/pdf/src/plugin-resources/fo-layouts.xslt +++ b/pdf/src/plugin-resources/fo-layouts.xslt @@ -9,28 +9,41 @@ - 11 + + + 14 + 11.70 + 14 + + + + 1 - + + 0.625 + 0.6 + + 0.7 + 0.8 - - + + - + - + - + - + diff --git a/pdf/src/plugin-resources/fo-styles.xslt b/pdf/src/plugin-resources/fo-styles.xslt new file mode 100644 index 00000000..114471a5 --- /dev/null +++ b/pdf/src/plugin-resources/fo-styles.xslt @@ -0,0 +1,344 @@ + + + + + + Garamond,serif + + + Helvetica,sans-serif + #000000 + always + + + monospace + + + + 11pt + 12pt + true + + + 10pt + + + 8pt + wrap + false + black + dotted + 0.5pt + + 1.0em + 1.25em + 0.75em + 0.75em + inherited-property-value(start-indent) + 2.5em + inherited-property-value(end-indent) + 3em + 0.75em + 1em + + + Helvetica,sans-serif + 9.0pt + + + 16pt + bold + + + 12pt + bold + 18pt + 6pt + + + 9.5pt + bold + 18pt + 5pt + + + 9.5pt + 15pt + 3pt + + + 9.5pt + 9pt + 3pt + + + 9.5pt + italic + 3pt + + + + 10pt + 6pt + + + 100% + dots + 1pt + + + + + 9.5pt + + 10pt + right + + + + 2pt + Helvetica,sans-serif + 6pt + + + + 2pt + Helvetica,sans-serif + 6pt + + left + + + Helvetica,sans-serif + 9.5pt + right + black + + + + blue + + + green + + + + 3pt + 6pt + + + + inherited-property-value(start-indent) + 1em + 1em + + + + inherited-property-value(start-indent) + .5em + 0.15em + 0.25em + + + 1em + 1em + + + 1em + 1em + + + 1em + 1em + 0.6em + 0.6em + + + + 8pt + bold + red + solid + 0.5pt + red + 0.75em + inherited-property-value(start-indent) + 2.5em + inherited-property-value(end-indent) + 3em + + + + Helvetica,sans-serif + #000000 + always + 16pt + bold + + + Helvetica,sans-serif + #000000 + always + 12pt + bold + + + 0.2in + dotted + 0.1pt + #000000 + + + 0.2in + dotted + 0.1pt + #000000 + + + + 100% + rule + 0.5pt + black + + + 2.5pt + 5pt + + + Helvetica,sans-serif + 1.2em + + + + 9pt + 12pt + + + always + always + + + solid + 0.5pt + black + + + 9.5pt + bold + + + 5pt + + + 7pt + italic + + + 7pt + after + + + 8pt + bold + + + 100% + rule + 0.5pt + black + + + 6pt + + + 7pt + italic + + + always + always + + + 1pt + + solid + 2.5pt + + after + + + 7pt + bold + bottom + + + always + always + + + 100% + rule + 1pt + white + + + 100% + dots + 0.5pt + + + + 100% + rule + 0.5pt + black + + + + 4pt + 1.5pt + + + 7pt + + + 7pt + + + + after + + + Helvetica,sans-serif + 16pt + start + no-wrap + + + dots + 5pt + + + + 9.5pt + end + + 16pt + 6pt + + + 12pt + bold + 18pt + + + 9.5pt + 15pt + 3pt + + + 9.5pt + 4pt + + + 9.5pt + 4pt + + diff --git a/pdf/src/plugin-resources/fo-tables.xslt b/pdf/src/plugin-resources/fo-tables.xslt index d79f8181..ef99d3ab 100644 --- a/pdf/src/plugin-resources/fo-tables.xslt +++ b/pdf/src/plugin-resources/fo-tables.xslt @@ -1,322 +1,7 @@ - - - - 2.5pt - 5pt - - - Helvetica,sans-serif - 1.2em - - - - - 9pt - 12pt - - - always - always - - - solid - 0.5pt - black - - - 9.5pt - bold - - - 5pt - - - 7pt - italic - - - 7pt - after - - - 7pt - - - - 100% - rule - - 0.5pt - black - - - 6pt - - - 7pt - italic - - - always - always - - - 1pt - - solid - 2.5pt - - after - - - 7pt - bold - bottom - - - always - always - - - 100% - rule - 1pt - white - - - 100% - dots - 0.5pt - - - - 100% - rule - 0.5pt - black - - - - 4pt - 1.5pt - - - 7pt - - - 7pt - - - - - - 1 - 1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - :::::: New table :::::: - - - - - - - - This table has a @title, so add a row for it - - - - - - - - - - - - - - This table has a caption, so add a row for it - - - - - - - - - - - - - - - - - - - - - - ::: Subheading row ::: - - - - - - - 1 - - - ::: Table body row ( columns) ::: - - - - - ::: Table row spacer for last row ::: - - - - Ending border (solid rule) - - - - - - - 1 - - - - - ::: Table body row ( columns) ::: - - - - - ::: Table row spacer for row ::: - - - - - - - Spacer only - - - - - Regular border (rule) - - - - - Ending border (rule) - - - - - - - - - : Table subheading cell : - - - - - - - - - : Table body cell : - - - - - - - - - - - - - - - - - - + 1 @@ -355,15 +40,15 @@ - + 1 :::::: New table :::::: + + + --> @@ -378,7 +63,7 @@ - + @@ -395,93 +80,124 @@ - - - + - + + + + 1 + 1 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 - - - - Table heading bottom spacer - - - - - - - + :::::: New table :::::: + + + + + + + + This table has a @title, so add a row for it + + + + + + + + + + + + + + Table heading bottom spacer + + + + + + + + + + + + + + This table has a caption, so add a row for it + + + + + + + + + + + + + + + + + - - ::: Table heading row ::: - - - - - - - : Table heading cell : - - - solid - 0.75pt - black - - - - - - - - - ::: Subheading row ::: - - - - - - + + 1 - - - ::: Table body row ( columns) ::: - - - - - ::: Table row spacer for last row ::: - - - - Ending border (solid rule) - - - - - - - 1 - - + + --> ::: Table body row ( columns) ::: - + ::: Table row spacer for row ::: @@ -521,46 +237,111 @@ - + + + ::: Subheading row ::: + + + + + + + + 1 + + + ::: Table body row ( columns) ::: + + + + + ::: Table row spacer for last row ::: + + + + Ending border (solid rule) + + + + + + + + 1 + + + + Table heading bottom spacer + + + + + + + + + + + ::: Table heading row ::: + + + + + + + : Table subheading cell : - + + - + + + : Table heading cell : + + + solid + 0.75pt + black + + + + + + + + + : Table body cell : - - + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/pdf/src/plugin-resources/fo-toc.xslt b/pdf/src/plugin-resources/fo-toc.xslt index 25c1384e..61b57476 100644 --- a/pdf/src/plugin-resources/fo-toc.xslt +++ b/pdf/src/plugin-resources/fo-toc.xslt @@ -1,46 +1,5 @@ - - - after - - - Helvetica,sans-serif - 16pt - start - no-wrap - - - dots - 5pt - - - - 9.5pt - end - - 16pt - 6pt - - - 12pt - bold - 18pt - - - 9.5pt - 15pt - 3pt - - - 9.5pt - 4pt - - - 9.5pt - 4pt - diff --git a/pdf/src/plugin-resources/project2fo.xslt b/pdf/src/plugin-resources/project2fo.xslt index ef4bd30e..3ade26c3 100644 --- a/pdf/src/plugin-resources/project2fo.xslt +++ b/pdf/src/plugin-resources/project2fo.xslt @@ -1,5 +1,6 @@ + @@ -24,29 +25,13 @@ abcdefghijklmnopqrstuvwxyz ABCDEFGHIJKLMNOPQRSTUVWXYZ © - • All rights reserved - - • Proprietary and Confidential - + • All rights reserved• Proprietary and Confidential #454545 #A9A9A9 #D3D3D3 - #4b4542 - - - 8pt - bold - red - solid - 0.5pt - red - 0.75em - inherited-property-value(start-indent) + 2.5em - inherited-property-value(end-indent) + 3em - @@ -58,9 +43,7 @@ - - @@ -110,51 +93,64 @@ - - - - - - Creating XSL:FO for - - - - - - + + + + + / + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - + + + + + + + Creating XSL:FO for + + - - - - + + + + - - - - - + + + + + diff --git a/pdf/xdocs/changes.xml b/pdf/xdocs/changes.xml index 49056b78..d92db2ec 100644 --- a/pdf/xdocs/changes.xml +++ b/pdf/xdocs/changes.xml @@ -6,9 +6,16 @@ - 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. + Upgraded to xerces 2.4.0, fop 0.20.5, batik 1.5 + 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-write 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 diff --git a/pdf/xdocs/faq.fml b/pdf/xdocs/faq.fml index 64053423..dda11482 100644 --- a/pdf/xdocs/faq.fml +++ b/pdf/xdocs/faq.fml @@ -11,5 +11,76 @@ + + Which types of images can I use in my documents ? + +

You can use images types that FOP can use.

+

The table below summarizes the theoretical support for graphical formats within FOP.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FormatTypeSupport Thru
+ BMP (Microsoft Windows Bitmap)bitmap + FOP native +
+ EPS (Encapsulated PostScript)metafile (both bitmap and vector), probably most frequently used for vector drawings + FOP native (limited support, see restrictions below)
GIF (Graphics Interchange Format)bitmap + FOP native +
+ JPEG (Joint Photographic Experts Group)bitmap + FOP native +
+ PNG (Portable Network Graphic)bitmap + JIMI or JAI +
+ SVG (Scalable Vector Graphics)vector (with embedded bitmaps) + Batik +
+ TIFF (Tag Image Format File)bitmap + FOP native or JAI, depending on the subformat. See TIFF for more details.(JIMI also supports TIFF, but this has not been implemented within FOP).
+ + diff --git a/pdf/xdocs/goals.xml b/pdf/xdocs/goals.xml index 570d1e52..30488462 100644 --- a/pdf/xdocs/goals.xml +++ b/pdf/xdocs/goals.xml @@ -1,45 +1,46 @@ - - - Maven Ant Plug-in Goals - dIon Gillard - - - -
- - - - - +
GoalDescription
fo + + Maven Ant Plug-in Goals + dIon Gillard + + +
+ + + + + + + + - - - - + + + - - - - + + + - - - - + + + - -
GoalDescription
fo This simply pre-requisites the fo:fo goal.
fo:fo +
fo:fo Generates an fo xml document from the navigation.xml file supplied as part of the documentation. Please note that as yet, no sanity check is done to make sure this file exists.
pdf +
pdf This is the default goal of the plugin and simply pre-requisites the pdf:pdf goal.
pdf:pdf +
pdf:pdf Generates a PDF document containing all project documentation. The PDF is generated from the .fo file generated in the fo:fo goal.
-
- +
+
+ diff --git a/pdf/xdocs/images/asf_logo_wide_clear.gif b/pdf/xdocs/images/asf_logo_wide_clear.gif new file mode 100644 index 00000000..aab499c7 Binary files /dev/null and b/pdf/xdocs/images/asf_logo_wide_clear.gif differ diff --git a/pdf/xdocs/images/maven.gif b/pdf/xdocs/images/maven.gif new file mode 100644 index 00000000..0ead880d Binary files /dev/null and b/pdf/xdocs/images/maven.gif differ diff --git a/pdf/xdocs/properties.xml b/pdf/xdocs/properties.xml index 49a16909..9a6972d6 100644 --- a/pdf/xdocs/properties.xml +++ b/pdf/xdocs/properties.xml @@ -8,128 +8,193 @@

This properties are used by the plugin and can be redefined 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 also copied from 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.pdfNameYesThe name of pdf file. Defaults to - ${pom.artifactId}.pdf.
maven.pdf.confidentialYesAdd a confidential text to the footer of each page. - Defaults to false.
maven.pdf.paperTypeYesPaper type for the generated PDF file. Defaults to - A4.
maven.pdf.companyIncNameYesThe company name printed on each page footer beside the copyrigths. - Defaults to ${pom.organization.name}.
maven.pdf.copyrightYearYesDefaults to ${pom.inceptionYear}.
maven.pdf.debugYesDebug the pdf generation process. Defaults to - false.
maven.pdf.imageDpiYesDefaults to 150.
maven.pdf.navigationFileYesFilename for the navigation file used to generate the - PDF. Defaults to navigation.xml.
maven.pdf.projectLogoYesProject logo URL (or relative path). Defaults to - ${pom.url}${pom.logo}.
maven.pdf.companyLogoYesCompany logo URL (or relative path). Defaults to - ${pom.organization.url}${pom.organization.logo} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - -
Property nameDescriptionOptional?Default value
maven.pdf.confidentialAdd a confidential text to the footer of each page.Yes + false +
maven.pdf.paperTypePaper type for the generated PDF file. Available formats are : +
    +
  • + A4 : 8.25in x 11.70in
    • +
  • + US : 8.5in x 14in
    • +
+ 		Yes + A4 +
maven.pdf.companyIncNameThe company name printed on each page footer beside the copyrigth.Yes + ${pom.organization.name} +
maven.pdf.copyrightYearThe year for the copyright.Yes + ${pom.inceptionYear} +
maven.pdf.imageDpiImages resolution.Yes + 75 +
maven.pdf.navigationFileFilename 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.Yes + navigation.xml +
maven.pdf.projectLogoProject logo URL (or relative path).Yes + ${pom.url}${pom.logo} +
maven.pdf.companyLogoCompany logo URL (or relative path).
maven.pdf.cover.projectCompanyYesCompany name printed on the cover. Defaults to - ${pom.organization.name}.
maven.pdf.cover.projectNameYesProject name .Defaults to - ${pom.name}.
maven.pdf.cover.typeYesType of documentation. Defaults to - Project Documentation.
maven.pdf.cover.versionYesProject/Document version printed on the cover. Defaults - to ${pom.currentVersion}.
maven.pdf.cover.dateYesDefaults to current day.
+ 		Yes + ${pom.organization.url}${pom.organization.logo} +
maven.pdf.cover.projectCompanyCompany name printed on the cover.Yes + ${pom.organization.name} +
maven.pdf.cover.projectNameProject name .Yes + ${pom.name} +
maven.pdf.cover.typeType of documentation. Yes + Project Documentation +
maven.pdf.cover.versionProject/Document version printed on the cover.Yes + ${pom.currentVersion} +
maven.pdf.cover.dateDefaults to current day.Yes + Empty. The build date is used. +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Property nameDescriptionOptional?Default value
maven.docs.srcThe source directory for the + ${maven.pdf.navigationFile} file and the user + xml documentations files.Yes + ${basedir}/xdocs +
maven.docs.destThe destination directory for PDF documentation. Images + are also retreived from this directory.Yes + ${maven.build.dir}/docs/ +
maven.gen.docsThe directory for generated xdocs used to create the pdf document.Yes + ${maven.build.dir}/generated-xdocs/ +
maven.pdf.pdfNameThe name of the generated pdf file.Yes + ${pom.artifactId}.pdf +
+ + + + + + + + + + + + + + + +
Property nameDescriptionOptional?Default value
maven.pdf.debugDebug the pdf generation process.Yes + false +
+