1Locale::Po4a::Text(3) User Contributed Perl DocumentationLocale::Po4a::Text(3)
2
3
4

NAME

6       Locale::Po4a::Text - convert text documents from/to PO files
7

DESCRIPTION

9       The po4a (PO for anything) project goal is to ease translations (and
10       more interestingly, the maintenance of translations) using gettext
11       tools on areas where they were not expected like documentation.
12
13       Locale::Po4a::Text is a module to help the translation of text
14       documents into other [human] languages.
15
16       Paragraphs are split on empty lines (or lines containing only spaces or
17       tabulations).
18
19       If a paragraph contains a line starting by a space (or tabulation),
20       this paragraph won't be rewrapped.
21

OPTIONS ACCEPTED BY THIS MODULE

23       These are this module's particular options:
24
25       nobullets
26           Deactivate detection of bullets.
27
28           By default, when a bullet is detected, the bullet paragraph is not
29           considered as a verbatim paragraph (with the no-wrap flag in the PO
30           file), but the module rewrap this paragraph in the generated PO
31           file and in the translation.
32
33       tabs=mode
34           Specify how tabulations shall be handled. The mode can be any of:
35
36           split
37               Lines with tabulations introduce breaks in the current
38               paragraph.
39
40           verbatim
41               Paragraph containing tabulations will not be re-wrapped.
42
43           By default, tabulations are considered as spaces.
44
45       breaks=regex
46           A regular expression matching lines which introduce breaks.  The
47           regular expression will be anchored so that the whole line must
48           match.
49
50       debianchangelog
51           Handle the header and footer of released versions, which only
52           contain non translatable informations.
53
54       fortunes
55           Handle the fortunes format, which separate fortunes with a line
56           which consists in '%' or '%%', and use '%%' as the beginning of a
57           comment.
58
59       markdown
60           Handle some special markup in Markdown-formatted texts.
61
62       asciidoc
63           Handle documents in the AsciiDoc format.
64

STATUS OF THIS MODULE

66       Tested successfully on simple text files and NEWS.Debian files.
67

AUTHORS

69        Nicolas Francois <nicolas.francois@centraliens.net>
70

72        Copyright 2005-2008 by Nicolas FRANCOIS <nicolas.francois@centraliens.net>.
73
74       This program is free software; you may redistribute it and/or modify it
75       under the terms of GPL (see the COPYING file).
76
77
78
79perl v5.12.2                      2010-12-01             Locale::Po4a::Text(3)
Impressum