NAME

XML::TMX::Reader - Perl extension for reading TMX files

SYNOPSIS

   use XML::TMX::Reader;

   my $reader = XML::TMX::Reader->new( $filename );

   $reader -> for_tu( sub {
       my $tu = shift;
       #blah blah blah
   });

   @used_languages = $reader->languages;

   $reader->to_html()

DESCRIPTION

This module provides a simple way for reading TMX files.

METHODS

The following methods are available:

`new`

This method creates a new XML::TMX::Reader object. This process checks for the existence of the file and extracts some meta-information from the TMX header;

  my $reader = XML::TMX::Reader->new("my.tmx");

`ignore_markup`

This method is used to set the flag to ignore (or not) markup inside translation unit segments. The default is to ignore those markup.

If called without parameters, it sets the flag to ignore the markup. If you don't want to do that, use

  $reader->ignore_markup(0);

`languages`

This method returns the languages being used on the specified translation memory. Note that the module does not check for language code correctness or existence.

`for_tu`

Use for_tu to process all translation units from a TMX file. This version iterates for all tu (one at the time)

The configuration hash is a reference to a Perl hash. At the moment these are valid options:

-verbose: Set this option to a true value and a counter of the number of processed translation units will be printed to stderr.
-output | output: Filename to output the changed TMX to. Note that if you use this option, your function should return a hash reference where keys are language names, and values their respective translation.
gen_tu: Write at most gen_tu TUs
proc_tu: Process at most proc_tu TUs
patt: Only process TU that match patt.
-raw: Pass the XML directly to the method instead of parsing it.
-verbatim: Use segment contents verbatim, without any normalization.
-prop: A hashref of properties to be added to the TMX header block.
-note: An arrayref of notes to be added to the TMX header block.
-header: A boolean value. If set to true, the heading tags (and closing tag) of the TMX file are written. Otherwise, only the translation unit tags are written.

The function will receive two arguments:

a reference to a hash which maps:
the language codes to the respective translation unit segment;

a special key "-prop" that maps property names to properties;

a special key "-note" that maps to a list of notes.
a reference to a hash which contains the attributes for those translation unit tag;

If you want to process the TMX and return it again, your function should return an hash reference where keys are the languages, and values their respective translation.

`to_html`

Use this method to create a nice HTML file with the translation memories. Notice that this method is not finished yet, and relies on some images, on some specific locations.