.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Locale::Po4a::Docbook 3pm"
.TH Locale::Po4a::Docbook 3pm "2023-01-03" "Po4a Tools" "Po4a Tools"
.\" 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"
Locale::Po4a::Docbook \- convert DocBook XML documents from/to PO files
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The po4a (\s-1PO\s0 for anything) project goal is to ease translations (and more
interestingly, the maintenance of translations) using gettext tools on
areas where they were not expected like documentation.
.PP
Locale::Po4a::Docbook is a module to help the translation of DocBook \s-1XML\s0
documents into other [human] languages.
.SH "STATUS OF THIS MODULE"
.IX Header "STATUS OF THIS MODULE"
This module is fully functional, as it relies in the Locale::Po4a::Xml
module. This only defines the translatable tags and attributes.
.PP
The only known issue is that it doesn't handle entities yet, and this includes
the file inclusion entities, but you can translate most of those files alone
(except the typical entities files), and it's usually better to maintain them
separated.
.SH "OVERRIDE THE DEFAULT BEHAVIOR WITH COMMAND LINE OPTIONS"
.IX Header "OVERRIDE THE DEFAULT BEHAVIOR WITH COMMAND LINE OPTIONS"
The default behavior of system provided modules is set to be on the safe side.
.PP
For example, the default of \fB<author>\fR tag is aiming it to appear under
\&\fB<para>\fR.  But you may be using it only under \fB<bookinfo>\fR.  For this
case, you may want to translate it independently for each author.
.PP
If you don't like the default behavior of the xml module and its derivative
modules, you can provide command line options to change their behavior.  For
example, you can add the following to the po4a configuration file:
.PP
.Vb 4
\&  opt:"\-k 0 \-o nodefault=\e"<bookinfo> <author>\e" \e
\&            \-o break=\e"<bookinfo> <author>\e" \e
\&            \-o untranslated=\e"<bookinfo>\e" \e
\&            \-o translated=\e"<author>\e""
.Ve
.PP
This overrides the default behavior for \fB<bookinfo>\fR and \fB<author>\fR,
set \fB<bookinfo>\fR and \fB<author>\fR to break input data stream on these
tags, set \fB<bookinfo>\fR not to translate its tagged content, and set \fB<author>\fR to translate its tagged content.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLocale::Po4a::TransTractor\fR\|(3pm), \fBLocale::Po4a::Xml\fR\|(3pm), \fBpo4a\fR\|(7)
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 1
\& Jordi Vilalta <jvprat@gmail.com>
.Ve
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.Vb 2
\& Copyright © 2004 Jordi Vilalta  <jvprat@gmail.com>
\& Copyright © 2007\-2009 Nicolas François <nicolas.francois@centraliens.net>
.Ve
.PP
This program is free software; you may redistribute it and/or modify it
under the terms of \s-1GPL\s0 (see the \s-1COPYING\s0 file).