aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/trunk
diff options
context:
space:
mode:
authorVincent Hennebert <vhennebert@apache.org>2007-08-23 18:30:05 +0000
committerVincent Hennebert <vhennebert@apache.org>2007-08-23 18:30:05 +0000
commit99cfed96f71c2deff9afdf30c71f93c2ca30d005 (patch)
tree960682f0658c15dcddf2ec5f615c7c0f179ee7f1 /src/documentation/content/xdocs/trunk
parentaa33ef3ebb6e48dae2da620f596d34d7548bf402 (diff)
downloadxmlgraphics-fop-99cfed96f71c2deff9afdf30c71f93c2ca30d005.tar.gz
xmlgraphics-fop-99cfed96f71c2deff9afdf30c71f93c2ca30d005.zip
Merged revisions 556567-558280,558282-562946,562948-563926,563928-563950,563952-563955,563957-564855,564857-567293,567295-567296,567298-567302,567304-569099 via svnmerge from
https://svn.apache.org/repos/asf/xmlgraphics/fop/branches/fop-0_94 ........ r560595 | vhennebert | 2007-07-28 21:26:51 +0200 (sam, 28 jui 2007) | 2 lines Remove tab for the no longer supported 0.20.5 version ........ r560596 | vhennebert | 2007-07-28 21:28:30 +0200 (sam, 28 jui 2007) | 2 lines Create a tab for the new 0.94 version ........ r560600 | vhennebert | 2007-07-28 21:45:13 +0200 (sam, 28 jui 2007) | 2 lines Remove any reference to the old maintenance branch ........ r560886 | vhennebert | 2007-07-30 10:19:59 +0200 (lun, 30 jui 2007) | 2 lines Update the documentation before releasing ........ r562023 | clay | 2007-08-02 08:08:49 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562024 | clay | 2007-08-02 08:09:33 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562027 | clay | 2007-08-02 08:27:01 +0200 (jeu, 02 aoû 2007) | 1 line Changes to fop-0_94 branch to prepare it for 0.94 release. ........ r562332 | clay | 2007-08-03 07:09:50 +0200 (ven, 03 aoû 2007) | 1 line Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information. ........ r562333 | clay | 2007-08-03 07:10:47 +0200 (ven, 03 aoû 2007) | 1 line Updated FOP Compliance page to include additional column for 0.94 (did not remove 0.20.5 or 0.93 column). Also 'Notes' column was *not* modified for 0.94-specific information. ........ r562880 | vhennebert | 2007-08-05 17:05:41 +0200 (dim, 05 aoû 2007) | 4 lines - Update the website content - Fix some typos - Fix broken links ........ r562881 | vhennebert | 2007-08-05 17:06:59 +0200 (dim, 05 aoû 2007) | 5 lines Changes in the trunk tab: - update content - fix typos - fix broken links ........ r562887 | vhennebert | 2007-08-05 17:22:15 +0200 (dim, 05 aoû 2007) | 2 lines Merge changes on the Trunk tab from revision 562881 ........ r562891 | vhennebert | 2007-08-05 17:32:33 +0200 (dim, 05 aoû 2007) | 4 lines Update the list of known issues: - border-collapsing model for tables is available - internal links point to the exact location ........ r562900 | vhennebert | 2007-08-05 17:48:50 +0200 (dim, 05 aoû 2007) | 2 lines Setup the "known issues" infrastructure for the 0.94 tab ........ r562903 | vhennebert | 2007-08-05 18:23:59 +0200 (dim, 05 aoû 2007) | 2 lines Style only: remove tab characters ........ r562909 | vhennebert | 2007-08-05 19:11:58 +0200 (dim, 05 aoû 2007) | 2 lines Disable "Valid HTML" icons. The site isn't valid... ........ r562919 | vhennebert | 2007-08-05 19:52:13 +0200 (dim, 05 aoû 2007) | 3 lines Disable any link to relnotes.html. This file is not properly placed (in no tab), and only contains release notes for versions up to 0.92. TODO determine what to do with this file; newer versions have their own system ........ r562924 | vhennebert | 2007-08-05 20:09:44 +0200 (dim, 05 aoû 2007) | 2 lines Add a link to the Release Notes for version 0.94 ........ r562925 | vhennebert | 2007-08-05 20:10:34 +0200 (dim, 05 aoû 2007) | 2 lines Replace "Apache Forrest" with "Apache FOP". Copy-paste error? ........ r564159 | vhennebert | 2007-08-09 11:56:41 +0200 (jeu, 09 aoû 2007) | 2 lines Introduce 0.94 in status.xml and README ........ r564233 | vhennebert | 2007-08-09 17:09:49 +0200 (jeu, 09 aoû 2007) | 2 lines Update the compliance page ........ r564864 | vhennebert | 2007-08-11 10:41:15 +0200 (sam, 11 aoû 2007) | 2 lines Fix error that made the 0.94 menu appear in the Trunk tab and vice-versa ........ r564866 | vhennebert | 2007-08-11 10:45:39 +0200 (sam, 11 aoû 2007) | 2 lines Add my key for signing the release ........ r564871 | vhennebert | 2007-08-11 10:51:35 +0200 (sam, 11 aoû 2007) | 2 lines Update dependency on version 1.2 of XML Graphics Commons ........ r567299 | vhennebert | 2007-08-18 19:23:09 +0200 (sam, 18 aoû 2007) | 2 lines Update .htaccess to 0.94 release ........ r567539 | clay | 2007-08-20 06:12:42 +0200 (lun, 20 aoû 2007) | 1 line Added formatting for code in page. ........ git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@569104 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs/trunk')
-rw-r--r--src/documentation/content/xdocs/trunk/compiling.xml5
-rw-r--r--src/documentation/content/xdocs/trunk/configuration.xml36
-rw-r--r--src/documentation/content/xdocs/trunk/extensions.xml6
-rw-r--r--src/documentation/content/xdocs/trunk/fonts.xml14
-rw-r--r--src/documentation/content/xdocs/trunk/graphics.xml1
-rw-r--r--src/documentation/content/xdocs/trunk/output.xml3
-rw-r--r--src/documentation/content/xdocs/trunk/pdfencryption.xml4
-rw-r--r--src/documentation/content/xdocs/trunk/running.xml49
-rw-r--r--src/documentation/content/xdocs/trunk/upgrading.xml16
9 files changed, 58 insertions, 76 deletions
diff --git a/src/documentation/content/xdocs/trunk/compiling.xml b/src/documentation/content/xdocs/trunk/compiling.xml
index 76d7b214f..c6c17a3c0 100644
--- a/src/documentation/content/xdocs/trunk/compiling.xml
+++ b/src/documentation/content/xdocs/trunk/compiling.xml
@@ -59,7 +59,7 @@
<p>
The build script uses <a href="ext:ant">Apache Ant</a>, a popular
Java-based build tool, which usually requires that the environment variable JAVA_HOME point to
- your local JDK root directory. This is true even if you use JDK 1.2 or above, which normally
+ your local JDK root directory. This is true even if you use JDK 1.3 or above, which normally
does not need this setting.
</p>
</section>
@@ -103,7 +103,8 @@
needed, but may be helpful if you are having problems with the build process itself.
</li>
<li>
- <strong>javadocs</strong>: Generates javadocs. This creates the FOP API documentation.
+ <strong>javadocs</strong>: Creates the FOP API documentation.
+ <note>A minimum JDK version of 1.4.2 is required for generating the javadocs.</note>
</li>
</ul>
<p>To run the build:</p>
diff --git a/src/documentation/content/xdocs/trunk/configuration.xml b/src/documentation/content/xdocs/trunk/configuration.xml
index b7984e773..410b17098 100644
--- a/src/documentation/content/xdocs/trunk/configuration.xml
+++ b/src/documentation/content/xdocs/trunk/configuration.xml
@@ -78,7 +78,7 @@
<td>URL or directory</td>
<td>Specifies the base URL based on which relative font URLs will be resolved.
</td>
- <td>base URL/directory (above)</td>
+ <td>base URL/directory (above)</td>
</tr>
<tr>
<td>hyphenation-base</td>
@@ -112,10 +112,10 @@
<td>strict-configuration</td>
<td>Boolean (true, false)</td>
<td>
- Setting this option to 'true' will cause FOP to strictly verify the contents of the
- FOP configuration file to ensure that defined resources (such as fonts and base
- URLs/directories) are valid and available to FOP. Any errors found will cause FOP to
- immediately raise an exception.</td>
+ Setting this option to 'true' will cause FOP to strictly verify the contents of the
+ FOP configuration file to ensure that defined resources (such as fonts and base
+ URLs/directories) are valid and available to FOP. Any errors found will cause FOP to
+ immediately raise an exception.</td>
<td>false</td>
</tr>
<tr>
@@ -125,7 +125,7 @@
Setting this option to 'false' causes FOP to be more forgiving about XSL-FO validity,
for example, you're allowed to specify a border on a region-body which is supported
by some FO implementations but is non-standard. Note that such a border would
- currently have no effect in Apache FOP.</td>
+ currently have no effect in Apache FOP.</td>
<td>true</td>
</tr>
<tr>
@@ -173,7 +173,7 @@
<td>renderers</td>
<td>(see text below)</td>
<td>Contains the configuration for each renderer. See below.</td>
- <td>N/A</td>
+ <td>N/A</td>
</tr>
</table>
<p>
@@ -311,7 +311,7 @@
offered by Java.
</p>
<p>
- Additionally, there are certain settings that control who the renderer handles various elements.
+ Additionally, there are certain settings that control how the renderer handles various elements.
</p>
<source><![CDATA[<renderer mime="application/vnd.hp-PCL">
<rendering>quality</rendering>
@@ -333,10 +333,10 @@
</section>
</section>
- <section>
- <title>When it does not work</title>
+ <section>
+ <title>When it does not work</title>
- <p>FOP searches the configuration file for the information it
+ <p>FOP searches the configuration file for the information it
expects, at the position it expects. When that information is not
present, FOP will not complain, it will just continue. When there is
other information in the file, FOP will not complain, it will just
@@ -344,14 +344,14 @@ ignore it. That means that when your configuration information is in
the file but in a different XML element, or in a different XML path,
than FOP expects, it will be silently ignored.</p>
- <p>Check the following possibilities:</p>
+ <p>Check the following possibilities:</p>
- <ul>
- <li>The format of the configuration file has changed
+ <ul>
+ <li>The format of the configuration file has changed
considerably between FOP 0.20.5 and FOP 1.0 and its beta versions. Did
you convert your file to the new format?</li>
- <li>The FOP distribution contains a schema for configuration
+ <li>The FOP distribution contains a schema for configuration
files, at src/foschema/fop-configuration.xsd. Did you validate your
configuration file against it? Add the following schema location to
the <code>schema</code> element:
@@ -366,13 +366,13 @@ and run the configuration file through a validating schema
parser. Note that the schema cannot detect all errors, and that it is
stricter about the order of some elements than FOP itself is.</li>
- <li>Run FOP in debug mode (command line option
+ <li>Run FOP in debug mode (command line option
<code>-d</code>). This makes FOP report which configuration
information it finds. Check if FOP finds what you expect.</li>
- </ul>
+ </ul>
- </section>
+ </section>
</body>
</document>
diff --git a/src/documentation/content/xdocs/trunk/extensions.xml b/src/documentation/content/xdocs/trunk/extensions.xml
index 0c22ca123..dd4a79535 100644
--- a/src/documentation/content/xdocs/trunk/extensions.xml
+++ b/src/documentation/content/xdocs/trunk/extensions.xml
@@ -34,7 +34,7 @@
to you. If you wish to add an extension of your own to FOP, please see the
<a href="../dev/extensions.html">Developers' Extension Page</a>.
</p>
- <note>All extensions required the correct use of an appropriate namespace in your input document.</note>
+ <note>All extensions require the correct use of an appropriate namespace in your input document.</note>
<section id="svg">
<title>SVG</title>
<p>
@@ -52,10 +52,6 @@
</p>
<source><![CDATA[<fo:root xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:fox="http://xmlgraphics.apache.org/fop/extensions">]]></source>
- <note>
- Currently, no extension elements are implemented in FOP Trunk which use the
- FOP extension namespace.
- </note>
</section>
<section id="bookmarks">
<title>PDF Bookmarks</title>
diff --git a/src/documentation/content/xdocs/trunk/fonts.xml b/src/documentation/content/xdocs/trunk/fonts.xml
index 2ee297ba0..61d7d7e6a 100644
--- a/src/documentation/content/xdocs/trunk/fonts.xml
+++ b/src/documentation/content/xdocs/trunk/fonts.xml
@@ -262,8 +262,8 @@ It will display all of the font names and exit with an Exception.</p>
See <a href="configuration.html">FOP: Configuration</a> for more information.
</li>
<li>Either an "embed-url" or a "metrics-url" must be specified for font tag configurations.</li>
- <li>The font "kerning" attribute is optional. Kerning is currently not used at all.</li>
- <li>If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.</li>
+ <li>The font "kerning" attribute is optional.</li>
+ <li>If embedding is off, the output will position the text correctly (from the metrics file), but it will not be displayed or printed correctly unless the viewer has the applicable font available to their local system.</li>
<li>When setting the "embed-url" attribute for Type 1 fonts, be sure to specify the PFB (actual font data), not PFM (font metrics) file that you used to generate the XML font metrics file.</li>
<li>The fonts "directory" tag can be used to register fonts contained within a single or list of directory paths. The "recursive" attribute can be specified to recursively add fonts from all sub directories.</li>
<li>The fonts "auto-detect" tag can be used to automatically register fonts that are found to be installed on the native operating system.</li>
@@ -291,14 +291,8 @@ If you don't specify the embed-url attribute the font will not be embedded, but
<p>When FOP embeds a font, it adds a prefix to the fontname to ensure that the name will not match the fontname of an installed font.
This is helpful with older versions of Acrobat Reader that preferred installed fonts over embedded fonts.</p>
<p>When embedding PostScript fonts, the entire font is always embedded.</p>
- <p>When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the original font, containing only the glyphs used, is embedded in the output document.
-Currently, this embedded font contains only the minimum data needed to be embedded in a pdf document, and does not contain any codepage information.
-The PDF document contains indexes to the glyphs in the font instead of to encoded characters.
-While the document will be displayed correctly, the net effect of this is that searching, indexing, and cut-and-paste will not work properly.</p>
- <p>One workaround for this behavior is to use the "-enc ansi" option when generating metrics with TTFReader.
-This will cause the whole font to be embedded in the pdf document.
-Characters will be WinAnsi encoded (as specified in the PDF spec), so you lose the ability to use characters from other character sets.
-See <a href="#ttf-encoding">Table of TTF Encoding Options</a> for more details.</p>
+ <p>When embedding TrueType fonts (ttf) or TrueType Collections (ttc), a subset of the
+ original font, containing only the glyphs used, is embedded in the output document.</p>
</section>
<section id="embedding-base14">
<title>Explicitly embedding the base 14 fonts</title>
diff --git a/src/documentation/content/xdocs/trunk/graphics.xml b/src/documentation/content/xdocs/trunk/graphics.xml
index fb0a393f3..164069733 100644
--- a/src/documentation/content/xdocs/trunk/graphics.xml
+++ b/src/documentation/content/xdocs/trunk/graphics.xml
@@ -155,7 +155,6 @@ Then, copy the file "JimiProClasses.zip" from the archive to {fop-install-dir}/l
</section>
<section id="jai">
<title>JAI (Java Advanced Imaging API)</title>
- <warning>JAI support is available for Release 0.20.5 and later. The comments in this section do not apply to releases earlier than 0.20.5.</warning>
<p>
FOP has been compiled with JAI support, but JAI is not included in the FOP distribution.
To use it, install <a href="http://java.sun.com/products/java-media/jai">JAI</a>, then copy the jai_core.jar and the jai_codec.jar files to {fop-install-dir}/lib.
diff --git a/src/documentation/content/xdocs/trunk/output.xml b/src/documentation/content/xdocs/trunk/output.xml
index e769a3d4b..21743519f 100644
--- a/src/documentation/content/xdocs/trunk/output.xml
+++ b/src/documentation/content/xdocs/trunk/output.xml
@@ -635,6 +635,9 @@ out = proc.getOutputStream();]]></source>
possible. The RTF output follows Microsoft's RTF specifications
and produces best results on Microsoft Word.
</p>
+ <note>RTF output is currently unmaintained and lacks many features compared to other output
+ formats. Using other editable formats like Open Document Format, instead of producing XSL-FO
+ then RTF through FOP, might give better results.</note>
</section>
<section id="xml">
<title>XML (Area Tree XML)</title>
diff --git a/src/documentation/content/xdocs/trunk/pdfencryption.xml b/src/documentation/content/xdocs/trunk/pdfencryption.xml
index f68eae437..c8cdbb29c 100644
--- a/src/documentation/content/xdocs/trunk/pdfencryption.xml
+++ b/src/documentation/content/xdocs/trunk/pdfencryption.xml
@@ -29,10 +29,6 @@
<body>
<section>
<title>Overview</title>
- <warning>
- PDF Encryption is available in Release 0.20.5 and later. The comments on this page do
- not apply to releases earlier than 0.20.5.
- </warning>
<p>
FOP supports encryption of PDF output, thanks to Patrick
C. Lankswert. This feature is commonly used to prevent
diff --git a/src/documentation/content/xdocs/trunk/running.xml b/src/documentation/content/xdocs/trunk/running.xml
index 74284d6d0..a3d2dd0d2 100644
--- a/src/documentation/content/xdocs/trunk/running.xml
+++ b/src/documentation/content/xdocs/trunk/running.xml
@@ -180,7 +180,7 @@ Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl
Fop foo.fo -awt]]></source>
<p>
PDF encryption is only available if FOP was compiled with encryption support
- <strong>and</strong> if compatible encryption support is availabe at run time.
+ <strong>and</strong> if compatible encryption support is available at run time.
Currently, only the JCE is supported. Check the <a href="pdfencryption.html">Details</a>.
</p>
</section>
@@ -214,37 +214,37 @@ Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl
directory in a single directory. If you use hyphenation, you
must also put <code>fop-hyph.jar</code> in that directory.</p>
- <p>In both cases the arguments consist of the options and
+ <p>In both cases the arguments consist of the options and
infile and outfile specifications as shown above for the
standard scripts.</p>
</section>
<section id="dynamical-classpath">
- <title>FOP's dynamical classpath construction</title>
+ <title>FOP's dynamical classpath construction</title>
- <p>If FOP is started without a proper classpath, it tries to
- add its dependencies dynamically. If the system property
- <code>fop.home</code> contains the name of a directory, then
- FOP uses that directory as the base directory for its
- search. Otherwise the current working directory is the base
- directory. If the base directory is called <code>build</code>,
- then its parent directory becomes the base directory.</p>
+ <p>If FOP is started without a proper classpath, it tries to
+ add its dependencies dynamically. If the system property
+ <code>fop.home</code> contains the name of a directory, then
+ FOP uses that directory as the base directory for its
+ search. Otherwise the current working directory is the base
+ directory. If the base directory is called <code>build</code>,
+ then its parent directory becomes the base directory.</p>
<p>FOP expects to find <code>fop.jar</code> in the
- <code>build</code> subdirectory of the base directory, and
- adds it to the classpath. Subsequently FOP adds all
- <code>jar</code> files in the lib directory to the
- classpath. The lib directory is either the <code>lib</code>
- subdirectory of the base directory, or, if that does not
- exist, the base directory itself.</p>
+ <code>build</code> subdirectory of the base directory, and
+ adds it to the classpath. Subsequently FOP adds all
+ <code>jar</code> files in the lib directory to the
+ classpath. The lib directory is either the <code>lib</code>
+ subdirectory of the base directory, or, if that does not
+ exist, the base directory itself.</p>
<p>If the system property <code>fop.optional.lib</code>
- contains the name of a directory, then all <code>jar</code>
- files in that directory are also added to the classpath. See
- the methods <code>getJARList</code> and
- <code>checkDependencies</code> in
- <code>org.apache.fop.cli.Main</code>.</p>
+ contains the name of a directory, then all <code>jar</code>
+ files in that directory are also added to the classpath. See
+ the methods <code>getJARList</code> and
+ <code>checkDependencies</code> in
+ <code>org.apache.fop.cli.Main</code>.</p>
- </section>
+ </section>
</section>
<section id="check-input">
<title>Using Xalan to Check XSL-FO Input</title>
@@ -339,11 +339,6 @@ Fop [options] [-fo|-xml] infile [-xsl file] [-awt|-pdf|-mif|-rtf|-tiff|-png|-pcl
This can be substantial if the page sequence contains lots of FO elements.
</li>
</ul>
- <p>
- One of FOP's stated design goals is to be able to process input of arbitrary size.
- Addressing this goal is one of the prime motivations behind the
- <a href="../dev/index.html">FOP Redesign</a>.
- </p>
</section>
<section id="problems">
<title>Problems</title>
diff --git a/src/documentation/content/xdocs/trunk/upgrading.xml b/src/documentation/content/xdocs/trunk/upgrading.xml
index 46c9cff3b..25e63ace8 100644
--- a/src/documentation/content/xdocs/trunk/upgrading.xml
+++ b/src/documentation/content/xdocs/trunk/upgrading.xml
@@ -31,7 +31,10 @@
</p>
<ul>
<li>
- More than half of the codebase has been rewritten over the last three years. With version 0.93 the code has reached <strong>production level</strong>.
+ More than half of the codebase has been rewritten over the
+ last three years. With version 0.93 the code has reached
+ <strong>production level</strong>, and continues to improve with
+ version 0.94.
</li>
<li>
The API of FOP has changed considerably and is not
@@ -51,7 +54,7 @@
an example configuration file. A XML Schema file can be found under
src/foschema/fop-configuration.xsd.
</li>
- <li>
+ <li>
If you are using font metrics files for version 0.20.5 or
0.92 or earlier, you have to regenerate them in the new
format. The new format is characterized by a version
@@ -76,18 +79,13 @@
</li>
<li>
Extensions and Renderers written for version 0.20.5 will not work with the new code! The new FOP
- extension for <a href="http://barcode4j.krysalis.org">Barcode4J</a> will be available in
+ extension for <a href="http://barcode4j.krysalis.org">Barcode4J</a> is available since
January 2007.
</li>
<li>
- The PCL Renderer and the MIF Handler have not been resurrected, yet! They are currently non-functional
+ The SVG Renderer and the MIF Handler have not been resurrected, yet! They are currently non-functional
and hope for someone to step up and reimplement them.
</li>
- <li>
- By looking at the <a href="../compliance.html">Compliance page</a> you might get the impression
- that the new code is much more advanced than version 0.20.5. That's true but there may still
- be a few things that may not be handled as gracefully by the new code as by version 0.20.5.
- </li>
</ul>
</section>
<section id="issues">