Man page 3 : Locale::Po4a::TransTractor

process(%) 4 This function can do all you need to do with a po4a document in one invocation. Its arguments must be packed as a hash. ACTIONS:

a. 3 Reads all the PO files specified in po_in_name

b. 3 Reads all original documents specified in file_in_name

c. 3 Parses the document

d. 3 Reads and applies all the addenda specified

e. 3 Writes the translated document to file_out_name (if given)

f. 3 Writes the extracted PO file to po_out_name (if given)
    .Sp ARGUMENTS, beside the ones accepted by new() (with expected type):

file_in_name (@) 4 List of filenames where we should read the input document.

file_in_charset ($) 4 Charset used in the input document (if it isn't specified, it will try to detect it from the input document).

file_out_name ($) 4 Filename where we should write the output document.

file_out_charset ($) 4 Charset used in the output document (if it isn't specified, it will use the PO file charset).

po_in_name (@) 4 List of filenames where we should read the input PO files from, containing the translation which will be used to translate the document.

po_out_name ($) 4 Filename where we should write the output PO file, containing the strings extracted from the input document.

addendum (@) 4 List of filenames where we should read the addenda from.

addendum_charset ($) 4 Charset for the addenda.

new(%) 4 Create a new po4a document. Accepted options (but be in a hash):

verbose ($) 4 Sets the verbosity.

debug ($) 4 Sets the debugging.

read($) 4 Add another input document at the end of the existing one. The argument is the filename to read. .Sp Please note that it does not parse anything. You should use the parse() function when you're done with packing input files into the document.

write($) 4 Write the translated document to the given filename.

readpo($) 4 Add the content of a file (which name is passed in argument) to the existing input PO. The old content is not discarded.

writepo($) 4 Write the extracted PO file to the given filename.

stats() 4 Returns some statistics about the translation done so far. Please note that it's not the same statistics than the one printed by msgfmt --statistic. Here, it's stats about recent usage of the PO file, while msgfmt reports the status of the file. It is a wrapper to the Locale::Po4a::Po::stats_get function applied to the input PO file. Example of use: .Sp [normal use of the po4a document...] ($percent,$hit,$queries) = $document->stats(); print "We found translations for $percent\% ($hit from $queries) of strings.\n";

addendum($) 4 Please refer to po4a (7) for more information on what addenda are, and how translators should write them. To apply an addendum to the translated document, simply pass its filename to this function and you are done ;) .Sp This function returns a non-null integer on error.

Four functions are provided to get input and return output. They are very similar to shift/unshift and push/pop. The first pair is about input, while the second is about output. Mnemonic: in input, you are interested in the first line, what shift gives, and in output you want to add your result at the end, like push does.

shiftline() 4 This function returns the next line of the doc_in to be parsed and its reference (packed as an array).

unshiftline($$) 4 Unshifts a line of the input document and its reference.

pushline($) 4 Push a new line to the doc_out.

popline() 4 Pop the last pushed line from the doc_out.

One function is provided to handle the text which should be translated.

translate($$$) 4 Mandatory arguments:

- 2 A string to translate

- 2 The reference of this string (ie, position in inputfile)

- 2 The type of this string (ie, the textual description of its structural role ; used in Locale::Po4a::Po::gettextization() ; see also po4a (7), section Gettextization: how does it work?)
    .Sp This function can also take some extra arguments. They must be organized as a hash. For example: .Sp $self->translate("string","ref","type", \*(Aqwrap\*(Aq => 1);

wrap 4 boolean indicating whether we can consider that whitespaces in string are not important. If yes, the function canonizes the string before looking for a translation or extracting it, and wraps the translation.

wrapcol 4 the column at which we should wrap (default: 76).

comment 4 an extra comment to add to the entry.
    .Sp Actions:

- 2 Pushes the string, reference and type to po_out.

- 2 Returns the translation of the string (as found in po_in) so that the parser can build the doc_out.

- 2 Handles the charsets to recode the strings before sending them to po_out and before returning the translations.

verbose() 4 Returns if the verbose option was passed during the creation of the TransTractor.

debug() 4 Returns if the debug option was passed during the creation of the TransTractor.

detected_charset($) 4 This tells TransTractor that a new charset (the first argument) has been detected from the input document. It can usually be read from the document header. Only the first charset will remain, coming either from the process() arguments or detected from the document.

get_out_charset() 4 This function will return the charset that should be used in the output document (usually useful to substitute the input document's detected charset where it has been found). .Sp It will use the output charset specified in the command line. If it wasn't specified, it will use the input PO's charset, and if the input PO has the default \*(L"CHARSET\*(R", it will return the input document's charset, so that no encoding is performed.

recode_skipped_text($) 4 This function returns the recoded text passed as argument, from the input document's charset to the output document's one. This isn't needed when translating a string (translate() recodes everything itself), but it is when you skip a string from the input document and you want the output document to be consistent with the global encoding.