1Locale::Po4a::TransTracUtsoerr(3C)ontributed Perl DocumeLnotcaatlieo:n:Po4a::TransTractor(3)
2
3
4

NAME

6       Locale::Po4a::TransTractor - generic trans(lator ex)tractor.
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       This class is the ancestor of every po4a parser used to parse a
14       document, to search translatable strings, to extract them to a PO file
15       and to replace them by their translation in the output document.
16
17       More formally, it takes the following arguments as input:
18
19       - a document to translate;
20
21       - a PO file containing the translations to use.
22
23       As output, it produces:
24
25       - another PO file, resulting of the extraction of translatable strings
26         from the input document;
27
28       - a translated document, with the same structure than the one in input,
29         but with all translatable strings replaced with the translations
30         found in the PO file provided in input.
31
32       Here is a graphical representation of this:
33
34          Input document --\                             /---> Output document
35                            \                           /       (translated)
36                             +-> parse() function -----+
37                            /                           \
38          Input PO --------/                             \---> Output PO
39                                                                (extracted)
40

FUNCTIONS YOUR PARSER SHOULD OVERRIDE

42       parse()
43           This is where all the work takes place: the parsing of input
44           documents, the generation of output, and the extraction of the
45           translatable strings. This is pretty simple using the provided
46           functions presented in the section INTERNAL FUNCTIONS below. See
47           also the SYNOPSIS, which presents an example.
48
49           This function is called by the process() function below, but if you
50           choose to use the new() function, and to add content manually to
51           your document, you will have to call this function yourself.
52
53       docheader()
54           This function returns the header we should add to the produced
55           document, quoted properly to be a comment in the target language.
56           See the section Educating developers about translations, from
57           po4a(7), for what it is good for.
58

SYNOPSIS

60       The following example parses a list of paragraphs beginning with "<p>".
61       For the sake of simplicity, we assume that the document is well
62       formatted, i.e. that '<p>' tags are the only tags present, and that
63       this tag is at the very beginning of each paragraph.
64
65        sub parse {
66          my $self = shift;
67
68          PARAGRAPH: while (1) {
69              my ($paragraph,$pararef)=("","");
70              my $first=1;
71              my ($line,$lref)=$self->shiftline();
72              while (defined($line)) {
73                  if ($line =~ m/<p>/ && !$first--; ) {
74                      # Not the first time we see <p>.
75                      # Reput the current line in input,
76                      #  and put the built paragraph to output
77                      $self->unshiftline($line,$lref);
78
79                      # Now that the document is formed, translate it:
80                      #   - Remove the leading tag
81                      $paragraph =~ s/^<p>//s;
82
83                      #   - push to output the leading tag (untranslated) and the
84                      #     rest of the paragraph (translated)
85                      $self->pushline(  "<p>"
86                                      . $document->translate($paragraph,$pararef)
87                                      );
88
89                      next PARAGRAPH;
90                  } else {
91                      # Append to the paragraph
92                      $paragraph .= $line;
93                      $pararef = $lref unless(length($pararef));
94                  }
95
96                  # Reinit the loop
97                  ($line,$lref)=$self->shiftline();
98              }
99              # Did not get a defined line? End of input file.
100              return;
101          }
102        }
103
104       Once you've implemented the parse function, you can use your document
105       class, using the public interface presented in the next section.
106

PUBLIC INTERFACE for scripts using your parser

108   Constructor
109       process(%)
110           This function can do all you need to do with a po4a document in one
111           invocation. Its arguments must be packed as a hash. ACTIONS:
112
113           a. Reads all the PO files specified in po_in_name
114
115           b. Reads all original documents specified in file_in_name
116
117           c. Parses the document
118
119           d. Reads and applies all the addenda specified
120
121           e. Writes the translated document to file_out_name (if given)
122
123           f. Writes the extracted PO file to po_out_name (if given)
124
125           ARGUMENTS, beside the ones accepted by new() (with expected type):
126
127           file_in_name (@)
128               List of filenames where we should read the input document.
129
130           file_in_charset ($)
131               Charset used in the input document (if it isn't specified, it
132               will try to detect it from the input document).
133
134           file_out_name ($)
135               Filename where we should write the output document.
136
137           file_out_charset ($)
138               Charset used in the output document (if it isn't specified, it
139               will use the PO file charset).
140
141           po_in_name (@)
142               List of filenames where we should read the input PO files from,
143               containing the translation which will be used to translate the
144               document.
145
146           po_out_name ($)
147               Filename where we should write the output PO file, containing
148               the strings extracted from the input document.
149
150           addendum (@)
151               List of filenames where we should read the addenda from.
152
153           addendum_charset ($)
154               Charset for the addenda.
155
156       new(%)
157           Create a new po4a document. Accepted options (but be in a hash):
158
159           verbose ($)
160               Sets the verbosity.
161
162           debug ($)
163               Sets the debugging.
164
165   Manipulating document files
166       read($)
167           Add another input document at the end of the existing one. The
168           argument is the filename to read.
169
170           Please note that it does not parse anything. You should use the
171           parse() function when you're done with packing input files into the
172           document.
173
174       write($)
175           Write the translated document to the given filename.
176
177   Manipulating PO files
178       readpo($)
179           Add the content of a file (which name is passed as argument) to the
180           existing input PO. The old content is not discarded.
181
182       writepo($)
183           Write the extracted PO file to the given filename.
184
185       stats()
186           Returns some statistics about the translation done so far. Please
187           note that it's not the same statistics than the one printed by
188           msgfmt --statistic. Here, it's stats about recent usage of the PO
189           file, while msgfmt reports the status of the file. It is a wrapper
190           to the Locale::Po4a::Po::stats_get function applied to the input PO
191           file. Example of use:
192
193               [normal use of the po4a document...]
194
195               ($percent,$hit,$queries) = $document->stats();
196               print "We found translations for $percent\%  ($hit from $queries) of strings.\n";
197
198   Manipulating addenda
199       addendum($)
200           Please refer to po4a(7) for more information on what addenda are,
201           and how translators should write them. To apply an addendum to the
202           translated document, simply pass its filename to this function and
203           you are done ;)
204
205           This function returns a non-null integer on error.
206

