vmote 2003/07/10 12:57:20
Modified: src/documentation/content/xdocs hyphenation.xml
Log:
1. rearrange content
2. add cross-ref to configuration file
Revision Changes Path
1.2 +34 -27 xml-fop/src/documentation/content/xdocs/hyphenation.xml
Index: hyphenation.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/hyphenation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- hyphenation.xml 10 Jul 2003 17:12:37 -0000 1.1
+++ hyphenation.xml 10 Jul 2003 19:57:20 -0000 1.2
@@ -6,39 +6,46 @@
<title>FOP: Hyphenation</title>
</header>
<body>
- <section id="hyphenation">
- <title>Setting up hyphenation</title>
- <p>FOP comes already with some hyphenation patterns.
-If you need a hyphenation pattern which isn't included in the distribution, do the
following:</p>
+ <section id="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>
+ <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">
+ <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>
+ <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">
+ <title>Installing Custom Hyphenation Patterns</title>
+ <p>To install custom a custom hyphenation pattern for use with FOP:</p>
<ol>
- <li>Get the TeX hyphenation pattern file and turn it into an xml file which
-conforms to the hyphenation.dtd in the subdirectory {fop-dir}/src/hyph.</li>
+ <li>Convert the TeX hyphenation pattern file to the FOP format. The FOP
format is an xml file conforming to the DTD found at
<code>{fop-dir}/src/hyph/hyphenation.dtd</code>.</li>
<li>Name this new file following this schema:
<code>languageCode_countryCode.xml</code>.
-If you don't need a country code, leave it out, e.g. the file name for an American
-english hyphenation pattern would look like this: <code>en_US.xml</code>.
-For an Italian file: <code>it.xml</code>.
-Language and country codes must be the same as in XSL-FO, that is follow <link
href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt";>ISO 639</link> and
-<link href="http://www.ics.uci.edu/pub/ietf/http/related/iso3166.txt";>ISO
3166</link>
-respectively.
-NOTE: The ISO 639/ISO 3166 convention is that language names are
-written in lower case, while country codes are written in upper case.</li>
- <li>If you have built your new hyphenation pattern file successfully there
are
-two ways to make it accessible to FOP.
+The country code is optional, and should be used only if needed. For example:
<ul>
- <li>Put this new file into the directory {fop-dir}/src/hyph and rebuild
FOP. The file will be picked up and added to fop.jar.</li>
- <li>Put the file into a directory of your choice and specify this
directory
-in the userconfig.xml in the entry <hyphenation-dir>.</li>
+ <li><code>en_US.xml</code> would be the file name for an American
English hyphenation pattern.</li>
+ <li><code>it.xml</code> would be the file name for an Italian
hyphenation pattern.</li>
+ </ul>
+The language and country codes must match the XSL-FO input, which follows <link
href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt";>ISO 639</link>
(languages) and
+<link href="http://www.ics.uci.edu/pub/ietf/http/related/iso3166.txt";>ISO
3166</link> (countries).
+NOTE: The ISO 639/ISO 3166 convention is that language names are written in lower
case, while country codes are written in upper case.</li>
+ <li>There are two ways to make the FOP-compatible hyphenation pattern file
accessible to FOP:
+ <ul>
+ <li>Place the FOP-compatible hyphenation pattern file into the
directory {fop-dir}/src/hyph and rebuild FOP. The file will be picked up and added to
fop.jar.</li>
+ <li>Put the file into a directory of your choice and configure FOP to
look for custom patterns in this directory, by setting the <link
href="configuration.html#hyphenation-dir"><hyphenation-dir> configuration
option</link>.</li>
</ul>
</li>
</ol>
- <section id="hyphenation-sources">
- <title>Places to find TeX hyphenation pattern files</title>
- <p>The most important place to find hyphenation pattern file is the <fork
href="http://www.ctan.org/tex-archive/language/hyphenation/";>CTAN TeX
Archive</fork>.</p>
- </section>
- <warning>You have to carefully check license issues when using hyphenation
pattern files from other places.
-The licenses of the files found on the Internet are not always clear.</warning>
- <note>Most of the files published in the CTAN Archive are licenced under the
<fork href="http://www.latex-project.org/lppl.html";>LaTeX Project Public License
(LPPL)</fork>.
-The Apache Foundation can't redistribute files under this license. If you want to
use such a file you have to decide for yourself if you can use (and possibly
distribute) the file under these conditions.</note>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
