You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by bu...@apache.org on 2012/10/24 06:09:13 UTC
svn commit: r835962 [10/14] - in
/websites/staging/xmlgraphics/trunk/content: ./ batik/ commons/ fop/
fop/0.95/ fop/1.0/ fop/1.1/ fop/dev/ fop/dev/design/ fop/trunk/
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/design/pdf-library.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/design/pdf-library.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/design/pdf-library.html Wed Oct 24 04:09:09 2012
@@ -330,30 +330,30 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a> » <a href="/fop/dev/design/">Design</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-design-pdf-library">Apache(tm) FOP Design: PDF Library</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-design-pdf-library">Apache™ FOP Design: PDF Library</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>The PDF Library is an independant package of classes in Apache™ FOP. These class provide a simple way to construct documents and add the contents. The classes are found in <code>org.apache.fop.pdf.*</code> .</p>
-<h2 id="pdf-document-wzxhzdk5wzxhzdk6">PDF Document <a id="PDF+Document"></a></h2>
+<h2 id="pdf-document-wzxhzdk6wzxhzdk7">PDF Document <a id="PDF+Document"></a></h2>
<p>This is where most of the document is created and put together.</p>
<p>It sets up the header, trailer and resources. Each page is made and added to the document. There are a number of methods that can be used to create/add certain PDF objects to the document.</p>
-<h2 id="building-pdf-wzxhzdk7wzxhzdk8">Building PDF <a id="Building+PDF"></a></h2>
+<h2 id="building-pdf-wzxhzdk8wzxhzdk9">Building PDF <a id="Building+PDF"></a></h2>
<p>The PDF Document is built by creating a page for each page in the Area Tree.</p>
<p>This page then has all the contents added. The page is then added to the document and available objects can be written to the output stream.</p>
<p>The contents of the page are things such as text, lines, images etc. The PDFRenderer inserts the text directly into a pdf stream. The text consists of markup to set fonts, set text position and add text.</p>
<p>Most of the simple pdf markup is inserted directly into a pdf stream. Other more complex objects or commonly used objects are added through java classes. Some pdf objects such as an image consists of two parts.</p>
<p>It has a separate object for the image data and another bit of markup to display the image in a certain position on the page.</p>
<p>The java objects that represent a pdf object implement a method that returns the markup for inserting into a stream. The method is: byte[] toPDF().</p>
-<h2 id="features-wzxhzdk9wzxhzdk10">Features <a id="Features"></a></h2>
-<h3 id="fonts-wzxhzdk11wzxhzdk12">Fonts # <a id="Fonts"></a></h3>
+<h2 id="features-wzxhzdk10wzxhzdk11">Features <a id="Features"></a></h2>
+<h3 id="fonts-wzxhzdk12wzxhzdk13">Fonts # <a id="Fonts"></a></h3>
<p>Support for embedding fonts and using the default Acrobat fonts.</p>
-<h3 id="images-wzxhzdk13wzxhzdk14">Images # <a id="Images"></a></h3>
+<h3 id="images-wzxhzdk14wzxhzdk15">Images # <a id="Images"></a></h3>
<p>Images can be inserted into a page. The image can either be inserted as a pixel map or directly insert a jpeg image.</p>
-<h3 id="stream-filters-wzxhzdk15wzxhzdk16">Stream Filters # <a id="Stream+Filters"></a></h3>
+<h3 id="stream-filters-wzxhzdk16wzxhzdk17">Stream Filters # <a id="Stream+Filters"></a></h3>
<p>A number of filters are available to encode the pdf streams. These filters can compress the data or change it such as converting to hex.</p>
-<h3 id="links-wzxhzdk17wzxhzdk18">Links # <a id="Links"></a></h3>
+<h3 id="links-wzxhzdk18wzxhzdk19">Links # <a id="Links"></a></h3>
<p>A pdf link can be added for an area on the page. This link can then point to an external destination or a position on any page in the document.</p>
-<h3 id="patterns-wzxhzdk19wzxhzdk20">Patterns # <a id="Patterns"></a></h3>
+<h3 id="patterns-wzxhzdk20wzxhzdk21">Patterns # <a id="Patterns"></a></h3>
<p>The fill and stroke of graphical objects can be set with a colour, pattern or gradient.</p>
<p>The are a number of other features for handling pdf markup relevent to creating PDF files for FOP.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/design/renderers.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/design/renderers.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/design/renderers.html Wed Oct 24 04:09:09 2012
@@ -330,27 +330,27 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a> » <a href="/fop/dev/design/">Design</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-design-renderers">Apache(tm) FOP Design: Renderers</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-design-renderers">Apache™ FOP Design: Renderers</h1>
<p><version>$Revision: 1298724 $</version><authors><person email="keiron@aftexsw.com" name="Keiron Liddle"></person></authors></p>
-<h2 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk7wzxhzdk8">Introduction <a id="intro"></a></h2>
<p>A renderer is primarily designed to convert a given area tree into the output document format. It should be able to produce pages and fill the pages with the text and graphical content. Usually the output is sent to an output stream.</p>
<p>Some output formats may support extra information that is not available from the area tree or depends on the destination of the document.</p>
<p>Each renderer is given an area tree to render to its output format. The area tree is simply a representation of the pages and the placement of text and graphical objects on those pages.</p>
<p>The renderer will be given each page as it is ready and an output stream to write the data out. All pages are supplied in the order they appear in the document. In order to save memory it is possble to render the pages out of order. Any page that is not ready to be rendered is setup by the renderer first so that it can reserve a space or reference for when the page is ready to be rendered.The renderer is responsible for managing the output format and associated data and flow.</p>
-<h2 id="design-issues-wzxhzdk8wzxhzdk9">Design Issues <a id="issues"></a></h2>
-<h3 id="renderers-are-responsible-wzxhzdk10wzxhzdk11">Renderers are Responsible # <a id="issue-renderers-responsible"></a></h3>
+<h2 id="design-issues-wzxhzdk9wzxhzdk10">Design Issues <a id="issues"></a></h2>
+<h3 id="renderers-are-responsible-wzxhzdk11wzxhzdk12">Renderers are Responsible # <a id="issue-renderers-responsible"></a></h3>
<p>Each renderer is totally responsible for its output format.</p>
-<h3 id="send-output-to-a-stream-wzxhzdk12wzxhzdk13">Send Output to a Stream # <a id="issue-output-stream"></a></h3>
-<h2 id="fonts-wzxhzdk14wzxhzdk15">Fonts <a id="fonts"></a></h2>
+<h3 id="send-output-to-a-stream-wzxhzdk13wzxhzdk14">Send Output to a Stream # <a id="issue-output-stream"></a></h3>
+<h2 id="fonts-wzxhzdk15wzxhzdk16">Fonts <a id="fonts"></a></h2>
<p>Because font metrics (and therefore layout) are obtained in two different ways depending on the renderer, the renderer actually sets up the fonts being used. The font metrics are used during the layout process to determine the size of characters.</p>
-<h2 id="render-context-wzxhzdk16wzxhzdk17">Render Context <a id="context"></a></h2>
+<h2 id="render-context-wzxhzdk17wzxhzdk18">Render Context <a id="context"></a></h2>
<p>The render context is used by handlers. It contains information about the current state of the renderer, such as the page, the position, and any other miscellanous objects that are required to draw into the page.</p>
-<h2 id="xml-handling-wzxhzdk18wzxhzdk19">XML Handling <a id="XML+Handling"></a></h2>
+<h2 id="xml-handling-wzxhzdk19wzxhzdk20">XML Handling <a id="XML+Handling"></a></h2>
<p>A document may contain information in the form of XML for an image or instream foreign object. This XML is handled through the user agent. A standard extension for PDF is the SVG handler.</p>
<p>If there is XML in the SVG namespace it is given to the handler which renders the SVG into the pdf document at the given location. This separation means that other XML handlers can easily be added.</p>
-<h2 id="extensions-wzxhzdk20wzxhzdk21">Extensions <a id="Extensions"></a></h2>
+<h2 id="extensions-wzxhzdk21wzxhzdk22">Extensions <a id="Extensions"></a></h2>
<p>Document level extensions are handled with an extension handler. This handles the information from the AreaTree and adds renders it to the document. An example is the pdf bookmarks. This information first needs to have all references resolved. Then the extension handler is ready to put the information into the pdf document.</p>
-<h2 id="renderer-implementations-wzxhzdk22wzxhzdk23">Renderer Implementations <a id="implement"></a></h2>
+<h2 id="renderer-implementations-wzxhzdk23wzxhzdk24">Renderer Implementations <a id="implement"></a></h2>
<table>
<thead>
<tr>
@@ -445,7 +445,7 @@ $(document).ready(function () {
</tr>
</tbody>
</table>
-<h2 id="adding-a-renderer-wzxhzdk24wzxhzdk25">Adding a Renderer <a id="add"></a></h2>
+<h2 id="adding-a-renderer-wzxhzdk25wzxhzdk26">Adding a Renderer <a id="add"></a></h2>
<p>You can add other renderers by implementing the Renderer interface. However, the AbstractRenderer does most of what is needed, including iterating through the tree parts, so it is probably better to extend this. This means that you only need to implement the basic functionality such as text, images, and lines. AbstractRenderer's methods can easily be overridden to handle things in a different way or do some extra processing.</p>
<p>The relevent AreaTree structures that will need to be rendered are:</p>
<ul>
@@ -486,12 +486,12 @@ $(document).ready(function () {
<p>draw various lines and rectangles</p>
</li>
</ul>
-<h2 id="multiple-renderers-wzxhzdk26wzxhzdk27">Multiple Renderers <a id="multiple"></a></h2>
+<h2 id="multiple-renderers-wzxhzdk27wzxhzdk28">Multiple Renderers <a id="multiple"></a></h2>
<p>The layout of the document depends mainly on the font being used. If two renderers have the same font metrics then it is possible to use the same Area Tree to render both. This can be handled by the AreaTree Handler.</p>
-<h2 id="status-wzxhzdk28wzxhzdk29">Status <a id="status"></a></h2>
-<h3 id="to-do-wzxhzdk30wzxhzdk31">To Do # <a id="status-todo"></a></h3>
-<h3 id="work-in-progress-wzxhzdk32wzxhzdk33">Work In Progress # <a id="status-wip"></a></h3>
-<h3 id="completed-wzxhzdk34wzxhzdk35">Completed # <a id="status-complete"></a></h3>
+<h2 id="status-wzxhzdk29wzxhzdk30">Status <a id="status"></a></h2>
+<h3 id="to-do-wzxhzdk31wzxhzdk32">To Do # <a id="status-todo"></a></h3>
+<h3 id="work-in-progress-wzxhzdk33wzxhzdk34">Work In Progress # <a id="status-wip"></a></h3>
+<h3 id="completed-wzxhzdk35wzxhzdk36">Completed # <a id="status-complete"></a></h3>
<ul>
<li>
<p>new renderer model</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/design/startup.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/design/startup.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/design/startup.html Wed Oct 24 04:09:09 2012
@@ -330,12 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a> » <a href="/fop/dev/design/">Design</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-design-startup-environment-control">Apache(tm) FOP Design: Startup, Environment, Control</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-design-startup-environment-control">Apache™ FOP Design: Startup, Environment, Control</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>Startup is the process of getting Apache™ FOP bootstrapped and creating basic objects. Environment includes acquiring user options, instantiating any frameworks, setting up logging, etc. Control includes the basic logic for tieing the various subsystems together properly.</p>
-<h2 id="status-wzxhzdk5wzxhzdk6">Status <a id="status"></a></h2>
-<h3 id="to-do-wzxhzdk7wzxhzdk8">To Do # <a id="status-todo"></a></h3>
+<h2 id="status-wzxhzdk6wzxhzdk7">Status <a id="status"></a></h2>
+<h3 id="to-do-wzxhzdk8wzxhzdk9">To Do # <a id="status-todo"></a></h3>
<ul>
<li>
<p>avalon integration - logging, configuration, component management, caching, uri resolver</p>
@@ -355,8 +355,8 @@ $(document).ready(function () {
<p>better commandline handling</p>
</li>
</ul>
-<h3 id="work-in-progress-wzxhzdk9wzxhzdk10">Work In Progress # <a id="status-wip"></a></h3>
-<h3 id="completed-wzxhzdk11wzxhzdk12">Completed # <a id="status-complete"></a></h3>
+<h3 id="work-in-progress-wzxhzdk10wzxhzdk11">Work In Progress # <a id="status-wip"></a></h3>
+<h3 id="completed-wzxhzdk12wzxhzdk13">Completed # <a id="status-complete"></a></h3>
<ul>
<li><strong>better image handling</strong> - redone so it can use a cache and synchronizes properly only on the current image while loading</li>
</ul></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/design/svg.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/design/svg.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/design/svg.html Wed Oct 24 04:09:09 2012
@@ -330,29 +330,29 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a> » <a href="/fop/dev/design/">Design</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-design-svg">Apache(tm) FOP Design: SVG</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-design-svg">Apache™ FOP Design: SVG</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>SVG is rendered through Apache™ Batik.</p>
<p>The XML from the XSL:FO document is converted into an SVG DOM with batik. This DOM is then set as the Document on the Foreign Object area in the Area Tree.</p>
<p>This DOM is then available to be rendered by the renderer.</p>
<p>SVG is rendered in the renderers via an XMLHandler in the FOUserAgent. This XML handler is used to render the SVG. The SVG is rendered by using batik. Batik converts the SVG DOM into an internal structure that can be drawn into a Graphics2D. So for PDF we use a PDFGraphics2D to draw into.</p>
<p>This creates the necessary PDF information to create the SVG image in the PDF document.</p>
<p>Most of the work is done in the PDFGraphics2D class. There are also a few bridges that are plugged into batik to provide different behaviour for some SVG elements.</p>
-<h2 id="text-drawing-wzxhzdk5wzxhzdk6">Text Drawing <a id="Text+Drawing"></a></h2>
+<h2 id="text-drawing-wzxhzdk6wzxhzdk7">Text Drawing <a id="Text+Drawing"></a></h2>
<p>Normally batik converts text into a set of curved shapes.</p>
<p>This is handled as any other shapes when rendering to the output. This is not always desirable as the shapes have very fine curves. This can cause the output to look a bit bad in PDF and PS (it can be drawn properly but is not by default). These curves also require much more data than the original text.</p>
<p>To handle this there is a PDFTextElementBridge that is set when using the bridge in batik. If the text is simple enough for the text to be drawn in the PDF as with all other text then this sets the TextPainter to use the PDFTextPainter. This inserts the text directly into the PDF using the drawString method on the PDFGraphics2D.</p>
<p>Text is considered simple if the font is available, the font size is useable and there are no tspans or other complications. This can make the resulting PDF significantly smaller.</p>
-<h2 id="pdf-links-wzxhzdk7wzxhzdk8">PDF Links <a id="PDF+Links"></a></h2>
+<h2 id="pdf-links-wzxhzdk8wzxhzdk9">PDF Links <a id="PDF+Links"></a></h2>
<p>To support links in PDF another batik element bridge is used. The PDFAElementBridge creates a PDFANode which inserts a link into the PDF document via the PDFGraphics2D.</p>
<p>Since links are positioned on the page without any transforms then we need to transform the coordinates of the link area so that they match the current position of the a element area. This transform may also need to account for the svg being positioned on the page.</p>
-<h2 id="images-wzxhzdk9wzxhzdk10">Images <a id="Images"></a></h2>
+<h2 id="images-wzxhzdk10wzxhzdk11">Images <a id="Images"></a></h2>
<p>Images are normally drawn into the PDFGraphics2D. This then creates a bitmap of the image data that can be inserted into the PDF document.</p>
<p>As PDF can support jpeg images then another element bridge is used so that the jpeg can be directly inserted into the PDF.</p>
-<h2 id="pdf-transcoder-wzxhzdk11wzxhzdk12">PDF Transcoder <a id="PDF+Transcoder"></a></h2>
+<h2 id="pdf-transcoder-wzxhzdk12wzxhzdk13">PDF Transcoder <a id="PDF+Transcoder"></a></h2>
<p>Batik provides a mechanism to convert SVG into various formats. Through FOP we can convert an SVG document into a single paged PDF document. The page contains the SVG drawn as best as possible on the page. There is a PDFDocumentGraphics2D that creates a standalone PDF document with a single page. This is then drawn into by batik in the same way as with the PDFGraphics2D.</p>
-<h2 id="other-outputs-wzxhzdk13wzxhzdk14">Other Outputs <a id="Other+Outputs"></a></h2>
+<h2 id="other-outputs-wzxhzdk14wzxhzdk15">Other Outputs <a id="Other+Outputs"></a></h2>
<p>When rendering to AWT the SVG is simply drawn onto the awt canvas using batik.</p>
<p>The PS Renderer uses a similar technique as the PDF Renderer.</p>
<p>The SVG Renderer simply embeds the SVG inside an svg element.</p></div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/design/useragent.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/design/useragent.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/design/useragent.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a> » <a href="/fop/dev/design/">Design</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-design-user-agent">Apache(tm) FOP Design: User Agent</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-design-user-agent">Apache™ FOP Design: User Agent</h1>
<p><version>$Revision: 1298724 $</version><authors><person email="keiron@aftexsw.com" name="Keiron Liddle"></person></authors></p>
-<h2 id="introduction-wzxhzdk6wzxhzdk7">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk7wzxhzdk8">Introduction <a id="intro"></a></h2>
<p>Technically the user agent is Apache™ FOP in the role of determining the output format and when resolving various attributes. The user agent is represented by a class that is available to others to specify how FOP should behave.</p>
<p>The user agent is used by the formatting process to determine certain user definable values.</p>
<p>It will enable the customisation of values for generating and rendering the document.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/doc.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/doc.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/doc.html Wed Oct 24 04:09:09 2012
@@ -330,15 +330,15 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-managing-documentation">Apache(tm) FOP Development: Managing Documentation</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-managing-documentation">Apache™ FOP Development: Managing Documentation</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="general-information-wzxhzdk2wzxhzdk3">General Information <a id="general"></a></h2>
+<h2 id="general-information-wzxhzdk3wzxhzdk4">General Information <a id="general"></a></h2>
<p>All raw documentation content is managed in the Apache™ FOP SVN repository. Updates should be committed to the repository, then the repository files are used to generate usable output. The remaining discussions on this page assume that the SVN repository is the starting place for processing. The path to the documentation is src/documentation/content/xdocs.
All documentation is maintained on the trunk.
Basic documents are stored in XML files, and use DTDs provided by Apache Forrest.</p>
-<h2 id="design-principles-wzxhzdk5wzxhzdk6">Design Principles <a id="design"></a></h2>
+<h2 id="design-principles-wzxhzdk6wzxhzdk7">Design Principles <a id="design"></a></h2>
<p>These principles are not written in stone, but reflect the current philosophy, and are documented here primarily to help achieve consistency. These principles should be changed if better or more practical ones are found, but they should probably be discussed and changed by common consent.</p>
-<h3 id="where-wzxhzdk7wzxhzdk8">Where # <a id="where"></a></h3>
+<h3 id="where-wzxhzdk8wzxhzdk9">Where # <a id="where"></a></h3>
<ul>
<li>
<p>To the extent possible, keep user content separate from developer content, primarily so the user doesn't have to filter out technical information.</p>
@@ -347,11 +347,11 @@ Basic documents are stored in XML files,
<p>To the extent possible, try to document a topic exactly once, in the place the user is most likely to look for it, then link to that from other locations as appropriate. This is somewhat contrary to the principle above, which should be applied as a higher priority.</p>
</li>
</ul>
-<h3 id="when-wzxhzdk9wzxhzdk10">When # <a id="design-when"></a></h3>
+<h3 id="when-wzxhzdk10wzxhzdk11">When # <a id="design-when"></a></h3>
<p>The documentation and the product are in a constant state of change, and there is some difficulty in deciding what product state the website content should reflect. The current thinking is that the website should reflect the current state of the repository code branch from which releases are made. Features or other documentation that applies to unreleased code should be marked in such a way within the content that the user can determine whether and how it applies to the version they are using. For example, "Feature xyz is first available in Release n.nn.n".</p>
<p>Other approaches were considered, but all seemed to have significantly higher costs both to the users and the developers. From the user's standpoint, the choice is either that they potentially have to look multiple places to get the information they need (which was rejected), or they have to filter out an occasional feature that is in code available subsequent to their release (which was accepted).</p>
-<h2 id="website-wzxhzdk11wzxhzdk12">Website <a id="web"></a></h2>
-<h3 id="background-wzxhzdk13wzxhzdk14">Background # <a id="web-background"></a></h3>
+<h2 id="website-wzxhzdk12wzxhzdk13">Website <a id="web"></a></h2>
+<h3 id="background-wzxhzdk14wzxhzdk15">Background # <a id="web-background"></a></h3>
<p>The FOP web site and documentation are generated using <a href="http://forrest.apache.org">Apache Forrest</a> .</p>
<p>The following table summarizes the flow of data to the FOP website in chronological order:</p>
<table>
@@ -413,7 +413,7 @@ Please make sure you use Forrest from th
</li>
</ul>
<p>The reason for putting the generated website in the SVN repository: The infrastructure people want to be able to restore the websites themselves in case of a crash.</p>
-<h3 id="using-a-local-forrest-wzxhzdk15wzxhzdk16">Using a Local Forrest # <a id="web-local-forrest"></a></h3>
+<h3 id="using-a-local-forrest-wzxhzdk16wzxhzdk17">Using a Local Forrest # <a id="web-local-forrest"></a></h3>
<p>To use a local Forrest (during website development, not for deployment):</p>
<ul>
<li>
@@ -436,10 +436,10 @@ Please make sure you use Forrest from th
You can use "forrest run" to start a local web server. That improves development speed as you can simply refresh in the browser after a change.</p>
</li>
</ul>
-<h2 id="updating-distribution-files-wzxhzdk17wzxhzdk18">Updating Distribution Files # <a id="distribution"></a></h2>
+<h2 id="updating-distribution-files-wzxhzdk18wzxhzdk19">Updating Distribution Files # <a id="distribution"></a></h2>
<p>The Apache distribution system mirrors distributions around the world. Since it uses <a href="http://httpd.apache.org/">Apache httpd</a> Module <a href="http://httpd.apache.org/docs/2.2/mod/mod_autoindex.html#headername">mod_autoindex</a> you also need to manually update the HEADER.html & READER.html files on <code>people.apache.org</code> in <code>/www/www.apache.org/dist/xmlgraphics/fop/</code> .</p>
<p>Please be careful when doing stuff like that.</p>
-<h3 id="deleting-documentation-files-wzxhzdk19wzxhzdk20">Deleting Documentation Files # <a id="delete"></a></h3>
+<h3 id="deleting-documentation-files-wzxhzdk20wzxhzdk21">Deleting Documentation Files # <a id="delete"></a></h3>
<p>ForrestBot simply uploads the whole generated site. It doesn't delete obsolete files. You can do that manually in the /www/xmlgraphics.apache.org/fop folder on cvs.apache.org. Be careful when doing stuff like that.
Please make sure you always have <strong>group rw permissions on all files</strong> under the /www directory!</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/extensions.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/extensions.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/extensions.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-adding-an-extension">Apache(tm) FOP Development: Adding an Extension</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-adding-an-extension">Apache™ FOP Development: Adding an Extension</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="overview-wzxhzdk2wzxhzdk3">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk3wzxhzdk4">Overview <a id="overview"></a></h2>
<p>For documentation of standard Apache™ FOP extensions, see the <a href="../trunk/extensions.html">User FOP Extensions</a> document.</p>
<p>If the default funtionality of FOP needs to be extended for some reason then you can write an extension.</p>
<p>There are three types of extensions possible:</p>
@@ -347,7 +347,7 @@ $(document).ready(function () {
<p>an fo extension that creates an area in the area tree where normal xsl:fo is not possible</p>
</li>
</ul>
-<h2 id="adding-your-own-wzxhzdk5wzxhzdk6">Adding Your Own <a id="adding"></a></h2>
+<h2 id="adding-your-own-wzxhzdk6wzxhzdk7">Adding Your Own <a id="adding"></a></h2>
<p>To add your own extension you need to do the following things.</p>
<ol>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/implement.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/implement.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/implement.html Wed Oct 24 04:09:09 2012
@@ -330,12 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-implementation-overview">Apache(tm) FOP Development: Implementation Overview</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-implementation-overview">Apache™ FOP Development: Implementation Overview</h1>
<p><subtitle>Following a Document Through Apache� FOP</subtitle><version>$Revision: 1298724 $</version><authors><person email="" name="Arved Sandstrom"></person></authors></p>
<p>The purpose of this document is to tie together the Apache™ FOP design (interface) with some of the key points where control is passed within FOP (implementation), so that developers can quickly find the section of code that is relevant to their needs. The process described is for a "typical" command-line document. All classes are in org.apache.fop unless otherwise designated.</p>
-<h2 id="overview-wzxhzdk9wzxhzdk10">Overview <a id="Overview"></a></h2>
+<h2 id="overview-wzxhzdk10wzxhzdk11">Overview <a id="Overview"></a></h2>
<p>The input FO document is sent to the FO tree builder via SAX events. Fragments of an FO Tree are built from this process. As each page-sequence element is completed, it is passed to a layout processor, which in turn converts it into an Area Tree. The Area Tree is then given to the Renderer, which converts it into a stream of data containing the output document. The sections below will provide additional details. Where needed differences between the trunk and maintenance branches are shown in tabular format.</p>
-<h2 id="startup-wzxhzdk11wzxhzdk12">Startup <a id="Startup"></a></h2>
+<h2 id="startup-wzxhzdk12wzxhzdk13">Startup <a id="Startup"></a></h2>
<ul>
<li>
<p>The job starts in <em>apps.Fop.main()</em> .</p>
@@ -347,7 +347,7 @@ $(document).ready(function () {
<p>Control is passed to <em>apps.Driver.render()</em> . This class fires up a SAX parser, the events from which indirectly control the remaining processing, including building the FO Tree, building the Area Tree, rendering, output and logging.</p>
</li>
</ul>
-<h2 id="formatting-object-tree-wzxhzdk13wzxhzdk14">Formatting Object Tree <a id="Formatting+Object+Tree"></a></h2>
+<h2 id="formatting-object-tree-wzxhzdk14wzxhzdk15">Formatting Object Tree <a id="Formatting+Object+Tree"></a></h2>
<table>
<thead>
<tr>
@@ -378,12 +378,12 @@ $(document).ready(function () {
</tr>
</tbody>
</table>
-<h2 id="layout-wzxhzdk15wzxhzdk16">Layout <a id="Layout"></a></h2>
+<h2 id="layout-wzxhzdk16wzxhzdk17">Layout <a id="Layout"></a></h2>
<p>There are layout managers for each type of layout decision. They take an FO Tree as input and build a laid-out Area Tree from it. The layout process involves finding out where line breaks and page breaks should be made, then creating the areas on the page. Static areas can then be added for any static regions. As pages are completed, they are added to the Area Tree.</p>
-<h2 id="area-tree-wzxhzdk17wzxhzdk18">Area Tree <a id="Area+Tree"></a></h2>
+<h2 id="area-tree-wzxhzdk18wzxhzdk19">Area Tree <a id="Area+Tree"></a></h2>
<p>The area tree is a data structure designed to hold the page areas. These pages are then filled with the page regions and various areas. The area tree is used primarily as a minimal structure that can be rendered by the renderers.</p>
<p>The area tree is supported by an area tree model. This model handles the adding of pages to the area tree. It also handles page sequence starts, document level extensions, id references and unresolved id areas. This model allows the pages to be handled directly by a renderer or to store the pages for later use.</p>
-<h2 id="rendering-wzxhzdk19wzxhzdk20">Rendering <a id="Rendering"></a></h2>
+<h2 id="rendering-wzxhzdk20wzxhzdk21">Rendering <a id="Rendering"></a></h2>
<p>The renderer receives pages from the area tree and renders those pages. If a renderer supports out of order rendering then it will either render or prepare a page in the correct order. Otherwise the pages are rendered in order. The task of the renderer is to take the pages and output them to the requested type. In the case of the AWTRenderer it needs to be able to view any page.</p>
<p>When rendering a page it takes the page and renders each page region. The main work for a renderer implementation is to handle the viewports and inline areas. The inline areas need to be drawn on the page in the correct place.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/index.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/index.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/index.html Wed Oct 24 04:09:09 2012
@@ -330,18 +330,18 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-general-information">Apache(tm) FOP Development: General Information</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-general-information">Apache™ FOP Development: General Information</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>These pages contain information that should be helpful for those developing Apache™ FOP. This certainly includes programmers, but may also include those contributing to the project in other ways.</p>
<p>For basic and user information on FOP, please visit the <a href="http://xml.apache.org/fop">Apache™ FOP homepage</a> .</p>
-<h2 id="development-wzxhzdk6wzxhzdk7">Development <a id="lines"></a></h2>
+<h2 id="development-wzxhzdk7wzxhzdk8">Development <a id="lines"></a></h2>
<p>The main development happens on "FOP Trunk".
The SVN repository URL for the trunk is:<br></br> <code>http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/</code> </p>
-<h1 id="getting-involved-wzxhzdk10wzxhzdk11">Getting Involved <a id="involved"></a></h1>
-<h3 id="understand-apache-roles-wzxhzdk12wzxhzdk13">Understand Apache Roles # <a id="apache-roles"></a></h3>
+<h1 id="getting-involved-wzxhzdk11wzxhzdk12">Getting Involved <a id="involved"></a></h1>
+<h3 id="understand-apache-roles-wzxhzdk13wzxhzdk14">Understand Apache Roles # <a id="apache-roles"></a></h3>
<p>Review the <a href="http://xml.apache.org/roles.html">Apache Project Roles and Responsibilities</a> document for an understanding of the various roles of contributors within the community.</p>
-<h3 id="how-you-can-help-wzxhzdk14wzxhzdk15">How you can help # <a id="fop-tasks"></a></h3>
+<h3 id="how-you-can-help-wzxhzdk15wzxhzdk16">How you can help # <a id="fop-tasks"></a></h3>
<p>There are many different ways that you can help with FOP development. The following is a non-exhaustive list of ways that <em>non-programmers</em> can help. Remember that an hour spent on the tasks below is an hour that a programmer can devote to fixing bugs or adding features instead:</p>
<ul>
<li>
@@ -378,14 +378,14 @@ The SVN repository URL for the trunk is:
<p>Implementing new features.</p>
</li>
</ul>
-<h3 id="understand-fop-related-standards-wzxhzdk16wzxhzdk17">Understand FOP-related standards # <a id="fop-standards"></a></h3>
+<h3 id="understand-fop-related-standards-wzxhzdk17wzxhzdk18">Understand FOP-related standards # <a id="fop-standards"></a></h3>
<p>At the moment FOP is mainly a tool to render XSL-FO files to pdf. Therefore if you want to contribute to FOP you should become familiar with these standards. You can find links at <a href="../resources.html#specs">Specifications</a> .</p>
-<h3 id="review-the-developer-documentation-wzxhzdk18wzxhzdk19">Review the Developer Documentation # <a id="doc"></a></h3>
-<h3 id="understand-fops-design-wzxhzdk20wzxhzdk21">Understand FOP's Design # <a id="design"></a></h3>
+<h3 id="review-the-developer-documentation-wzxhzdk19wzxhzdk20">Review the Developer Documentation # <a id="doc"></a></h3>
+<h3 id="understand-fops-design-wzxhzdk21wzxhzdk22">Understand FOP's Design # <a id="design"></a></h3>
<p>The design for FOP is specified under the <a href="design/index.html">Design</a> section. This is where the information on how FOP is developed and designed internally will be kept.</p>
<p>Another place where we write design documentation is the <a href="http://wiki.apache.org/xmlgraphics-fop/DeveloperPages">FOP Wiki</a> .
Our design documentation may not always be up to date!</p>
-<h2 id="subscribe-to-the-fop-dev-mailing-list-wzxhzdk22wzxhzdk23">Subscribe to the fop-dev Mailing List # <a id="mail-fop-dev"></a></h2>
+<h2 id="subscribe-to-the-fop-dev-mailing-list-wzxhzdk23wzxhzdk24">Subscribe to the fop-dev Mailing List # <a id="mail-fop-dev"></a></h2>
<p>Use this forum to discuss topics related to FOP development, including patch submissions, bug reports, and design issues. Please <em>do not</em> use it for XML support, XSLT support, XSL-FO support, or even FOP support. Appropriate mailing lists for these topics can be found on the <a href="../maillist.html">FOP Mailing List</a> page.</p>
<ul>
<li>
@@ -433,7 +433,7 @@ Our design documentation may not always
<p>To unsubscribe: Send email to <a href="mailto:fop-dev-unsubscribe@xmlgraphics.apache.org">fop-dev-unsubscribe@xmlgraphics.apache.org</a> .</p>
</li>
</ul>
-<h3 id="subscribe-to-the-fop-commits-mailing-list-wzxhzdk24wzxhzdk25">Subscribe to the fop-commits Mailing List # <a id="mail-fop-cvs"></a></h3>
+<h3 id="subscribe-to-the-fop-commits-mailing-list-wzxhzdk25wzxhzdk26">Subscribe to the fop-commits Mailing List # <a id="mail-fop-cvs"></a></h3>
<p>When changes are committed to the code repository, a record of the diffs is emailed to the fop-cvs mailing list. FOP developers are encouraged to subscribe to this list because it helps in following the progress of the project.</p>
<ul>
<li>
@@ -463,9 +463,9 @@ Our design documentation may not always
<p>Subscribe by sending an email to <a href="mailto:fop-commits-subscribe@xmlgraphics.apache.org">fop-commits-subscribe@xmlgraphics.apache.org</a> .</p>
</li>
</ul>
-<h3 id="download-and-use-the-developers-code-using-subversion-wzxhzdk26wzxhzdk27">Download and Use the Developers' Code Using Subversion # <a id="dev-code"></a></h3>
+<h3 id="download-and-use-the-developers-code-using-subversion-wzxhzdk27wzxhzdk28">Download and Use the Developers' Code Using Subversion # <a id="dev-code"></a></h3>
<p>Between releases the newest code can be accessed via SVN. To do this you need to install a SVN client on your computer, if it is not already there. An explanation how to connect to the FOP source repository can be found at <a href="http://xmlgraphics.apache.org/repo.html">http://xmlgraphics.apache.org/repo.html</a> . More information can be found on the <a href="tools.html">Tools page</a> .</p>
-<h3 id="submitting-patches-wzxhzdk28wzxhzdk29">Submitting Patches # <a id="patches"></a></h3>
+<h3 id="submitting-patches-wzxhzdk29wzxhzdk30">Submitting Patches # <a id="patches"></a></h3>
<p>If you have useful changes to source code (bugfixes or enhancements), test files, or documentation that you would like to contribute to the project, please do the following:</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/release.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/release.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/release.html Wed Oct 24 04:09:09 2012
@@ -330,12 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-release-mechanics">Apache(tm) FOP Development: Release Mechanics</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-release-mechanics">Apache™ FOP Development: Release Mechanics</h1>
<p><version>$Revision: 1310603 $</version></p>
-<h2 id="introduction-wzxhzdk2wzxhzdk3">Introduction <a id="intro"></a></h2>
+<h2 id="introduction-wzxhzdk3wzxhzdk4">Introduction <a id="intro"></a></h2>
<p>This page documents the process of creating a Apache™ FOP release. FOP releases are coordinated by some designated member of the team. The purpose of documenting it here is to facilitate consistency, ensure that the process is captured, and to allow others to comment on the process.</p>
<p>The checklist below is based on a combination of input from from Christian Geisert and Simon Pepping.</p>
-<h2 id="checklist-wzxhzdk5wzxhzdk6">Checklist <a id="checklist"></a></h2>
+<h2 id="checklist-wzxhzdk6wzxhzdk7">Checklist <a id="checklist"></a></h2>
<ul>
<li>
<p>Determine which open bugs must be solved before a release can take place (release critical bugs). Make this bug depend on each release critical bug and write a short argument why the bug is release critical.</p>
@@ -455,7 +455,7 @@ $(document).ready(function () {
<p>Deploy the maven bundle.</p>
</li>
</ul>
-<h2 id="resources-wzxhzdk7wzxhzdk8">Resources <a id="other-checklists"></a></h2>
+<h2 id="resources-wzxhzdk8wzxhzdk9">Resources <a id="other-checklists"></a></h2>
<p>The following is a sample of some other project release checklists, which might be consulted for ideas:</p>
<ul>
<li>
@@ -477,7 +477,7 @@ $(document).ready(function () {
<p>Stefan Bodewig's<jump href="http://people.apache.org/~bodewig/mirror.html">Making your Downloads Mirrorable</jump></p>
</li>
</ul>
-<h2 id="announcing-the-release-wzxhzdk9wzxhzdk10">Announcing the release <a id="announcements"></a></h2>
+<h2 id="announcing-the-release-wzxhzdk10wzxhzdk11">Announcing the release <a id="announcements"></a></h2>
<p>Here's a suggested list of places where to announce new FOP releases:</p>
<ul>
<li>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/rtflib.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/rtflib.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/rtflib.html Wed Oct 24 04:09:09 2012
@@ -330,10 +330,10 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-rtflib-jfor">Apache(tm) FOP Development: RTFLib (jfor)</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-rtflib-jfor">Apache™ FOP Development: RTFLib (jfor)</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="general-information-wzxhzdk2wzxhzdk3">General Information <a id="general"></a></h2>
-<h3 id="introduction-wzxhzdk4wzxhzdk5">Introduction # <a id="intro"></a></h3>
+<h2 id="general-information-wzxhzdk3wzxhzdk4">General Information <a id="general"></a></h2>
+<h3 id="introduction-wzxhzdk5wzxhzdk6">Introduction # <a id="intro"></a></h3>
<p>The RTFLib package is an open-source, <em>independent</em> package suitable for writing RTF files in a java environment. By <em>independent</em> we mean:</p>
<ul>
<li>
@@ -344,13 +344,13 @@ $(document).ready(function () {
</li>
</ul>
<p>The FOP development team intends to keep the RTFLib package independent so that it can be used for other purposes.</p>
-<h3 id="history-wzxhzdk6wzxhzdk7">History # <a id="history"></a></h3>
+<h3 id="history-wzxhzdk7wzxhzdk8">History # <a id="history"></a></h3>
<p>RTFLib was originally developed by <a href="mailto:bdelacretaz@apache.org">Bertrand Delacrétaz</a> and the <a href="http://www.jfor.org">jfor</a> team. jfor was written under an Apache-style license, and the jfor team contributed the code to the Apache Software Foundation in June, 2003. RTFLib is a subset of the original jfor project, which also includes an XSL-FO parsing mechanism for a complete XSL-FO to RTF solution.</p>
-<h3 id="status-wzxhzdk8wzxhzdk9">Status # <a id="status"></a></h3>
+<h3 id="status-wzxhzdk9wzxhzdk10">Status # <a id="status"></a></h3>
<p>Although FOP's implementation of the RTFLib package is very incomplete, the RTFLib package itself is relatively mature. RTFLib is only available in the trunk <a href="index.html#lines">line of FOP development</a> .
<warning>This documentation is a work in progress. If you see errors or omissions, please report them to the <a href="index.html#mail-fop-dev">fop-dev mailing list</a> .</warning></p>
-<h1 id="user-documentation-wzxhzdk12wzxhzdk13">User Documentation <a id="userdoc"></a></h1>
-<h3 id="overview-wzxhzdk14wzxhzdk15">Overview # <a id="userdoc-overview"></a></h3>
+<h1 id="user-documentation-wzxhzdk13wzxhzdk14">User Documentation <a id="userdoc"></a></h1>
+<h3 id="overview-wzxhzdk15wzxhzdk16">Overview # <a id="userdoc-overview"></a></h3>
<p>Perhaps the easiest way to see how to use RTFLib is by looking at an example. A set of test documents is part of the package, and can be <a href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/">viewed online</a> . A quick look at the Abstract <a href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/TestDocument.java?rev=HEAD&content-type=text/vnd.viewcvs-markup">TestDocument</a> class, and one of the Concrete subclasses, <a href="http://cvs.apache.org/viewcvs.cgi/xml-fop/src/java/org/apache/fop/rtf/rtflib/testdocs/SimpleDocument.java?rev=HEAD&content-type=text/vnd.viewcvs-markup">SimpleDocument</a> will provide the basics of how to use the package.</p>
<p>There are two basic concepts you will need to understand in order to use RTFLib:</p>
<ul>
@@ -362,7 +362,7 @@ $(document).ready(function () {
</li>
</ul>
<p>RTFLib handles the process of converting to and writing the RTF content as the document is created. All you need to do is flush the document at the end to make sure that the last pieces get written.</p>
-<h3 id="document-structure-wzxhzdk16wzxhzdk17">Document Structure # <a id="userdoc-structure"></a></h3>
+<h3 id="document-structure-wzxhzdk17wzxhzdk18">Document Structure # <a id="userdoc-structure"></a></h3>
<p><warning>This section is very incomplete.</warning>
The documentation in this section is intended to provide a high-level view of the process of building an RTF document. For more detailed API documentation of the various methods, be sure to consult the Javadocs for RTFLib.</p>
<p>The following table summarizes the various containers that can be created:</p>
@@ -444,16 +444,16 @@ The documentation in this section is int
</tr>
</tbody>
</table>
-<h3 id="attributes-wzxhzdk20wzxhzdk21">Attributes # <a id="userdoc-attributes"></a></h3>
+<h3 id="attributes-wzxhzdk21wzxhzdk22">Attributes # <a id="userdoc-attributes"></a></h3>
<p><warning>This section is very incomplete.</warning>
Attributes can be set for each container and piece of content in the document. The general approach is to build an RtfAttributes object containing the various attributes, then pass that RtfAttributes object to the method that creates the new container or content. See the Javadoc API documentation for RtfAttributes for details on the syntax for creating an RtfAttributes object. The following information lists the various attributes that can be set for each type of container.</p>
-<h4 id="information-group-wzxhzdk24wzxhzdk25">Information Group ## <a id="userdoc-attr-ig"></a></h4>
+<h4 id="information-group-wzxhzdk25wzxhzdk26">Information Group ## <a id="userdoc-attr-ig"></a></h4>
<p>These attributes are set when creating a Document.</p>
-<h4 id="document-formatting-wzxhzdk26wzxhzdk27">Document Formatting ## <a id="userdoc-attr-df"></a></h4>
+<h4 id="document-formatting-wzxhzdk27wzxhzdk28">Document Formatting ## <a id="userdoc-attr-df"></a></h4>
<p>These attributes are set when creating a Document.</p>
-<h4 id="section-formatting-wzxhzdk28wzxhzdk29">Section Formatting ## <a id="userdoc-attr-sf"></a></h4>
+<h4 id="section-formatting-wzxhzdk29wzxhzdk30">Section Formatting ## <a id="userdoc-attr-sf"></a></h4>
<p>These attributes are set when creating a Section.</p>
-<h4 id="paragraph-formatting-wzxhzdk30wzxhzdk31">Paragraph Formatting ## <a id="userdoc-attr-pf"></a></h4>
+<h4 id="paragraph-formatting-wzxhzdk31wzxhzdk32">Paragraph Formatting ## <a id="userdoc-attr-pf"></a></h4>
<p>These attributes are set when creating a Paragraph.</p>
<table>
<thead>
@@ -593,7 +593,7 @@ Attributes can be set for each container
</tr>
</tbody>
</table>
-<h4 id="character-formatting-wzxhzdk32wzxhzdk33">Character Formatting ## <a id="userdoc-attr-cf"></a></h4>
+<h4 id="character-formatting-wzxhzdk33wzxhzdk34">Character Formatting ## <a id="userdoc-attr-cf"></a></h4>
<p>These attributes are set when creating a Paragraph, or Text.</p>
<table>
<thead>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/svg.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/svg.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/svg.html Wed Oct 24 04:09:09 2012
@@ -330,10 +330,10 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-svg-issues">Apache(tm) FOP Development: SVG Issues</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-svg-issues">Apache™ FOP Development: SVG Issues</h1>
<p><version>$Revision: 1298724 $</version></p>
<p>See also <a href="../trunk/graphics.html#svg">SVG User Documentation</a> for more information.</p>
-<h2 id="examples-wzxhzdk2wzxhzdk3">Examples <a id="Examples"></a></h2>
+<h2 id="examples-wzxhzdk3wzxhzdk4">Examples <a id="Examples"></a></h2>
<p>These examples illustrate a number of issues relating to conversion to PDF:</p>
<table>
<thead>
@@ -394,9 +394,9 @@ You will need Acrobat 5.0 to see transpa
<caption>XSL:FO to PDF examples</caption>| | fo file | pdf result |
|--|---------|------------|
| embedding svg | <a href="fo/embedding.fo">embedding.fo</a> | <a href="fo/embedding.fo.pdf">embedding.fo.pdf</a> |</p>
-<h2 id="developer-notes-wzxhzdk6wzxhzdk7">Developer Notes <a id="Developer+Notes"></a></h2>
+<h2 id="developer-notes-wzxhzdk7wzxhzdk8">Developer Notes <a id="Developer+Notes"></a></h2>
<p>For most output formats in FOP the SVG is simply drawn into an image with Batik. For PDF there are a set of classes to handle drawing the <a href="http://xml.apache.org/batik/architecture.html">GVT (Graphic Vector Toolkit)</a> into PDF markup.</p>
-<h3 id="classes-wzxhzdk8wzxhzdk9">Classes # <a id="Classes"></a></h3>
+<h3 id="classes-wzxhzdk9wzxhzdk10">Classes # <a id="Classes"></a></h3>
<p>These are the relevant classes, found in the package org.apache.fop.svg :</p>
<ul>
<li>
@@ -409,7 +409,7 @@ You will need Acrobat 5.0 to see transpa
<p><em>PDFTranscoder</em> <br></br>used by Batik to transcode an svg document into a standalone pdf, via PDFDocumentGraphics2D.</p>
</li>
</ul>
-<h3 id="ideas-wzxhzdk10wzxhzdk11">Ideas # <a id="Ideas"></a></h3>
+<h3 id="ideas-wzxhzdk11wzxhzdk12">Ideas # <a id="Ideas"></a></h3>
<p>Batik can convert ttf to svg font. This svg font could be converted into a pdf stroked font (type 3 font).</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/testing.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/testing.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/testing.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-testing">Apache(tm) FOP Development: Testing</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-testing">Apache™ FOP Development: Testing</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="build-testing-wzxhzdk2wzxhzdk3">"Build" Testing <a id="build"></a></h2>
+<h2 id="build-testing-wzxhzdk3wzxhzdk4">"Build" Testing <a id="build"></a></h2>
<p>Apache™ projects use an automated build tool called "gump" to create nightly builds from the SVN repository. Gump sends "nag" messages if the build fails. This can be considered a sort of basic test of the build process. To view the most recent logs of the gump builds:</p>
<ul>
<li>
@@ -342,32 +342,32 @@ $(document).ready(function () {
<p><a href="http://gump.cocoondev.org/xml-fop-maintenance.html">Gump build for the Maintenance Branch</a> </p>
</li>
</ul>
-<h2 id="basicapi-testing-wzxhzdk5wzxhzdk6">Basic/API Testing <a id="basic"></a></h2>
+<h2 id="basicapi-testing-wzxhzdk6wzxhzdk7">Basic/API Testing <a id="basic"></a></h2>
<p>There is a group of basic API tests that are included in the build process. For these tests to occur, JUnit must be available to Ant (simply copy junit.jar into Ant's lib directory). The build will then report error(s) if the high-level APIs for Driver and the Transcoders fail. The tests do not check the output, but only ensure that something is generated and without exceptions.</p>
-<h2 id="layout-engine-testing-wzxhzdk7wzxhzdk8">Layout Engine Testing <a id="layoutengine"></a></h2>
+<h2 id="layout-engine-testing-wzxhzdk8wzxhzdk9">Layout Engine Testing <a id="layoutengine"></a></h2>
<p>The <a href="http://svn.apache.org/viewcvs.cgi/xmlgraphics/fop/trunk/test/layoutengine/"></a> directory in the repository contains a test suite for checking the functionality of Apache� FOP's layout engine. For information on how to create test cases for the layout engine, please visit the <a href="http://wiki.apache.org/xmlgraphics-fop/HowToCreateLayoutEngineTests">Wiki page</a> .</p>
-<h2 id="functional-testing-wzxhzdk9wzxhzdk10">Functional Testing <a id="functional"></a></h2>
+<h2 id="functional-testing-wzxhzdk10wzxhzdk11">Functional Testing <a id="functional"></a></h2>
<p><warning>The "functional" testing section on this page is currently inoperative.</warning></p>
-<h2 id="running-and-using-tests-wzxhzdk13wzxhzdk14">Running and Using Tests # <a id="Running+and+Using+Tests"></a></h2>
+<h2 id="running-and-using-tests-wzxhzdk14wzxhzdk15">Running and Using Tests # <a id="Running+and+Using+Tests"></a></h2>
<p>Testing is an important part of getting FOP to operate correctly and conform to the necessary standards.</p>
<p>A testing system has been set up that works with as a build target when developing with FOP. A developer can run the tests after making changes to the code, the aim is to have the tests run to verfiy that nothing working has been broken.</p>
<p>To setup the testing the developer must place a reference fop.jar in the "<cvs_repository>/test/reference/" directory. This jar will be dynamically loaded to create the reference output.</p>
-<h3 id="w3c-testsuite-wzxhzdk16wzxhzdk17">W3C TestSuite # <a id="W3C+TestSuite"></a></h3>
+<h3 id="w3c-testsuite-wzxhzdk17wzxhzdk18">W3C TestSuite # <a id="W3C+TestSuite"></a></h3>
<p>The testing is set up so that you can download the testsuite from<jump href="http://www.w3.org/Style/XSL/TestSuite/">http://www.w3.org/Style/XSL/TestSuite/</jump>, unzip the file into the base directory of FOP. Then you can uncomment the lines in the build.xml file in the test target and itwill run through all the tests in the testsuite distribution.</p>
-<h3 id="writing-a-test-wzxhzdk20wzxhzdk21">Writing a Test # <a id="Writing+a+Test"></a></h3>
+<h3 id="writing-a-test-wzxhzdk21wzxhzdk22">Writing a Test # <a id="Writing+a+Test"></a></h3>
<p>A test belongs to one of a few catagories. A basic test should excercise one element in a number of situations such as changing a property. This should have at least one normal value, one border value and one invalid value. If the property can be of different types then this should also be included.</p>
<p>A bug test is a test that is specifically aimed at a problem with FOP. That is, the test is not excercising the specification but rather a problem with FOP in handling a particular situation that is not exposed with the other testing.</p>
<p>A system test is one that tests the abitlity of FOP to handle a number of different elements together.</p>
<p>A test can consist of a complete fo document or a part of the document such as some elements that will be placed into the flow of a standard document.</p>
-<h3 id="submitting-a-test-wzxhzdk22wzxhzdk23">Submitting a Test # <a id="Submitting+a+Test"></a></h3>
+<h3 id="submitting-a-test-wzxhzdk23wzxhzdk24">Submitting a Test # <a id="Submitting+a+Test"></a></h3>
<p>If you have a test which you think would be useful you should supply the test and a diff to the appropriate test suite xml file. Make sure that the test works as would be expected against the current build.</p>
-<h3 id="how-testing-works-wzxhzdk24wzxhzdk25">How Testing Works # <a id="How+Testing+Works"></a></h3>
+<h3 id="how-testing-works-wzxhzdk25wzxhzdk26">How Testing Works # <a id="How+Testing+Works"></a></h3>
<p>The tests are stored in the "<svn_repository>/test" directory.</p>
<p>You can run the tests by specifying the build target "test" ie:<br></br> <code>ant.sh test</code> (Unix)<br></br> <code>ant test</code> (Windows)<br></br></p>
<p>This will then compare the current code in the local src directory to a specified release of FOP. Any differences between the current code and the output from the reference version will be reported. If the test previously passed then the test run will have failed.</p>
<p>The testing is done by reading a test suite xml file, which corresponds to the standard testsuite.dtd supplied from w3c. This xml file contains a test xml file and an xsl file (which may simply copy the file). It also contains information such as if the test has passed and any comments.</p>
<p>For FOP the testing is done by rendering all the testing documents using the XML renderer. The XML files are then compared to see if there are any differences.</p>
-<h3 id="svg-testing-wzxhzdk33wzxhzdk34">SVG Testing # <a id="SVG+Testing"></a></h3>
+<h3 id="svg-testing-wzxhzdk34wzxhzdk35">SVG Testing # <a id="SVG+Testing"></a></h3>
<p>The testing of SVG is not part of this testing system. SVG is tested for its rendering accuracy by using the transcoding mechanism via <a href="http://xmlgraphics.apache.org/batik/">Apache Batik</a> . So that the only part that needs testing is how the SVG image is embedded inside the flow of the fo document.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/dev/tools.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/dev/tools.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/dev/tools.html Wed Oct 24 04:09:09 2012
@@ -330,10 +330,10 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a> » <a href="/fop/dev/">Dev</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-development-developer-tools">Apache(tm) FOP Development: Developer Tools</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-development-developer-tools">Apache™ FOP Development: Developer Tools</h1>
<p><version>$Revision: 1298724 $</version></p>
<p>This page documents items that may be helpful to other developers, especially to those who are new to Apache™ FOP. Exhaustive treatment of these topics is better suited to other fora, but the information presented here is intended to deal with FOP-specific issues related to these tools, especially "gotchas", and to help developers get jump-started.</p>
-<h2 id="developer-checklist-wzxhzdk3wzxhzdk4">Developer Checklist <a id="checklist"></a></h2>
+<h2 id="developer-checklist-wzxhzdk4wzxhzdk5">Developer Checklist <a id="checklist"></a></h2>
<p>Here is a (probably not comprehensive) list of tools you will need to be a successful FOP developer:</p>
<ul>
<li>
@@ -352,17 +352,17 @@ $(document).ready(function () {
<p>JUnit (see <a href="testing.html#basic">Basic Testing</a> ).</p>
</li>
</ul>
-<h2 id="general-developer-information-wzxhzdk5wzxhzdk6">General Developer Information <a id="general"></a></h2>
+<h2 id="general-developer-information-wzxhzdk6wzxhzdk7">General Developer Information <a id="general"></a></h2>
<p>See <a href="http://www.apache.org/dev/contributors.html">the Apache Contributors Tech Guide</a> for useful information and links for Apache developers, including help with tools and procedures.</p>
-<h2 id="subversion-svn-wzxhzdk7wzxhzdk8">Subversion (SVN) <a id="svn"></a></h2>
-<h3 id="general-wzxhzdk9wzxhzdk10">General # <a id="svn_general"></a></h3>
+<h2 id="subversion-svn-wzxhzdk8wzxhzdk9">Subversion (SVN) <a id="svn"></a></h2>
+<h3 id="general-wzxhzdk10wzxhzdk11">General # <a id="svn_general"></a></h3>
<p>Visit <a href="http://xmlgraphics.apache.org/repo.html">Apache XML Graphics Code Repositories</a> for useful information.</p>
<p>You will need a SVN client to be able to gain access to the FOP repository. For general SVN information, visit <a href="http://subversion.tigris.org">Subversion Home</a> . A comprehensive list of clients for all operating systems and many IDEs can be found at <a href="http://subversion.tigris.org/project_links.html">the Subversion Links page</a> . For Microsoft Windows we recommend <a href="http://tortoisesvn.tigris.org">TortoiseSVN</a> . The command-line client that comes with Subversion is also very easy to use.</p>
-<h3 id="step-by-step-instruction-for-downloading-fop-using-the-svn-command-line-client-wzxhzdk11wzxhzdk12">Step-by-step instruction for downloading FOP using the SVN command-line client # <a id="svn_download"></a></h3>
+<h3 id="step-by-step-instruction-for-downloading-fop-using-the-svn-command-line-client-wzxhzdk12wzxhzdk13">Step-by-step instruction for downloading FOP using the SVN command-line client # <a id="svn_download"></a></h3>
<p>On the command-line (Windows or Unix), simply run:</p>
<p>svn co http://svn.apache.org/repos/asf/xmlgraphics/fop/trunk/ fop-trunk</p>
<p>This will download the FOP trunk into the directory "fop-trunk".</p>
-<h3 id="step-by-step-instructions-for-downloading-fop-using-tortoisesvn-on-windows-wzxhzdk13wzxhzdk14">Step-by-step instructions for downloading FOP using TortoiseSVN (on Windows) # <a id="tortoisesvn_download"></a></h3>
+<h3 id="step-by-step-instructions-for-downloading-fop-using-tortoisesvn-on-windows-wzxhzdk14wzxhzdk15">Step-by-step instructions for downloading FOP using TortoiseSVN (on Windows) # <a id="tortoisesvn_download"></a></h3>
<ul>
<li>
<p>Create a new, empty directory in a place of your choice.</p>
@@ -377,7 +377,7 @@ $(document).ready(function () {
<p>Click "OK" and the download should begin.</p>
</li>
</ul>
-<h3 id="creating-patches-wzxhzdk15wzxhzdk16">Creating Patches # <a id="patches"></a></h3>
+<h3 id="creating-patches-wzxhzdk16wzxhzdk17">Creating Patches # <a id="patches"></a></h3>
<ul>
<li>
<p><code>cd</code> to a directory that contains all of the changes that you wish to include in the patch. To comprehend the entire distribution, <code>cd</code> to the top directory where you checked out the sources.</p>
@@ -392,7 +392,7 @@ $(document).ready(function () {
<p>If you are running TortoiseSVN, you can select "Create Patch..." in the TortoiseSVN context menu.</p>
</li>
</ul>
-<h3 id="documentation-wzxhzdk17wzxhzdk18">Documentation # <a id="svn-doc"></a></h3>
+<h3 id="documentation-wzxhzdk18wzxhzdk19">Documentation # <a id="svn-doc"></a></h3>
<ul>
<li>
<p>[online resource]<jump href="http://subversion.tigris.org">The Subversion Home Page</jump>.</p>
@@ -404,7 +404,7 @@ $(document).ready(function () {
<p>[online resource]<jump href="http://subversion.tigris.org/project_links.html">Comprehensive list of links to documentation and Subversion clients and plugins.</jump></p>
</li>
</ul>
-<h2 id="integrated-development-environments-ides-wzxhzdk19wzxhzdk20">Integrated Development Environments (IDEs) <a id="ide"></a></h2>
+<h2 id="integrated-development-environments-ides-wzxhzdk20wzxhzdk21">Integrated Development Environments (IDEs) <a id="ide"></a></h2>
<p>An IDE is not required, but will generally be found to be helpful, especially for serious debugging and refactoring.</p>
<p>Borland's JBuilder 7/8 does not support Ant builds unless you have the Enterprise Edition (which is quite expensive). This causes problems with any code that is generated by the Ant build. First, you must run the Ant build before you can use the IDE. Second, when you are editing in the IDE, you must be editing the generated files, which means that you must make any changes to the source files in another editor. This is less serious for development on the trunk, but in the maintenance branch, all source files were "generated".</p>
<p>Sun ONE Studio Four does support Ant, but seems to use a built-in version, and as of this writing chokes on the FOP build file, saying that it is not valid. There is awkward because there is no official DTD for Ant, and it may be merely an Ant version issue.</p>
Modified: websites/staging/xmlgraphics/trunk/content/fop/download.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/download.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/download.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-downloading-a-distribution">Apache(tm) FOP: Downloading A Distribution</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-downloading-a-distribution">Apache™ FOP: Downloading A Distribution</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="binary-or-source-wzxhzdk2wzxhzdk3">Binary or Source? <a id="dist-type"></a></h2>
+<h2 id="binary-or-source-wzxhzdk3wzxhzdk4">Binary or Source? <a id="dist-type"></a></h2>
<p>Most Apache™ FOP users will want to download the latest binary distribution, which is ready to run "out of the box." However, a source distribution will be preferable if you fall into one of the following categories:</p>
<ul>
<li>
@@ -345,9 +345,9 @@ $(document).ready(function () {
<p>You wish to build a local copy of the API documentation (javadocs).</p>
</li>
</ul>
-<h2 id="binary-download-wzxhzdk5wzxhzdk6">Binary Download <a id="binary"></a></h2>
+<h2 id="binary-download-wzxhzdk6wzxhzdk7">Binary Download <a id="binary"></a></h2>
<p>Binary distributions include "-bin" in their names, and can be downloaded from a <a href="http://www.apache.org/dyn/closer.cgi/xmlgraphics/fop">FOP Distribution mirror</a> . Nightly builds of trunk code can be downloaded here: <a href="http://ci.apache.org/projects/xmlgraphics/fop/snapshots/">Nightly Snapshots</a> .</p>
-<h2 id="source-download-wzxhzdk7wzxhzdk8">Source Download <a id="source"></a></h2>
+<h2 id="source-download-wzxhzdk8wzxhzdk9">Source Download <a id="source"></a></h2>
<p>There are several ways to obtain a source distribution. Please note that they are listed from least current to most current:</p>
<ul>
<li>
@@ -400,7 +400,7 @@ $(document).ready(function () {
</tbody>
</table>
<p>With any source distribution, you will need to build FOP from the source files. For details please see the "Build" page on the documentation tab for the version you've downloaded.</p>
-<h2 id="archive-download-wzxhzdk9wzxhzdk10">Archive Download <a id="archives"></a></h2>
+<h2 id="archive-download-wzxhzdk10wzxhzdk11">Archive Download <a id="archives"></a></h2>
<p>FOP Archive distributions are linked from the upper portion of the Apache FOP Download Mirror Page and can be downloaded from the FOP Archives <a href="http://archive.apache.org/dist/xmlgraphics/fop/binaries/">binaries</a> & <a href="http://archive.apache.org/dist/xmlgraphics/fop/source/">source</a> links.</p></div>
</div>
Modified: websites/staging/xmlgraphics/trunk/content/fop/examples.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/examples.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/examples.html Wed Oct 24 04:09:09 2012
@@ -330,9 +330,9 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-examples">Apache(tm) FOP Examples</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk0-fop-examples">Apache™ FOP Examples</h1>
<p><version>$Revision: 1298724 $</version></p>
-<h2 id="example-documents-using-apachewzxhzdk4-fop-wzxhzdk2wzxhzdk3">Example Documents Using Apache™ FOP <a id="Example+Documents+Using+Apache%E2%84%A2+FOP"></a></h2>
+<h2 id="example-documents-using-apachewzxhzdk5-fop-wzxhzdk3wzxhzdk4">Example Documents Using Apache™ FOP <a id="Example+Documents+Using+Apache%E2%84%A2+FOP"></a></h2>
<p>These examples have been rendered using Apache™ FOP:</p>
<table>
<thead>
@@ -399,7 +399,7 @@ $(document).ready(function () {
</ul>
<p>Also, in the directory examples/fo/pagination you will find a suite of examples showing the use of XSL-FO pagination.</p>
<p>Developers will find the first steps to a test suite for all implemented formatting objects and properties in test/xml in the source distribution.</p>
-<h2 id="images-examples-wzxhzdk6wzxhzdk7">Images Examples <a id="Images+Examples"></a></h2>
+<h2 id="images-examples-wzxhzdk7wzxhzdk8">Images Examples <a id="Images+Examples"></a></h2>
<p>Embedding images in FO:</p>
<table>
<thead>
@@ -436,7 +436,7 @@ $(document).ready(function () {
</tbody>
</table>
<p>Look also into the directory examples/fo/svg. There you find some very extensive SVG examples.</p>
-<h2 id="instream-foreign-object-examples-wzxhzdk8wzxhzdk9">Instream Foreign Object Examples <a id="Instream+Foreign+Object+Examples"></a></h2>
+<h2 id="instream-foreign-object-examples-wzxhzdk9wzxhzdk10">Instream Foreign Object Examples <a id="Instream+Foreign+Object+Examples"></a></h2>
<p>Instream Foreign Object images in FO, there are more on the <a href="dev/svg.html">SVG Page</a> :</p>
<table>
<thead>
Modified: websites/staging/xmlgraphics/trunk/content/fop/fo.html
==============================================================================
--- websites/staging/xmlgraphics/trunk/content/fop/fo.html (original)
+++ websites/staging/xmlgraphics/trunk/content/fop/fo.html Wed Oct 24 04:09:09 2012
@@ -330,12 +330,12 @@ $(document).ready(function () {
<div id="content" class="grid_16">
<!-- <div id="breadcrumb"><a href="/">Home</a> » <a href="/fop/">Fop</a></div> -->
- <div class="section-content"><h1 id="apachetm-fop-xsl-fo-input">Apache(tm) FOP: XSL-FO Input</h1>
+ <div class="section-content"><h1 id="apachewzxhzdk1-fop-xsl-fo-input">Apache™ FOP: XSL-FO Input</h1>
<p><subtitle>Basic Help for Using XML, XSLT, and XSL-FO</subtitle><version>$Revision: 1298724 $</version></p>
-<h2 id="overview-wzxhzdk5wzxhzdk6">Overview <a id="overview"></a></h2>
+<h2 id="overview-wzxhzdk6wzxhzdk7">Overview <a id="overview"></a></h2>
<p>Apache™ FOP uses XSL-FO as input. It is the responsibility of the user to make sure that the XSL-FO submitted to FOP is correct. The tutorial items presented here are not comprehensive, but are of the FAQ variety. Another good FAQ is<fork href="http://www.dpawson.co.uk/xsl/">Dave Pawson's XSL FAQ</fork>.</p>
-<h2 id="xml-issues-wzxhzdk10wzxhzdk11">XML Issues <a id="xml"></a></h2>
-<h3 id="special-characters-wzxhzdk12wzxhzdk13">Special Characters # <a id="xml-special-chars"></a></h3>
+<h2 id="xml-issues-wzxhzdk11wzxhzdk12">XML Issues <a id="xml"></a></h2>
+<h3 id="special-characters-wzxhzdk13wzxhzdk14">Special Characters # <a id="xml-special-chars"></a></h3>
<p>When entering special (non-ASCII) characters in XML, the general rule is to use the applicable Unicode character instead of trying to use a character entity as you would with HTML. Remember that HTML is an SGML document type. SGML has a limited character set, which requires it to use character entities to represent special characters. One of the improvements of XML over SGML (and thus HTML) is native support for Unicode. Basic XML has only a handful of character entities, primarily because it doesn't really need more.</p>
<p>Entities such as <code>&uuml;</code> (u with an umlaut), which work in HTML, will be flagged as undefined entities unless you define them yourself in your DTD. Use the corresponding Unicode character instead. A list of predefined HTML entities and their Unicode codepoints can be found at <a href="http://www.w3.org/TR/html4/sgml/entities.html">Character entity references in HTML 4</a> .</p>
<p>One common example is <code>&nbsp;</code> , used to obtain a non-breaking space in HTML. In XML, use   instead.</p>
@@ -344,14 +344,14 @@ $(document).ready(function () {
€
Getting your XML correctly encoded is only part of the job. If you want the character to display or print correctly (and you probably do), then the selected font must contain the necessary glyph. Because of differences between font encoding methods, and limitations in some font technologies, this can be a troublesome issue, especially for symbol characters. The FOP example file <a href="fo/fonts.fo.pdf">Base-14 Font Character Mapping</a> is a very useful resource in sorting these issues out for the Base-14 fonts. For other fonts, use font editing sofware or operating system utilities (such as the Character Map in most Windows platforms) to determine what characters the font supports.</p>
<p>An alternative to encoding the character and making it available through a font is to use an embedded graphic to represent the character: GIF, PNG, SVG, etc.</p>
-<h3 id="entity-characters-wzxhzdk16wzxhzdk17">Entity Characters # <a id="xml-entity-chars"></a></h3>
+<h3 id="entity-characters-wzxhzdk17wzxhzdk18">Entity Characters # <a id="xml-entity-chars"></a></h3>
<p>The handful of basic XML character entities that do exist are the ampersand, apostrophe, less-than, greater-than, and single-quote characters. These are needed to distinguish markup tags from content, and to distinguish character entities from content. To avoid parser complaints about illegal characters and entities in your input, ensure that ampersands in text and attributes are written as &, "<" is written as <, and ">" as >. It is not necessary everywhere, but it is wise to do so anyway, just to be sure.</p>
<p>Most XML parsers will provide a line number and sometimes a column number for offending characters.</p>
<p>Review the <a href="http://www.w3.org/XML/">XML Specification</a> or a good tutorial for details of the XML file format.</p>
-<h3 id="encoding-issues-wzxhzdk21wzxhzdk22">Encoding Issues # <a id="xml-encoding"></a></h3>
+<h3 id="encoding-issues-wzxhzdk22wzxhzdk23">Encoding Issues # <a id="xml-encoding"></a></h3>
<p>If the parser complains about illegal bytes or characters in the input, or there are unexpected characters in the output, this is usually the result of a character encoding problem. See the <a href="http://www.dpawson.co.uk/xsl">XSL FAQ</a> for additional information. Many software packages that produce XML, including XSLT processors, use UTF-8 encoding as a default. If you view their output with something not aware of the encoding, like Notepad for Win95/98/ME/NT, funny characters are displayed. A � is a giveaway.</p>
-<h2 id="xslt-issues-wzxhzdk23wzxhzdk24">XSLT Issues <a id="xslt"></a></h2>
-<h3 id="current-date-and-time-wzxhzdk25wzxhzdk26">Current Date and Time # <a id="xslt-date"></a></h3>
+<h2 id="xslt-issues-wzxhzdk24wzxhzdk25">XSLT Issues <a id="xslt"></a></h2>
+<h3 id="current-date-and-time-wzxhzdk26wzxhzdk27">Current Date and Time # <a id="xslt-date"></a></h3>
<p>XSL-FO does not currently have a function for retrieving the current date and time. However, in some cases, XSLT can be used to place the current date and time into the XSL-FO document as it is generated.</p>
<p>One possibility is to use the<jump href="http://exslt.org/date/index.html">exslt date and time extension</jump>.</p>
<p>Another possibility is to use java or javascript (or perhaps some other language). Here is an example, using java, that works with Xalan. First, create the appropriate namespace:
@@ -364,8 +364,8 @@ Next, use the java language to retrieve
<xsl:value-of select="java:format(java:java.text.SimpleDateFormat.new
('MMMM d, yyyy, h:mm:ss a (zz)'), java:java.util.Date.new())"/>
</xsl:template></p>
-<h1 id="xsl-fo-issues-wzxhzdk32wzxhzdk33">XSL-FO Issues <a id="xsl-fo"></a></h1>
-<h3 id="vertical-centering-wzxhzdk34wzxhzdk35">Vertical Centering # <a id="fo-center-vertical"></a></h3>
+<h1 id="xsl-fo-issues-wzxhzdk33wzxhzdk34">XSL-FO Issues <a id="xsl-fo"></a></h1>
+<h3 id="vertical-centering-wzxhzdk35wzxhzdk36">Vertical Centering # <a id="fo-center-vertical"></a></h3>
<p>To vertically center an image, table, or other item, use display-align="center". See <a href="compliance.html#fo-property-display-align">display-align Compliance</a> for implementation status. Here is a small, self-contained document centering an image on a page:
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">
@@ -392,7 +392,7 @@ Next, use the java language to retrieve
</fo:flow>
</fo:page-sequence>
</fo:root></p>
-<h2 id="horizontal-centering-tables-wzxhzdk59wzxhzdk60">Horizontal Centering (Tables) # <a id="fo-center-table-horizon"></a></h2>
+<h2 id="horizontal-centering-tables-wzxhzdk60wzxhzdk61">Horizontal Centering (Tables) # <a id="fo-center-table-horizon"></a></h2>
<p>To center a table horizontally, one possibility is to add one column on the left and one on the right which pad the table so that the visible part is centered:
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">
@@ -420,9 +420,9 @@ Next, use the java language to retrieve
</fo:page-sequence>
</fo:root>
If your table is more complicated, or if defining borders on individual cells becomes too much work, use the code above and nest your table within the middle cell.</p>
-<h3 id="right-aligning-tables-wzxhzdk85wzxhzdk86">Right-Aligning (Tables) # <a id="fo-right-align-table-horizon"></a></h3>
+<h3 id="right-aligning-tables-wzxhzdk86wzxhzdk87">Right-Aligning (Tables) # <a id="fo-right-align-table-horizon"></a></h3>
<p>To right-align a table, you can use the same approach as above for centering tables. Just remove the last table-column element which causes all the left-over space not used by the columns with a fixed column-width to be assigned to the first column which effectively right-aligns the table.</p>
-<h3 id="rectoverso-static-content-differences-wzxhzdk87wzxhzdk88">Recto/Verso Static Content Differences # <a id="fo-oddeven"></a></h3>
+<h3 id="rectoverso-static-content-differences-wzxhzdk88wzxhzdk89">Recto/Verso Static Content Differences # <a id="fo-oddeven"></a></h3>
<p>One frequent request is that static content be different between recto pages (right-side or odd-numbered pages typically) and verso pages(left-side or even-numbered pages typically). For example, you may wish to place the page number on the "outer" side of each page. There are examples in the FO distribution and in the <a href="http://www.dpawson.co.uk/xsl/sect3/index.html">XSL FAQ FO section</a> .</p>
<p>First, define a page master with alternating pages masters for odd and even pages. Then specify appropriate regions in these page masters, giving them different names. Use these names to put different static content in these regions. Here is a self-contained demonstration:
<?xml version="1.0"?>
@@ -464,7 +464,7 @@ If your table is more complicated, or if
</fo:flow>
</fo:page-sequence>
</fo:root></p>
-<h2 id="making-the-first-page-special-wzxhzdk123wzxhzdk124">Making the First Page Special # <a id="fo-first-page"></a></h2>
+<h2 id="making-the-first-page-special-wzxhzdk124wzxhzdk125">Making the First Page Special # <a id="fo-first-page"></a></h2>
<p>To get a special header on the first page, one possibility is to insert it into the flow instead of the static content. Alternatively, use a page master referring to different page masters for the first page and the rest. Here is a code sample:
<?xml version="1.0"?>
<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format">
@@ -506,7 +506,7 @@ If your table is more complicated, or if
</fo:flow>
</fo:page-sequence>
</fo:root></p>
-<h2 id="blank-pages-wzxhzdk158wzxhzdk159">Blank Pages # <a id="fo-blank-pages"></a></h2>
+<h2 id="blank-pages-wzxhzdk159wzxhzdk160">Blank Pages # <a id="fo-blank-pages"></a></h2>
<p>Sometimes it is desirable to insert blank pages within your output, starting, for example, a new chapter on an odd page or an even page. A blank page can be forced by using <code>break-before="page-even"</code> or similar properties, or by a force-page-count="end-on-odd" on a page sequence.</p>
<p>To write "This page is intentionally left blank" (or something similar) on an intentionally blank page, first define a conditional page master with a page master specific for blank pages. This allows you to specify static content for blank pages (by definition, a page is blank if no content from a flow is rendered on the page). Omit your normal headers and footers, and use (for example) an extended header to print the "..left blank" statement:
<?xml version="1.0"?>
@@ -548,9 +548,9 @@ If your table is more complicated, or if
</fo:flow>
</fo:page-sequence>
</fo:root></p>
-<h2 id="preformatting-content-wzxhzdk191wzxhzdk192">Preformatting Content # <a id="fo-preformat"></a></h2>
+<h2 id="preformatting-content-wzxhzdk192wzxhzdk193">Preformatting Content # <a id="fo-preformat"></a></h2>
<p>Sometimes it is desirable to retain linebreaks and hard spaces, and to get preformatted text to pass through without being changed. The XSL-FO specification provides some properties for this: <a href="http://www.w3.org/TR/xsl11/#white-space-collapse">white-space-collapse</a> and <a href="http://www.w3.org/TR/2001/REC-xsl-20011015/slice7.html#white-space-collapse">linefeed-treatment</a> . In FOP, use white-space-collapse="false" on an enclosing block.</p>
-<h3 id="total-document-pages-wzxhzdk193wzxhzdk194">Total Document Pages # <a id="fo-total-pages"></a></h3>
+<h3 id="total-document-pages-wzxhzdk194wzxhzdk195">Total Document Pages # <a id="fo-total-pages"></a></h3>
<p>It is frequently desirable to know the total number of pages in a document and to use that number within the document. For example, you might wish to show the page number on the first page as being "page 1 of 12".</p>
<p>To accomplish this in <strong>XSL 1.0</strong> , place an empty block with an id at the end of the flow:
<fo:flow ...>
@@ -615,10 +615,10 @@ import javax.xml.transform.stream.</em>;
}
Declare and use the parameter "page-count" in your XSLT.
<warning>It is possible to run into a convergence problem with this solution. Replacing the "#" placeholder in the first run with the actual page count in the second run, may change the total number of pages in the document.</warning></p>
-<h2 id="aligning-regions-wzxhzdk204wzxhzdk205">Aligning Regions # <a id="fo-region-align"></a></h2>
+<h2 id="aligning-regions-wzxhzdk205wzxhzdk206">Aligning Regions # <a id="fo-region-align"></a></h2>
<p>Although it may seem counterintuitive, the regions on a page may overlap. Defining a certain body region does not automatically constrain other regions. Instead, this has to be done explicitly. Sometimes for creative reasons it may be desirable to have the regions overlap. Otherwise, you will want to set them up so that the header does not overlap body content or the body extend into the footer.</p>
<p>Assuming you wish to keep the regions separate, if you have a header region with an extent of 20mm, you should define a margin for the body region of at least 20mm too. Otherwise the header content may overwrite some stuff in the body region. This applies similarly to the extent of the after region and the bottom margin of the body region.</p>
-<h3 id="drawing-lines-wzxhzdk206wzxhzdk207">Drawing Lines # <a id="fo-lines"></a></h3>
+<h3 id="drawing-lines-wzxhzdk207wzxhzdk208">Drawing Lines # <a id="fo-lines"></a></h3>
<p>It is frequently desirable to draw lines in a document, as separators, side bars or folding marks. There are several possibilities:</p>
<ul>
<li>
@@ -631,10 +631,10 @@ Declare and use the parameter "page-coun
<p>Insert a graphic. GIF, PNG SVG, whatever.</p>
</li>
</ul>
-<h3 id="validating-xsl-fo-wzxhzdk208wzxhzdk209">Validating XSL-FO # <a id="fo-validate"></a></h3>
+<h3 id="validating-xsl-fo-wzxhzdk209wzxhzdk210">Validating XSL-FO # <a id="fo-validate"></a></h3>
<p><a href="http://www.renderx.com">RenderX</a> has provided an <a href="http://www.renderx.com/Tests/validator/fo.dtd.html">Unofficial DTD for FO Documents</a> , which may be helpful in validating general FO issues.</p>
<p>FOP also maintains an <a href="http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/foschema/fop.xsd?view=co">Unofficial FOP Schema</a> in the FOP Subversion Repository. This document can be used either to validate against the FO standard, or against the actual FOP implementation. See the notes near the beginning of the document for instructions on how to use it.</p>
-<h3 id="producing-landscape-pages-wzxhzdk210wzxhzdk211">Producing landscape pages # <a id="landscape"></a></h3>
+<h3 id="producing-landscape-pages-wzxhzdk211wzxhzdk212">Producing landscape pages # <a id="landscape"></a></h3>
<p>Pages in landscape format can easily be produced by exchanging the page-height and page-width values of a simple-page-master element.
<fo:layout-master-set>
<fo:simple-page-master master-name="A4-portrait" page-height="29.7cm" page-width="21cm" [..]>
@@ -644,7 +644,7 @@ Declare and use the parameter "page-coun
<fo:region-body/>
</fo:simple-page-master>
</fo:layout-master-set></p>
-<h2 id="external-resources-wzxhzdk220wzxhzdk221">External Resources # <a id="external-resources"></a></h2>
+<h2 id="external-resources-wzxhzdk221wzxhzdk222">External Resources # <a id="external-resources"></a></h2>
<p>Resources needed by an XSL-FO file that are external to it (graphics, for example), are defined in the XSL-FO standard as being of type "uri-specification". This is defined in the standard at<jump href="http://www.w3.org/TR/xsl11/#datatype">Section 5.11 Property Datatypes</jump>, which includes a link to the URI standard itself. Refer to the XSL-FO and URI standards themselves for more detailed instructions.</p>
<p>URIs may be either absolute or relative to a base URI. (See <a href="1.0/configuration.html">FOP: Configuration</a> for information on setting the base URI for a FOP session). Here is an example referencing an external-graphic that is relative to the base URI:
<fo:external-graphic src="url('images/logo.jpg')"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org