1Locale::Po4a::Text(3pm) Po4a Tools Locale::Po4a::Text(3pm)
2
6 Locale::Po4a::Text - convert text 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::Text is a module to help the translation of text
14 documents into other [human] languages.
15 Paragraphs are split on empty lines (or lines containing only spaces or
17 tabulations).
18 If a paragraph contains a line starting by a space (or tabulation),
20 this paragraph won't be rewrapped.
21
23 These are this module's particular options:
24 keyvalue
26 Treat paragraphs that look like a key value pair as verbatim (with
27 the no-wrap flag in the PO file). Key value pairs are defined as a
28 line containing one or more non-colon and non-space characters
29 followed by a colon followed by at least one non-space character
30 before the end of the line.
31 nobullets
33 Deactivate the detection of bullets.
34 By default, when a bullet is detected, the bullet paragraph is not
36 considered as a verbatim paragraph (with the no-wrap flag in the PO
37 file). Instead, the corresponding paragraph is rewrapped in the
38 translation.
39 tabs=mode
41 Specify how tabulations shall be handled. The mode can be any of:
42 split
44 Lines with tabulations introduce breaks in the current
45 paragraph.
46 verbatim
48 Paragraph containing tabulations will not be re-wrapped.
49 By default, tabulations are considered as spaces.
51 breaks=regex
53 A regular expression matching lines which introduce breaks. The
54 regular expression will be anchored so that the whole line must
55 match.
56 debianchangelog
58 Handle the header and footer of released versions, which only
59 contain non translatable information.
60 fortunes
62 Handle the fortunes format, which separate fortunes with a line
63 which consists in '%' or '%%', and use '%%' as the beginning of a
64 comment.
65 markdown
67 Handle some special markup in Markdown-formatted texts.
68 yfm_keys (markdown-only)
70 Comma-separated list of keys to process for translation in the YAML
71 Front Matter section. All other keys are skipped. Keys are matched
72 with a case-sensitive match. If yfm_paths and yfm_keys are used
73 together, values are included if they are matched by at least one
74 of the options. Array values are always translated, unless the
75 yfm_skip_array option is provided.
76 yfm_lenient (markdown only)
78 Allow the YAML Front Matter parser to fail on malformated headers.
79 This is particularly helpful when your file starts with a
80 horizontal ruler instead of a YAML Front Matter, but you insist on
81 using three dashes only for your ruler.
82 yfm_paths (markdown only)
84 yfm_paths
85 Comma-separated list of hash paths to process for extraction in the
86 YAML Front Matter section, all other paths are skipped. Paths are
87 matched with a case-sensitive match. If yfm_paths and yfm_keys are
88 used together, values are included if they are matched by at least
89 one of the options. Arrays values are always returned unless the
90 yfm_skip_array option is provided.
91 yfm_skip_array (markdown-only)
93 Do not translate array values in the YAML Front Matter section.
94 control[=taglist]
96 Handle control files. A comma-separated list of tags to be
97 translated can be provided.
98 neverwrap
100 Prevent po4a from wrapping any lines. This means that every content
101 is handled verbatim, even simple paragraphs.
102
104 Tested successfully on simple text files and NEWS.Debian files.
105
107 Nicolas François <nicolas.francois@centraliens.net>
108
110 Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
111 Copyright © 2008-2009, 2018 Jonas Smedegaard <dr@jones.dk>.
113 Copyright © 2020 Martin Quinson <mquinson#debian.org>.
114 This program is free software; you may redistribute it and/or modify it
116 under the terms of GPL (see the COPYING file).
117Po4a Tools 2023-01-23 Locale::Po4a::Text(3pm)