GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  LOCALE::PO4A::ASCIIDOC (3)

.ds Aq ’

NAME

Locale::Po4a::AsciiDoc - convert AsciiDoc documents from/to PO files

CONTENTS

DESCRIPTION

The po4a (PO 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.

Locale::Po4a::AsciiDoc is a module to help the translation of documentation in the AsciiDoc format.

OPTIONS ACCEPTED BY THIS MODULE

These are this module’s particular options:
<B>definitionsB> The name of a file containing definitions for po4a, as defined in the <B>INLINE CUSTOMIZATIONB> section. You can use this option if it is not possible to put the definitions in the document being translated.

In a definitions file, lines must not start by two slashes, but directly by <B>po4a:B>.

<B>entryB> Space-separated list of attribute entries you want to translate. By default, no attribute entries are translatable.
<B>macroB> Space-separated list of macro definitions.
<B>styleB> Space-separated list of style definitions.

INLINE CUSTOMIZATION

The AsciiDoc module can be customized with lines starting by <B>//po4a:B>. These lines are interpreted as commands to the parser. The following commands are recognized:
<B>//po4a: macro B>name<B>[B>attribute list<B>]B> This permits to describe in detail the parameters of a <B>macroB>; name must be a valid macro name, and it ends with an underscore if the target must be translated.

The attribute list argument is a comma separated list which contains informations about translatable arguments. This list contains either numbers, to define positional parameters, or named attributes.

If a plus sign (<B>+B>) is prepended to name, 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.

<B>//po4a: style B><B>[B>attribute list<B>]B> This permits to describe in detail which attributes of a style must be translated.

The attribute list 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.

If a plus sign (<B>+B>) is prepended to the style name, then the attribute list is translated as a whole. There is no need to define translatable attributes.

If a minus sign (<B>-B>) is prepended to the style name, then this attribute is not translated.

<B>//po4a: entry B>name This declares an attribute entry as being translatable. By default, they are not translated.

STATUS OF THIS MODULE

Tested successfully on simple AsciiDoc files.

AUTHORS



 Nicolas Franc\k:,ois <nicolas.francois@centraliens.net>
 Denis Barbier <barbier@linuxfr.org>



COPYRIGHT AND LICENSE



 Copyright 2005-2008 by Nicolas FRANC\k:,OIS <nicolas.francois@centraliens.net>.
 Copyright 2012 by Denis BARBIER <barbier@linuxfr.org>.



This program is free software; you may redistribute it and/or modify it under the terms of GPL (see the COPYING file).

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 LOCALE::PO4A::ASCIIDOC (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.