aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilliam Victor Mote <vmote@apache.org>2003-07-15 01:12:33 +0000
committerWilliam Victor Mote <vmote@apache.org>2003-07-15 01:12:33 +0000
commitf1a5f28111d7d87025b43e25cff4c985410b0918 (patch)
tree73a84210b62cfc2d2dba06a7e16ee1132ac61f1f
parent26d1267edb58ba004498e776896a342dffda556e (diff)
downloadxmlgraphics-fop-f1a5f28111d7d87025b43e25cff4c985410b0918.tar.gz
xmlgraphics-fop-f1a5f28111d7d87025b43e25cff4c985410b0918.zip
1. add list of supported country/language codes for hyphenation
2. update FAQ to point to the new hyphenation page git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196712 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/documentation/content/xdocs/faq.xml17
-rw-r--r--src/documentation/content/xdocs/hyphenation.xml58
2 files changed, 54 insertions, 21 deletions
diff --git a/src/documentation/content/xdocs/faq.xml b/src/documentation/content/xdocs/faq.xml
index 7064e3417..75cad9b9f 100644
--- a/src/documentation/content/xdocs/faq.xml
+++ b/src/documentation/content/xdocs/faq.xml
@@ -531,21 +531,10 @@ Any easy way to check this is to cut&amp;paste the source URL from the fo:extern
<faq id="hyphenation-fails">
<question>Hyphenation does not work.</question>
<answer>
- <p>
- Set the language attribute somewhere and explicitly enable hyphenation.
- Check whether you use a language for which hyphenation is supported.
- Supported languages can be deduced from the files in the {fop-dir}/src/hyph
- directory of the FOP source distribution. If you want to use a language
- FOP currently doesn't hyphenate, please see the
- <link href="configuration.html#hyphenation">Configuration page</link>.
- </p>
- <p>
- Set the language (on fo:page-sequence, fo:block or fo:character):
- </p>
+ <p>Make sure you have set the language and/or country attributes for an appropriate XSL-FO element (fo:page-sequence, fo:block or fo:character):</p>
<source><![CDATA[<fo:page-sequence language="fi">]]></source>
- <p>
- Enable hyphenation on a block:
- </p>
+ <p>See <link href="hyphenation.html#std">Standard Hyphenation Support</link> for a list of supported language and country codes, and <link href="hyphenation.html#custom">Custom Hyphenation Support</link> for instructions on adding support for other languages and countries.</p>
+ <p>Explicitly enable hyphenation for an appropriate XSL-FO element (fo:block, fo:character):</p>
<source><![CDATA[<fo:block hyphenate="true">]]></source>
</answer>
</faq>
diff --git a/src/documentation/content/xdocs/hyphenation.xml b/src/documentation/content/xdocs/hyphenation.xml
index 92f77904e..d8dc1c0e2 100644
--- a/src/documentation/content/xdocs/hyphenation.xml
+++ b/src/documentation/content/xdocs/hyphenation.xml
@@ -6,26 +6,69 @@
<title>FOP: Hyphenation</title>
</header>
<body>
- <section id="intro">
+ <section id="std">
+ <title>Standard Hyphenation Support</title>
+ <p>FOP includes hyphenation support for the following languages:</p>
+ <table>
+ <tr>
+ <th>language_COUNTRY code</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>en</td>
+ <td>English</td>
+ </tr>
+ <tr>
+ <td>es</td>
+ <td>Spanish</td>
+ </tr>
+ <tr>
+ <td>fi</td>
+ <td>Finnish</td>
+ </tr>
+ <tr>
+ <td>hu</td>
+ <td>Hungarian</td>
+ </tr>
+ <tr>
+ <td>it</td>
+ <td>Italian</td>
+ </tr>
+ <tr>
+ <td>pl</td>
+ <td>Polish</td>
+ </tr>
+ <tr>
+ <td>pt</td>
+ <td>Portuguese</td>
+ </tr>
+ <tr>
+ <td>ru</td>
+ <td>Russian</td>
+ </tr>
+ </table>
+ </section>
+ <section id="custom">
+ <title>Custom Hyphenation Support</title>
+ <section id="custom-intro">
<title>Introduction</title>
<p>FOP uses an XML-based TeX-like hyphenation pattern scheme.
-Hyphenation pattern files for many languages are included in the standard FOP distribution.
However, because of <link href="#license-issues">licensing issues</link>, there are currently some significant holes in FOP's hyphenation support.
-The information on this page is intended to help you work around these limitations, if possible, add support for other languages, or enhance FOP's support of current languages.</p>
+The information in this section is intended to help you work around these limitations, if possible, add support for other languages, or enhance FOP's support of current languages.</p>
<note>If you have access to hyphenation patterns that are licensed in an Apache-compatible way, or if you have made improvements to an existing FOP hyphenation pattern, or if you have created one from scratch, please consider contributing these to FOP so that they can benefit other FOP users as well. Please inquire on the <link href="maillist.html#fop-user">FOP User mailing list</link>.</note>
</section>
- <section id="license-issues">
+ <section id="custom-license-issues">
<title>License Issues</title>
<p>Many of the hyphenation files distributed with TeX and its offspring are licenced under the <fork href="http://www.latex-project.org/lppl.html">LaTeX Project Public License (LPPL)</fork>, which prevents them from being distributed with Apache software.
Although Apache FOP cannot redistribute hyphenation pattern files that do not conform with its license scheme, that does not necessarily prevent users from using such hyphenation patterns with FOP.
However, it does place on the user the responsibility for determining whether the user can rightly use such hyphenation patterns under the hyphenation pattern license.</p>
<warning>The user is responsible to settle license issues for hyphenation pattern files that are obtained from non-Apache sources.</warning>
</section>
- <section id="sources">
- <title>Sources of Hyphenation Pattern Files</title>
+ <section id="custom-sources">
+ <title>Sources of Custom Hyphenation Pattern Files</title>
<p>The most important source of hyphenation pattern files is the <fork href="http://www.ctan.org/tex-archive/language/hyphenation/">CTAN TeX Archive</fork>.</p>
</section>
- <section id="install">
+ <section id="custom-install">
<title>Installing Custom Hyphenation Patterns</title>
<p>To install custom a custom hyphenation pattern for use with FOP:</p>
<ol>
@@ -47,5 +90,6 @@ NOTE: The ISO 639/ISO 3166 convention is that language names are written in lowe
</li>
</ol>
</section>
+ </section>
</body>
</document>