.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Publican::Translate 3pm"
.TH Publican::Translate 3pm "2015-08-27" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Publican::Translate \- Module for manipulating POT and PO files.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use Publican::Translate;
\&        my $po = Publican::Translate\->new();
\&
\&        $po\->update_pot();
\&        $po\->update_po({ langs => \*(Aqfr\-FR,de\-DE\*(Aq });
\&        $po\->update_po({ langs => \*(Aqall\*(Aq });
\&        $po\->merge_xml({ lang  => \*(Aqfr\-FR\*(Aq });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Creates, updates and merges \s-1POT\s0 and \s-1PO\s0 files for Publican projects.
.SH "INTERFACE"
.IX Header "INTERFACE"
.SS "new"
.IX Subsection "new"
Create a new Publican::Translate object.
.SS "trans_drop"
.IX Subsection "trans_drop"
Snapshot the source to give translation a stable base.
.SS "update_pot"
.IX Subsection "update_pot"
Update the pot files
.SS "po2xml"
.IX Subsection "po2xml"
Merge \s-1XML\s0 and \s-1PO\s0 into a translated \s-1XML\s0 file.
.SS "update_po"
.IX Subsection "update_po"
Update the \s-1PO\s0 files using internal process or msgmerge
.SS "merge_po"
.IX Subsection "merge_po"
Merge updated \s-1POT\s0 files in to existing \s-1PO\s0 files.
.SS "match_strings"
.IX Subsection "match_strings"
Compare 2 strings and return how closely they match.
.PP
Returns a vlaue between 0 and 1, weighted for string length.
.SS "update_po_all"
.IX Subsection "update_po_all"
Update the \s-1PO\s0 files for all languages
.SS "get_msgs"
.IX Subsection "get_msgs"
Get the strings to translate from an XML::TreeBuilder object
.SS "merge_msgs"
.IX Subsection "merge_msgs"
Merge translations in to \s-1XML\s0
.SS "translate"
.IX Subsection "translate"
Replace strings with translated strings.
.SS "print_msgs"
.IX Subsection "print_msgs"
Print the translation strings in an XML::TreeBuilder object to a \s-1POT\s0 file
.SS "header"
.IX Subsection "header"
Returns a valid \s-1PO\s0 header string.
.SS "detag"
.IX Subsection "detag"
Format a string for use in a \s-1PO\s0 file.
.SS "po_report"
.IX Subsection "po_report"
Generate translation statistics for the supplied language.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.ie n .IP """unknown args %s""" 4
.el .IP "\f(CWunknown args %s\fR" 4
.IX Item "unknown args %s"
All subs with named parameters will return this error when unexpected named arguments are provided.
.ie n .IP """%s is a required argument""" 4
.el .IP "\f(CW%s is a required argument\fR" 4
.IX Item "%s is a required argument"
Any sub with a mandatory parameter will return this error if the parameter is undef.
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
Publican requires no configuration files or environment variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
Carp
version
Publican
File::Path
Term::ANSIColor
DateTime
Locale::PO
XML::TreeBuilder
String::Similarity
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None reported.
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
No bugs have been reported.
.PP
Please report any bugs or feature requests to
\&\f(CW\*(C`publican\-list@redhat.com\*(C'\fR, or through the web interface at
<https://bugzilla.redhat.com/bugzilla/enter_bug.cgi?product=Publican&amp;component=publican>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jeff Fearn  \f(CW\*(C`<jfearn@redhat.com>\*(C'\fR