From 0ae62d6f881195fd85b119f63a286c38acd350ab Mon Sep 17 00:00:00 2001 From: William Victor Mote Date: Thu, 10 Jul 2003 17:12:37 +0000 Subject: [PATCH] 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. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196678 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/content/xdocs/book.xml | 1 + .../content/xdocs/configuration.xml | 60 ------------------- .../content/xdocs/hyphenation.xml | 44 ++++++++++++++ 3 files changed, 45 insertions(+), 60 deletions(-) create mode 100644 src/documentation/content/xdocs/hyphenation.xml diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml index 5c12699dc..b880ef66f 100644 --- a/src/documentation/content/xdocs/book.xml +++ b/src/documentation/content/xdocs/book.xml @@ -29,6 +29,7 @@ + diff --git a/src/documentation/content/xdocs/configuration.xml b/src/documentation/content/xdocs/configuration.xml index ca1b2ffcb..8c8833632 100644 --- a/src/documentation/content/xdocs/configuration.xml +++ b/src/documentation/content/xdocs/configuration.xml @@ -58,66 +58,6 @@ Also, since the configuration file is XML, be sure to keep it well-formed.

-
- Setting up hyphenation -

- FOP comes already with some hyphenation patterns. If you need a hyphenation pattern - which isn't included in the distribution, do the following: -

-
    -
  1. -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. -
    2. -
  2. -Name this new file following this schema: languageCode_countryCode.xml. 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: en_US.xml. For an Italian -file: it.xml. Language and country codes must be the same as in XSL-FO, that -is follow -ISO 639 -and -ISO 3166 -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. -
    3. -
  3. -If you have built your new hyphenation pattern file successfully there are -two ways to make it accessible to FOP. -
      -
    • -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. -
      • -
    • -Put the file into a directory of your choice and specify this directory -in the userconfig.xml in the entry <hyphenation-dir>. -
      • -
    -
    4. -
-
- Places to find TeX hyphenation pattern files -

- The most important place to find hyphenation pattern file is the CTAN TeX Archive: -

-
    -
  • CTAN TeX Archive
    • -
-
- - 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. - - - Most of the files published in the CTAN Archive are licenced under the - LaTeX Project Public License (LPPL). - 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. - -
SVG
diff --git a/src/documentation/content/xdocs/hyphenation.xml b/src/documentation/content/xdocs/hyphenation.xml new file mode 100644 index 000000000..ed69282da --- /dev/null +++ b/src/documentation/content/xdocs/hyphenation.xml @@ -0,0 +1,44 @@ + + + +
+ FOP: Hyphenation +
+ +
+ Setting up hyphenation +

FOP comes already with some hyphenation patterns. +If you need a hyphenation pattern which isn't included in the distribution, do the following:

+
    +
  1. 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.
    2. +
  2. Name this new file following this schema: languageCode_countryCode.xml. +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: en_US.xml. +For an Italian file: it.xml. +Language and country codes must be the same as in XSL-FO, that is follow ISO 639 and +ISO 3166 +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.
    3. +
  3. If you have built your new hyphenation pattern file successfully there are +two ways to make it accessible to FOP. +
      +
    • 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.
      • +
    • Put the file into a directory of your choice and specify this directory +in the userconfig.xml in the entry <hyphenation-dir>.
      • +
    +
    4. +
+
+ Places to find TeX hyphenation pattern files +

The most important place to find hyphenation pattern file is the CTAN TeX Archive.

+
+ 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. + Most of the files published in the CTAN Archive are licenced under the LaTeX Project Public License (LPPL). +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. +
+ + -- 2.39.5