Return-Path: Delivered-To: apmail-forrest-site-svn-archive@minotaur.apache.org Received: (qmail 48820 invoked from network); 9 Jan 2011 11:51:08 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 9 Jan 2011 11:51:08 -0000 Received: (qmail 9225 invoked by uid 500); 9 Jan 2011 11:51:08 -0000 Delivered-To: apmail-forrest-site-svn-archive@forrest.apache.org Received: (qmail 9182 invoked by uid 500); 9 Jan 2011 11:51:07 -0000 Mailing-List: contact site-svn-help@forrest.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@forrest.apache.org Delivered-To: mailing list site-svn@forrest.apache.org Received: (qmail 9175 invoked by uid 99); 9 Jan 2011 11:51:07 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 09 Jan 2011 11:51:07 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 09 Jan 2011 11:51:04 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 204AC23888FD; Sun, 9 Jan 2011 11:50:44 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1056918 - in /forrest/site/pluginDocs/plugins_0_80: org.apache.forrest.plugin.input.glossary/images/ org.apache.forrest.plugin.output.pdf/ org.apache.forrest.plugin.output.pdf/images/ org.apache.forrest.plugin.output.pdf/skin/ org.apache.f... Date: Sun, 09 Jan 2011 11:50:43 -0000 To: site-svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20110109115044.204AC23888FD@eris.apache.org> Author: crossley Date: Sun Jan 9 11:50:43 2011 New Revision: 1056918 URL: http://svn.apache.org/viewvc?rev=1056918&view=rev Log: Deployment of docs for org.apache.forrest.plugin.output.pdf plugin (deployed by 'deploy-docs' target of plugin build script) Added: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/apache-thanks.png (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/built-with-cocoon.gif (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.pdf (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/index.pdf (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/linkmap.pdf (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/apache-thanks.png (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/built-with-cocoon.gif (with props) forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/todo.pdf (with props) Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.html forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.rss forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/images/project.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/index.html forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/linkmap.html forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/basic.css forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-b-l-15-1body-2menu-3menu.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-b-r-15-1body-2menu-3menu.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-r-15-1body-2menu-3menu.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/skin/screen.css forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/todo.html Added: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/apache-thanks.png URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/apache-thanks.png?rev=1056918&view=auto ============================================================================== Binary file - no diff available. Propchange: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/apache-thanks.png ------------------------------------------------------------------------------ svn:mime-type = image/png Added: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/built-with-cocoon.gif URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/built-with-cocoon.gif?rev=1056918&view=auto ============================================================================== Binary file - no diff available. Propchange: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.glossary/images/built-with-cocoon.gif ------------------------------------------------------------------------------ svn:mime-type = image/gif Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.html URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.html?rev=1056918&r1=1056917&r2=1056918&view=diff ============================================================================== --- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.html (original) +++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.output.pdf/changes.html Sun Jan 9 11:50:43 2011 @@ -49,10 +49,10 @@ +-->
+
+PDF -icon
+ PDF +
Font size:      

History of Changes

+

RSS

- +

Introduction and explanation of symbols

-

Changes are sorted by "type" and then chronologically with the most recent at the top. These symbols denote the various action types:add=add

+

Changes are sorted by "type" and then chronologically with the most recent at the top. These symbols denote the various action types:add=add, update=update

- -

Version 0.2-dev (not-released)

+ +

Version 0.3-dev (not-released)

- +

Changes to the Code Base

  • -add - Use locationmap for resolution of resources and files. Resources are exposed via - {lm:pdf.*} - Committed by RDG.
    • +update + Upgraded Apache FOP to version 0.95 and XML Graphics Commons to 1.3.1 + Committed by JM. +
  • +updateMade font family specifications available for + user changes without changing the plugin code. Committed by SNM.
    • +
  • +updateAdded support for "sub" and "sup" + tags. Committed by JM. See Issue FOR-1087.
    • +
  • +updateVarious bugfixes and improvements for the fo + stylesheets. See notes in FOR-1072. Committed by DC. Thanks to Jeremias Maerki. See Issue FOR-1072.
    • +
  • +updateEncapsulated the xsl methods in different + helper stylesheet which we can import from the different + plugins. Committed by TS.
    • +
  • +updateMoved all libraries and components used by + pdf-generation from core into this plugin. Committed by FSO.
    • +
  • +update Updating the fop-library to fop 0.94 and + upgrading the stylesheets to work properly with the new and more + precise fo-interpeter. Committed by FSO.
    • +
  • +update + Replaced Cocoon FOP Block with special Forrest edition + "cocoon-fop-ng-impl-special" compiled by jeremias. The sources are in + the jar. See r603892 and the thread + Re: Plans for integrating FOP .94 + Committed by FSO.
    • +
+ +

Changes to Documentation

+
    +
  • +updateUpdated plugin documentation to cover the new + properties settable by the user,and how to actually set + them. Committed by SNM.
- +

Contributors to this release

We thank the following people for their contributions to this release.

-

