src/documentation/content/xdocs/configuration.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

<?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>Configuration</title>
  </header>

  <body>
  <section>
    <title>How to configure FOP</title>
    <p>In the directory xml-fop/conf you will find two configuration files. One of them,
       config.xml, is only intended for FOP developers, who want to add new default values
       to some FOP feature. Don't change this file. For user configuration there is a file called
       userconfig.xml. It contains templates for all settings a user can change. Most of them are
       commented out. Uncomment the entry you want to set and change the value according to
       your wishes. Please regard any comments which specify the value range. And, well, the
       configuration files are xml files, so keep them at least well-formed. ;-)
    </p>
    <p>The file userconfig.xml is not read automatically, but the user must specify its use on
       the command line. See <link href="running.html">Running FOP</link>
       or <link href="embedding.html">Embedding FOP</link> for details.
    </p>
  </section>
  <section>
    <title>Setting up hyphenation</title>
    <p>FOP comes already with some hyphenation pattern. 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 /src/hyph.
      </li>
      <li>
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
<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 build 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 /src/hyph and rebuild FOP. The file will
be picked up and added to the fop.jar.
          </li>
          <li>
Put the file into a directory of your choice and specify this directory
in the userconfig.xml in the entry &lt;hyphenation-dir>.
          </li>
        </ul>
      </li>
    </ol>
  </section>
  </body>
</document>