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

INLINE CUSTOMIZATION

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

STATUS OF THIS MODULE

79       Tested successfully on simple AsciiDoc files.
80

AUTHORS

82        Nicolas François <nicolas.francois@centraliens.net>
83        Denis Barbier <barbier@linuxfr.org>
84

86        Copyright 2005-2008 by Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
87        Copyright 2012 by Denis BARBIER <barbier@linuxfr.org>.
88        Copyright 2017 by Martin Quinson <mquinson#debian.org>.
89
90       This program is free software; you may redistribute it and/or modify it
91       under the terms of GPL (see the COPYING file).
92
93
94
95Po4a Tools                        2018-09-24       Locale::Po4a::AsciiDoc(3pm)
Impressum