1Locale::Po4a::AsciiDoc(3pm) Po4a Tools Locale::Po4a::AsciiDoc(3pm)
2
6 Locale::Po4a::AsciiDoc - convert AsciiDoc documents from/to PO files
7
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 Locale::Po4a::AsciiDoc is a module to help the translation of
14 documentation in the AsciiDoc format.
15
17 These are this module's particular options:
18 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 In a definitions file, lines must not start by two slashes, but
26 directly by po4a:.
27 entry
29 Space-separated list of attribute entries you want to translate.
30 By default, no attribute entries are translatable.
31 macro
33 Space-separated list of macro definitions.
34 style
36 Space-separated list of style definitions.
37 forcewrap
39 Enable automatic line wrapping in non-verbatim blocks, even if the
40 result could be misinterpreted by AsciiDoc formatters.
41 By default, po4a will not wrap the produced AsciiDoc files because
43 a manual inspection is mandated to ensure that the wrapping does
44 not change the formatting. Consider for instance the following list
45 item:
46 * a long sentence that is ending with a number 1. A second sentence.
48 If the wrapping leads to the following presentation, the item is
50 split into a numbered sub-list. To make things worse, only the
51 speakers of the language used in the translation can inspect the
52 situation.
53 * a long sentence that is ending with a number
55 1. A second sentence.
56 Note that not wrapping the files produced by po4a should not be a
58 problem since those files are meant to be processed automatically.
59 They should not be regarded as source files anyway.
60 With this option, po4a will produce better-looking source files,
62 that may lead to possibly erroneous formatted outputs.
63 noimagetargets
65 By default, the targets of block images are translatable to give
66 opportunity to make the content point to translated images. This
67 can be stopped by setting this option.
68 tablecells
70 This option is a flag that enables sub-table segmentation into cell
71 content. The segmentation is limited to cell content, without any
72 parsing inside of it.
73 compat
75 Switch parsing rules to compatibility with different tools.
76 Available options are "asciidoc" or "asciidoctor". Asciidoctor has
77 stricter parsing rules, such as equality of length of opening and
78 closing block fences.
79 yfm_keys
81 Comma-separated list of keys to process for translation in the YAML
82 Front Matter section. All other keys are skipped. Keys are matched
83 with a case-insensitive match. Array values are always translated,
84 unless the yfm_skip_array option is provided.
85 nolinting
87 Disable linting messages. When the source code cannot be fixed for
88 clearer document structure, these messages are useless.
89 yfm_skip_array
91 Do not translate array values in the YAML Front Matter section.
92
94 The AsciiDoc module can be customized with lines starting by //po4a:.
95 These lines are interpreted as commands to the parser. The following
96 commands are recognized:
97 //po4a: macro name[attribute list]
99 This permits to describe in detail the parameters of a macro; name
100 must be a valid macro name, and it ends with an underscore if the
101 target must be translated.
102 The attribute list argument is a comma separated list which
104 contains informations about translatable arguments. This list
105 contains either numbers, to define positional parameters, or named
106 attributes.
107 If a plus sign (+) is prepended to name, then the macro and its
109 arguments are translated as a whole. There is no need to define
110 attribute list in this case, but brackets must be present.
111 //po4a: style [attribute list]
113 This permits to describe in detail which attributes of a style must
114 be translated.
115 The attribute list argument is a comma separated list which
117 contains informations about translatable arguments. This list
118 contains either numbers, to define positional parameters, or named
119 attributes. The first attribute is the style name, it will not be
120 translated.
121 If a plus sign (+) is prepended to the style name, then the
123 attribute list is translated as a whole. There is no need to
124 define translatable attributes.
125 If a minus sign (-) is prepended to the style name, then this
127 attribute is not translated.
128 //po4a: entry name
130 This declares an attribute entry as being translatable. By
131 default, they are not translated.
132
134 Tested successfully on simple AsciiDoc files.
135
137 Nicolas François <nicolas.francois@centraliens.net>
138 Denis Barbier <barbier@linuxfr.org>
139
141 Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
142 Copyright © 2012 Denis BARBIER <barbier@linuxfr.org>.
143 Copyright © 2017 Martin Quinson <mquinson#debian.org>.
144 This program is free software; you may redistribute it and/or modify it
146 under the terms of GPL (see the COPYING file).
147Po4a Tools 2022-01-21 Locale::Po4a::AsciiDoc(3pm)