This is a list of all people who participated as committers:
(RDG).

+

This is a list of all people who participated as committers:
David Crossley (DC), Ferdinand Soethe (FSO), Jeremias Märki (JM), Sjur Nørstebø Moshagen (SNM), Thorsten Scherler (TS).

+

This is a list of other contributors:
Jeremias Maerki.

- -

Version 0.1 (not-released)

+ +

Version 0.2 (2007-04-11)

- + +

Changes to the Code Base

+
    +
  • +add Use locationmap for resolution of resources + and files. Resources are exposed via {lm:pdf.*} Committed by RDG.
    • +
+ +

Contributors to this release

+

We thank the following people for their contributions to this release.

+

This is a list of all people who participated as committers:
Ross Gardler (RDG).

+
+ + +

Version 0.1 (2004-11-17)

+
+

Changes to Project Administration

  • -add - Extracted code from core of Forrest and placed in a plugin - Committed by RDG.
    • +add Extracted code from core of Forrest and placed + in a plugin Committed by RDG.
- +

Contributors to this release

We thank the following people for their contributions to this release.

-

This is a list of all people who participated as committers:
(RDG).

+

This is a list of all people who participated as committers:
Ross Gardler (RDG).

+ +

All Committers

+
+

This is a list of all people who have ever participated + as committers on this project.

+
    +
  • Sjur Nørstebø Moshagen (SNM)
    • +
  • Ross Gardler (RDG)
    • +
  • Thorsten Scherler (TS)
    • +
  • Ferdinand Soethe (FSO)
    • +
  • David Crossley (DC)
    • +
  • Jeremias Märki (JM)
    • +
  • Volunteer needed (open)
    • +
+
+
+PDF -icon
+ PDF +
Font size:      

Welcome to the org.apache.forrest.plugin.output.pdf Plugin

+ - +

Apache Forrest - org.apache.forrest.plugin.output.pdf Plugin

- This plugin enables any Forrest page to be output as a PDF document. + This plugin (hereafter just called the PDF plugin) enables any + Forrest page to be output as a PDF document.

- To use it simply request a page with the pdf extension + To use it simply request a page with the pdf extension.