INTERNAL FUNCTIONS used to write derivated parsers

208   Getting input, providing output
209       Four functions are provided to get input and return output. They are
210       very similar to shift/unshift and push/pop. The first pair is about
211       input, while the second is about output. Mnemonic: in input, you are
212       interested in the first line, what shift gives, and in output you want
213       to add your result at the end, like push does.
214
215       shiftline()
216           This function returns the next line of the doc_in to be parsed and
217           its reference (packed as an array).
218
219       unshiftline($$)
220           Unshifts a line of the input document and its reference.
221
222       pushline($)
223           Push a new line to the doc_out.
224
225       popline()
226           Pop the last pushed line from the doc_out.
227
228   Marking strings as translatable
229       One function is provided to handle the text which should be translated.
230
231       translate($$$)
232           Mandatory arguments:
233
234           - A string to translate
235
236           - The reference of this string (i.e. position in inputfile)
237
238           - The type of this string (i.e. the textual description of its
239             structural role; used in Locale::Po4a::Po::gettextization(); see
240             also po4a(7), section Gettextization: how does it work?)
241
242           This function can also take some extra arguments. They must be
243           organized as a hash. For example:
244
245             $self->translate("string","ref","type",
246                              'wrap' => 1);
247
248           wrap
249               boolean indicating whether we can consider that whitespaces in
250               string are not important. If yes, the function canonizes the
251               string before looking for a translation or extracting it, and
252               wraps the translation.
253
254           wrapcol
255               the column at which we should wrap (default: 76).
256
257           comment
258               an extra comment to add to the entry.
259
260           Actions:
261
262           - Pushes the string, reference and type to po_out.
263
264           - Returns the translation of the string (as found in po_in) so that
265             the parser can build the doc_out.
266
267           - Handles the charsets to recode the strings before sending them to
268             po_out and before returning the translations.
269
270   Misc functions
271       verbose()
272           Returns if the verbose option was passed during the creation of the
273           TransTractor.
274
275       debug()
276           Returns if the debug option was passed during the creation of the
277           TransTractor.
278
279       detected_charset($)
280           This tells TransTractor that a new charset (the first argument) has
281           been detected from the input document. It can usually be read from
282           the document header. Only the first charset will remain, coming
283           either from the process() arguments or detected from the document.
284
285       get_out_charset()
286           This function will return the charset that should be used in the
287           output document (usually useful to substitute the input document's
288           detected charset where it has been found).
289
290           It will use the output charset specified in the command line. If it
291           wasn't specified, it will use the input PO's charset, and if the
292           input PO has the default "CHARSET", it will return the input
293           document's charset, so that no encoding is performed.
294
295       recode_skipped_text($)
296           This function returns the recoded text passed as argument, from the
297           input document's charset to the output document's one. This isn't
298           needed when translating a string (translate() recodes everything
299           itself), but it is when you skip a string from the input document
300           and you want the output document to be consistent with the global
301           encoding.
302

FUTURE DIRECTIONS

304       One shortcoming of the current TransTractor is that it can't handle
305       translated document containing all languages, like debconf templates,
306       or .desktop files.
307
308       To address this problem, the only interface changes needed are:
309
310       - take a hash as po_in_name (a list per language)
311
312       - add an argument to translate to indicate the target language
313
314       - make a pushline_all function, which would make pushline of its
315         content for all language, using a map-like syntax:
316
317             $self->pushline_all({ "Description[".$langcode."]=".
318                                   $self->translate($line,$ref,$langcode)
319                                 });
320
321       Will see if it's enough ;)
322

AUTHORS

324        Denis Barbier <barbier@linuxfr.org>
325        Martin Quinson (mquinson#debian.org)
326        Jordi Vilalta <jvprat@gmail.com>
327
328
329
330perl v5.16.3                      2014-06-10     Locale::Po4a::TransTractor(3)
Impressum