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::Text is a module to help the translation of text documents into other [human] languages.

Paragraphs are split on empty lines (or lines containing only spaces or tabulations).

If a paragraph contains a line starting by a space (or tabulation), this paragraph won't be rewrapped.

OPTIONS ACCEPTED BY THIS MODULE

These are this module's particular options:

nobullets

Deactivate detection of bullets.

By default, when a bullet is detected, the bullet paragraph is not considered as a verbatim paragraph (with the no-wrap flag in the PO file), but the module rewraps this paragraph in the generated PO file and in the translation.

tabs=mode

Specify how tabulations shall be handled. The mode can be any of:

split

Lines with tabulations introduce breaks in the current paragraph.

verbatim

Paragraph containing tabulations will not be re-wrapped.

By default, tabulations are considered as spaces.

breaks=regex

A regular expression matching lines which introduce breaks. The regular expression will be anchored so that the whole line must match.

debianchangelog

Handle the header and footer of released versions, which only contain non translatable informations.

fortunes

Handle the fortunes format, which separate fortunes with a line which consists in '%' or '%%', and use '%%' as the beginning of a comment.

markdown

Handle some special markup in Markdown-formatted texts.

asciidoc

Handle documents in the AsciiDoc format.

control[=taglist]

Handle control files. A comma-separated list of tags to be translated can be provided.

STATUS OF THIS MODULE

Tested successfully on simple text files and NEWS.Debian files.

AUTHORS

 Nicolas François <[email protected]>

COPYRIGHT AND LICENSE

 Copyright 2005-2008 by Nicolas FRANÇOIS <[email protected]>.

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