Note
@@ -149,6 +181,174 @@ document.write("Last Published: " + docu
+ + + +

Configuration options

+
+

The PDF plugin can be configured in several ways:

+
    + +
  • font family configuration
    • + + +
  • other presentation changes: page size, copyright notes, etc.
    • + + +
  • i18n configuarion, which is actually two subtopics:
      + +
    • font family configuration
      • + + +
    • l10n of label text
      • + +
    +
    • + +
+

Each of these points will be covered in separate sections below.

+
+ + + +

Font Family Configuration

+
+

The font family can be specifed in different steps of granularity. As + of the svn version of the PDF plugin, all of the configuration can be done + on a per project basis. There is no need to touch the plugin itself, as + it used to be.

+ +

Preparations

+

If you want to change the actual font family, not only where to use + the generic serif, sans-serif and + monospace families, then you also need to take these + preparatory steps:

+
    + +
  1. Follow the instructions at http://xmlgraphics.apache.org/fop/0.95/configuration.html + to create a FOP configuration file at + $PROJECT_HOME/src/documentation/resources/fonts (you + may have to create the fonts folder). The FOP + configuarion file can a.o. give you access to locally installed + fonts.
    2. + + +
  2. Specify the absolute path to the FOP configuration file you + created in step 1 as the value of the entity + &pdf-config-file; in the project entity file. The + file is located at: + $PROJECT_HOME/src/documentation/resources/schema/symbols-project-v10.ent. + The result should look something like: +
    <!ENTITY pdf-config-file "/Users/foo/forrestproject/src/documentation/resources/fonts/config.xml">
    + (the + above would work for a user named foo on a typical + MacOS X system - adapt to your local OS as needed, but the path + needs to be absolute)
    3. + +
+

A minimal FOP configuration file to give you access to all fonst + installed on the local OS looks like:

+
<fop>
+ <renderers>
+   <renderer mime="application/pdf">
+     <fonts>
+       <auto-detect/>
+     </fonts>
+   </renderer>
+ </renderers>
+</fop>
+

See the link above for more details.

+

Continue with the configuration in your + forrest.properties.xml file as described below.

+ +

Font family overrides/specifications

+

For the easiest type of changing the font family, add the following + lines to your forrest.properties.xml file:

+
  <property name="output.pdf.fontFamily.serif"     value="serif"/>
+  <property name="output.pdf.fontFamily.sansSerif" value="sans-serif"/>
+  <property name="output.pdf.fontFamily.monospace" value="monospace"/>
+

and replace the default values above with your preferred font + family, e.g. DejaVuSans, etc. Using these properties, you + will change the font family of whole classes of text types at once. If + you need proper i18n support for your language (more below) in the pdf + files, this is usually the easiest way to go - just replace the + generic families with your chosen font families.

+

If you need to override or specify the font family for a certain + text type, add one or more of the following properties to your + forrest.properties.xml file:

+
  <property name="output.pdf.fontFamily.rootFontFamily"          value="serif"      />
+  <property name="output.pdf.fontFamily.headerFooterFontFamily"  value="sans-serif" />
+  <property name="output.pdf.fontFamily.documentTitleFontFamily" value="sans-serif" />
+  <property name="output.pdf.fontFamily.versionFontFamily"       value="sans-serif" />
+  <property name="output.pdf.fontFamily.authorsFontFamily"       value="sans-serif" />
+  <property name="output.pdf.fontFamily.TOCTitleFontFamily"      value="sans-serif" />
+  <property name="output.pdf.fontFamily.TOCFontFamily"           value="serif"      />
+  <property name="output.pdf.fontFamily.sectionTitleFontFamily"  value="sans-serif" />
+  <property name="output.pdf.fontFamily.sourceFontFamily"        value="monospace"  />
+  <property name="output.pdf.fontFamily.codeFontFamily"          value="monospace"  />
+  <property name="output.pdf.fontFamily.warningTitleFontFamily"  value="sans-serif" />
+  <property name="output.pdf.fontFamily.noteTitleFontFamily"     value="sans-serif" />
+  <property name="output.pdf.fontFamily.fixmeTitleFontFamily"    value="sans-serif" />
+  <property name="output.pdf.fontFamily.abstractFontFamily"      value="serif"      />
+  <property name="output.pdf.fontFamily.noticeFontFamily"        value="serif"      />
+

The given values are defaults, and should be replaced with what you + want.

+
+
Note
+
The value specified for the properties should be the font family + name. If the font family name contains spaces, enclose the name in + single quotes.
+
+
+
Note
+
If you are using Dispatcher (in the whiteboard), the property + output.pdf.fontFamily.versionFontFamily does not have any + effect. Hopefully this will be corrected in the future.
+
+

If you want, you can further specify the font family for + variants of the + output.pdf.fontFamily.headerFooterFontFamily property + using the following properties instead:

+
  <property name="output.pdf.fontFamily.firstFooterFontFamily"   value="sans-serif" />
+  <property name="output.pdf.fontFamily.evenHeaderFontFamily"    value="sans-serif" />
+  <property name="output.pdf.fontFamily.evenFooterFontFamily"    value="sans-serif" />
+  <property name="output.pdf.fontFamily.oddHeaderFontFamily"     value="sans-serif" />
+  <property name="output.pdf.fontFamily.oddFooterFontFamily"     value="sans-serif" />
+

It is possible to do further customisations of the pdf rendering by + editing the stylesheets found in ...

+
+ + + +

Other presentation options

+
+

+ Presentation changes like page size, copyright notes, etc. are presently + specified in the skinconfig.xml file. See separate documentation for + further info. +

+
+ + + +

I18n Configuration

+
+ +

Font Family Configuration

+

For some languages, the default font families (serif, + sans-serif, monospace) do not render all + characters, giving squares, question marks or nothing instead in the + rendered pdf document. This is known to be an issue with CJK + languages, as well as with lesser used languages such as Sámi. If this + is the case for your language(s), please follow the steps above to + configure the pdf plugin to use a font family known to contain all + characters needed. For many alphabetic languages, the free and open + source DejaVu + font family nowadays has quite good coverage.

+ +

L10n of label text

+

[TO BE WRITTEN]

+
+
+PDF -icon
+ PDF +
Font size:      

Site Linkmap Table of Contents

+

This is a map of the complete site and its structure.

@@ -145,11 +147,6 @@ document.write("Last Published: " + docu
  • -Plugins Index  ___________________  forrestPlugins : Index of Forrest Plugins
    • -
- -
    -
  • Changes  ___________________  changes : History of Changes
@@ -182,7 +179,10 @@ document.write("Last Published: " + docu
Copyright © - 2004-2007 The Apache Software Foundation. + 2004-2011 The Apache Software Foundation. +
+ Apache, Apache Forrest, the Apache feather logo, and the Apache Forrest + logos are trademarks of The Apache Software Foundation.
+
+PDF -icon
+ PDF +
Font size:      

Todo List

+
  • @@ -130,21 +132,19 @@ document.write("Last Published: " + docu
+

high

  • -[docs] - Customize this template plugin with your plugin's details. This - TODO list is generated from 'status.xml'. - → RDG
    • +[docs] Customize this template plugin with your plugin's + details. This TODO list is generated from 'status.xml'. → RDG
  • -[docs] - Create the documentation with lots of examples and samples. - XML content goes in - src/documentation/content/xdocs +[docs] Create the documentation with lots of examples and + samples. XML content goes in + src/documentation/content/xdocs → open
@@ -166,7 +166,10 @@ document.write("Last Published: " + docu
Copyright © - 2004-2007 The Apache Software Foundation. + 2004-2011 The Apache Software Foundation. +
+ Apache, Apache Forrest, the Apache feather logo, and the Apache Forrest + logos are trademarks of The Apache Software Foundation.