vmote 2003/07/10 10:12:37
Modified: src/documentation/content/xdocs book.xml configuration.xml
Added: src/documentation/content/xdocs hyphenation.xml
Log:
Move hyphenation information out of configuration and into a separate document.
Attempt here is to reduce the configuration document to only apply to the
configuration file, with cross-references to other documents as needed.
Revision Changes Path
1.26 +1 -0 xml-fop/src/documentation/content/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/book.xml,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- book.xml 22 May 2003 18:09:49 -0000 1.25
+++ book.xml 10 Jul 2003 17:12:37 -0000 1.26
@@ -29,6 +29,7 @@
<menu-item label="PDF encryption" href="pdfencryption.html"/>
<menu-item label="Graphics" href="graphics.html"/>
<menu-item label="Fonts" href="fonts.html"/>
+ <menu-item label="Hyphenation" href="hyphenation.html"/>
<menu-item label="Extensions" href="extensions.html"/>
</menu>
1.11 +0 -60 xml-fop/src/documentation/content/xdocs/configuration.xml
Index: configuration.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/configuration.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- configuration.xml 10 Jul 2003 06:47:38 -0000 1.10
+++ configuration.xml 10 Jul 2003 17:12:37 -0000 1.11
@@ -58,66 +58,6 @@
</tr>
</table>
</section>
- <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>
- <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>
-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.
- <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>
- </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 CTAN TeX
Archive:
- </p>
- <ul>
- <li><fork href="http://www.ctan.org/tex-archive/language/hyphenation/";>CTAN
TeX Archive</fork></li>
- </ul>
- </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>
<section id="svg">
<title>SVG</title>
<section id="svg-strokeSVGText">
1.1 xml-fop/src/documentation/content/xdocs/hyphenation.xml
Index: hyphenation.xml
===================================================================
<?xml version="1.0" standalone="no"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd";>
<document>
<header>
<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>
<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>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.
<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>
</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]
