1Locale::Po4a::AsciiDoc(3pm)       Po4a Tools       Locale::Po4a::AsciiDoc(3pm)
2
3
4

NAME

6       Locale::Po4a::AsciiDoc - convert AsciiDoc 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::AsciiDoc is a module to help the translation of
14       documentation in the AsciiDoc format.
15

OPTIONS ACCEPTED BY THIS MODULE

17       These are this module's particular options:
18
19       definitions
20           The name of a file containing definitions for po4a, as defined in
21           the INLINE CUSTOMIZATION section.  You can use this option if it is
22           not possible to put the definitions in the document being
23           translated.
24
25           In a definitions file, lines must not start by two slashes, but
26           directly by po4a:.
27
28       entry
29           Space-separated list of attribute entries you want to translate.
30           By default, no attribute entries are translatable.
31
32       macro
33           Space-separated list of macro definitions.
34
35       style
36           Space-separated list of style definitions.
37
38       noimagetargets
39           By default, the targets of block images are translatable to give
40           opportunity to make the content point to translated images. This
41           can be stopped by setting this option.
42
43       tablecells
44           This option is a flag that enables sub-table segmentation into cell
45           content.  The segmentation is limited to cell content, without any
46           parsing inside of it.
47

INLINE CUSTOMIZATION

49       The AsciiDoc module can be customized with lines starting by //po4a:.
50       These lines are interpreted as commands to the parser.  The following
51       commands are recognized:
52
53       //po4a: macro name[attribute list]
54           This permits to describe in detail the parameters of a macro; name
55           must be a valid macro name, and it ends with an underscore if the
56           target must be translated.
57
58           The attribute list argument is a comma separated list which
59           contains informations about translatable arguments.  This list
60           contains either numbers, to define positional parameters, or named
61           attributes.
62
63           If a plus sign (+) is prepended to name, then the macro and its
64           arguments are translated as a whole.  There is no need to define
65           attribute list in this case, but brackets must be present.
66
67       //po4a: style [attribute list]
68           This permits to describe in detail which attributes of a style must
69           be translated.
70
71           The attribute list argument is a comma separated list which
72           contains informations about translatable arguments.  This list
73           contains either numbers, to define positional parameters, or named
74           attributes.  The first attribute is the style name, it will not be
75           translated.
76
77           If a plus sign (+) is prepended to the style name, then the
78           attribute list is translated as a whole.  There is no need to
79           define translatable attributes.
80
81           If a minus sign (-) is prepended to the style name, then this
82           attribute is not translated.
83
84       //po4a: entry name
85           This declares an attribute entry as being translatable.  By
86           default, they are not translated.
87

STATUS OF THIS MODULE

89       Tested successfully on simple AsciiDoc files.
90

AUTHORS

92        Nicolas François <nicolas.francois@centraliens.net>
93        Denis Barbier <barbier@linuxfr.org>
94

96        Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
97        Copyright © 2012 Denis BARBIER <barbier@linuxfr.org>.
98        Copyright © 2017 Martin Quinson <mquinson#debian.org>.
99
100       This program is free software; you may redistribute it and/or modify it
101       under the terms of GPL (see the COPYING file).
102
103
104
105Po4a Tools                        2020-01-30       Locale::Po4a::AsciiDoc(3pm)
Impressum