summaryrefslogtreecommitdiffstats
path: root/misc/po4a/README
blob: 12d67030e246d773ae680a16a5f2f7ca51f8e9d3 (plain)
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
po4a - Versatile PO to/from other documentation formats converter

po4a (PO for anything) eases translations and their maintenance,
allowing gettext's usage on unexpected areas like documentation.

In po4a each documentation format is handled by a module, that
converts this format to/from PO. Formats included in po4a-0.47 are:
AsciiDoc, BibTex, Dia, Halibut, KernelHelp, LaTeX, Man, POD, SGML, TeX,
Texinfo, Text, WML, XHTML, XML.

man pages are encoded in UTF-8. To read them in other languages than English,
do this for instance:
LANG=ru_RU.utf8 GROFF_ENCODING=utf8 man <man page>

WARNING: run po4a.SlackBuild as root (su -) not with only root privileges
(su), otherwise test #24 will fail.

Dependencies tree is as follows (all dependencies listed are available at
http://slackbuilds.org).

Po4a-0.47
|
|-- perl-YAML-Tiny. Mandatory for the Yaml module.
|-- perl-Module-Build
|-- perl-text-WrapI18N to format po4a's warnings and error messages. Optional.
|   |-- Text::CharWidth. Mandatory
|-- perl-Unicode-LineBreak, includes module Unicode::GCString to compute
    text width, neeeded by AsciiDoc to determine two line titles in
    encodings different from ASCII. Mandatory for TEXT module.
    |-- perl-MIME-Charset. Mandatory
        |-- perl-Encode-EUCJPASCII. Optional
        |-- perl-Encode-HanExtra. Optional.
        |-- perl-Encode-JISX0213. Optional
            |-- perl-Encode-ISO2022. Mandatory