---
name: "XML::TMX::Writer"
section: "3pm"
platform: "linux"
package: "libxml-tmx-perl"
version: "0.39-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/XML::TMX::Writer"
---

# XML::TMX::Writer(3pm)

Perl extension for writing TMX files

## NAME

XML::TMX::Writer - Perl extension for writing TMX files

## VERSION

version 0.39

## SYNOPSIS

```
   use XML::TMX::Writer;
   my $tmx = XML::TMX::Writer->new();
   $tmx->start_tmx(id => 'paulojjs');
   $tmx->add_tu('en' => 'some text', 'pt' => 'algum texto');
   $tmx->add_tu('en' => 'some text',
                'pt' => 'algum texto',
                 -note => [32, 34 ],
                 -prop => { q => 23,
                           aut => "jj"}
               );
   $tmx->end_tmx();
```

## DESCRIPTION

This module provides a simple way for writing TMX files.

## METHODS

The following methods are available:

### new

```
  $tmx = new XML::TMX::Writer();
```

Creates a new XML::TMX::Writer object

### start\_tmx

```
  $tmx->start_tmx(-output => 'some_file.tmx');
```

Begins a TMX file. Several options are available:

- \-output

  Output of the TMX, if none is defined stdout is used by default.

- tool

  Tool used to create the TMX. Defaults to 'XML::TMX::Writer'

- toolversion

  Some version identification of the tool used to create the TMX. Defaults to the current module version

- segtype

  Segment type used in the *\<tu\>* elements. Possible values are *block*, *paragraph*, *sentence* and *phrase*. Defaults to *sentence*.

- srctmf

  Specifies the format of the translation memory file from which the TMX document or segment thereof have been generated.

- adminlang

  Specifies the default language for the administrative and informative elements *\<note\>* and *\<prop\>*.

- srclang

  Specifies the language of the source text. If a *\<tu\>* element does not have a srclang attribute specified, it uses the one defined in the *\<header\>* element. Defaults to *\*all\**.

- datatype

  Specifies the type of data contained in the element. Depending on that type, you may apply different processes to the data.

  The recommended values for the datatype attribute are as follow (this list is not exhaustive):

  - unknown

    undefined

  - alptext

    WinJoust data

  - cdf

    Channel Definition Format

  - cmx

    Corel CMX Format

  - cpp

    C and C++ style text

  - hptag

    HP-Tag

  - html

    HTML, DHTML, etc

  - interleaf

    Interleaf documents

  - ipf

    IPF/BookMaster

  - java

    Java, source and property files

  - javascript

    JavaScript, ECMAScript scripts

  - lisp

    Lisp

  - mif

    Framemaker MIF, MML, etc

  - opentag

    OpenTag data

  - pascal

    Pascal, Delphi style text

  - plaintext

    Plain text (default)

  - pm

    PageMaker

  - rtf

    Rich Text Format

  - sgml

    SGML

  - stf-f

    S-Tagger for FrameMaker

  - stf-i

    S-Tagger for Interleaf

  - transit

    Transit data

  - vbscript

    Visual Basic scripts

  - winres

    Windows resources from RC, DLL, EXE

  - xml

    XML

  - xptag

    Quark XPressTag

- srcencoding

  All TMX documents are in Unicode. However, it is sometimes useful to know what code set was used to encode text that was converted to Unicode for purposes of interchange. This option specifies the original or preferred code set of the data of the element in case it is to be re-encoded in a non-Unicode code set. Defaults to none.

- id

  Specifies the identifier of the user who created the element. Defaults to none.

- \-note

  A reference to a list of notes to be added in the header.

- \-prop

  A reference fo a hash of properties to be added in the header. Keys are used as the `"type"` attribute, value as the tag contents.

### add\_tu

```
  $tmx->add_tu(srclang => LANG1, LANG1 => 'text1', LANG2 => 'text2');
  $tmx->add_tu(srclang => LANG1,
               LANG1 => 'text1',
               LANG2 => 'text2',
               -note => ["value1",  ## notes
                        "value2"],
               -prop => { type1 => ["value1","value"], #multiple values
                          _ => 'value2',  # anonymound properties
                         typen => ["valuen"],}
              );
```

Adds a translation unit to the TMX file. Several optional labels can be specified:

- id

  Specifies an identifier for the *\<tu\>* element. Its value is not defined by the standard (it could be unique or not, numeric or alphanumeric, etc.).

- srcencoding

  Same meaning as told in **start\_tmx** method.

- datatype

  Same meaning as told in **start\_tmx** method.

- segtype

  Same meaning as told in **start\_tmx** method.

- srclang

  Same meaning as told in **start\_tmx** method.

### end\_tmx

```
  $tmx->end_tmx();
```

Ends the TMX file, closing file handles if necessary.

## SEE ALSO

TMX Specification \<https://www.gala-global.org/oscarStandards/tmx/tmx14b.html\>

## CONTRIBUTORS

Paulo Jorge Jesus Silva, \<paulojjs@bragatel.pt\>

## AUTHORS

- •

  Alberto Simões \<ambs@cpan.org\>

- •

  José João Almeida \<jj@di.uminho.pt\>

## COPYRIGHT AND LICENSE

This software is copyright (c) 2010-2017 by Projeto Natura \<natura@di.uminho.pt\>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.