.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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::AsciiDoc 3pm" .TH Locale::Po4a::AsciiDoc 3pm "2018-12-09" "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::AsciiDoc \- convert AsciiDoc 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::AsciiDoc is a module to help the translation of documentation in the AsciiDoc format. .SH "OPTIONS ACCEPTED BY THIS MODULE" .IX Header "OPTIONS ACCEPTED BY THIS MODULE" These are this module's particular options: .IP "\fBdefinitions\fR" 4 .IX Item "definitions" The name of a file containing definitions for po4a, as defined in the \&\fB\s-1INLINE CUSTOMIZATION\s0\fR section. You can use this option if it is not possible to put the definitions in the document being translated. .Sp In a definitions file, lines must not start by two slashes, but directly by \fBpo4a:\fR. .IP "\fBentry\fR" 4 .IX Item "entry" Space-separated list of attribute entries you want to translate. By default, no attribute entries are translatable. .IP "\fBmacro\fR" 4 .IX Item "macro" Space-separated list of macro definitions. .IP "\fBstyle\fR" 4 .IX Item "style" Space-separated list of style definitions. .IP "\fBnoimagetargets\fR" 4 .IX Item "noimagetargets" By default, the targets of block images are translatable to give opportunity to make the content point to translated images. This can be stopped by setting this option. .SH "INLINE CUSTOMIZATION" .IX Header "INLINE CUSTOMIZATION" The AsciiDoc module can be customized with lines starting by \fB//po4a:\fR. These lines are interpreted as commands to the parser. The following commands are recognized: .IP "\fB//po4a: macro \fR\fIname\fR\fB[\fR\fIattribute list\fR\fB]\fR" 4 .IX Item "//po4a: macro name[attribute list]" This permits to describe in detail the parameters of a \fBmacro\fR; \&\fIname\fR must be a valid macro name, and it ends with an underscore if the target must be translated. .Sp The \fIattribute list\fR argument is a comma separated list which contains informations about translatable arguments. This list contains either numbers, to define positional parameters, or named attributes. .Sp If a plus sign (\fB+\fR) is prepended to \fIname\fR, then the macro and its arguments are translated as a whole. There is no need to define attribute list in this case, but brackets must be present. .IP "\fB//po4a: style \fR\fB[\fR\fIattribute list\fR\fB]\fR" 4 .IX Item "//po4a: style [attribute list]" This permits to describe in detail which attributes of a style must be translated. .Sp The \fIattribute list\fR argument is a comma separated list which contains informations about translatable arguments. This list contains either numbers, to define positional parameters, or named attributes. The first attribute is the style name, it will not be translated. .Sp If a plus sign (\fB+\fR) is prepended to the style name, then the attribute list is translated as a whole. There is no need to define translatable attributes. .Sp If a minus sign (\fB\-\fR) is prepended to the style name, then this attribute is not translated. .IP "\fB//po4a: entry \fR\fIname\fR" 4 .IX Item "//po4a: entry name" This declares an attribute entry as being translatable. By default, they are not translated. .SH "STATUS OF THIS MODULE" .IX Header "STATUS OF THIS MODULE" Tested successfully on simple AsciiDoc files. .SH "AUTHORS" .IX Header "AUTHORS" .Vb 2 \& Nicolas François \& Denis Barbier .Ve .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" .Vb 3 \& Copyright © 2005\-2008 Nicolas FRANÇOIS . \& Copyright © 2012 Denis BARBIER . \& Copyright © 2017 Martin Quinson . .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).