Zen

Translation

Inputmaster documents --\-+---->-------->---------+
(doc authoring) | |
 /---> Output document V (po4a executions) >-----+--> translated
\| | / | (translated)documents
existing PO files -->--> updated PO files >-+ |
^ +-> parse() function -----+
/ \
Input PO --------/ | |
| V |
+----------<---------<-------+ ^
 \---> Output PO(manual translation process) |
(extracted)|
addendum -->--------------------------------------+

English type: verbatim
master documents ---+---->-------->---------+
(doc authoring) | |
V (po4a executions) >-----+--> translated
| | | documents
existing PO files -->--> updated PO files >-+ |
^ | |
| V |
+----------<---------<-------+ ^
(manual translation process) |
|
addendum -->--------------------------------------+

392/6000 · 600

Sign in to save the translation.

English Polish Actions
SYNOPSIS
SKŁADNIA
B<po4a> [I<options>] I<config_file>
B<po4a> [I<opcje>] I<plik_konfiguracyjny>
po4a (PO for anything) eases the maintenance of documentation translation using the classical gettext tools. The main feature of po4a is that it decouples the translation of content from its document structure. Please refer to the page L<po4a(7)> for a gentle introduction to this project.
 
Upon execution, B<po4a> parses all documentation files specified in its configuration file. It updates the PO files (containing the translation) to reflect any change to the documentation, and produce a translated documentation by injecting the content's translation (found in the PO files) into the structure of the original master document.
 
At first, the PO files only contain the strings to translate from the original documentation. This file format allows the translators to manually provide a translation for each paragraph extracted by B<po4a>. If the documentation is modified after translation, B<po4a> marks the corresponding translations as "fuzzy" in the PO file to request a manual review by the translators. The translators can also provide so-called "addendum", that are extra content stating for example who did the translation and how to report bugs.
 
master documents ---+---->-------->---------+
(doc authoring) | |
V (po4a executions) >-----+--> translated
| | | documents
existing PO files -->--> updated PO files >-+ |
^ | |
| V |
+----------<---------<-------+ ^
(manual translation process) |
|
addendum -->--------------------------------------+
Dokument wejściowy --\ /--> Dokument wyjściowy
\ / (przetłumaczony)
+-> funkcja parse() ---+
/ \
Wejściowy PO --------/ \--> Wyjściowy PO
(wyodrębniony)
The workflow of B<po4a> is asynchronous, as suited to open-source projects. The documentation writers author the master documents at their own pace. The translators review and update the translations in the PO files. The maintainers rerun B<po4a> on need, to reflect any change to the original documentation to the PO files, and to produce updated documentation translations, by injecting the latest translation into the latest document structure.
 
By default, a given translated document is produced when at least 80% of its content is translated. The untranslated text is kept in the original language. The produced documentation thus mixes languages if the translation is not complete. You can change the 80% threshold with the I<--keep> option described below. Note however that discarding translations as soon as they are not 100% may be discouraging for the translators whose work will almost never be shown to the users, while showing "translations" that are too incomplete may be troubling for the end users.
 
Storing the translated documentation files in the version control system is probably a bad idea, since they are automatically generated. The precious files are the PO files, that contain the hard work of your fellow translators. Also, some people find it easier to interact with the translators through an online platform such as S<weblate>, but this is naturally fully optional.
 
Quick start tutorial
 
Let's assume you maintain a program named B<foo> which has a man page F<man/foo.1> written in English (the bridge language in most open-source projects, but B<po4a> can be used from or to any language). Some times ago, someone provided a German translation named F<man/foo.de.1> and disappeared. This is a problem because you just got a bug report saying that your documentation contains a gravely misleading information that must be fixed in all languages, but you don't speak German so you can only modify the original, not the translation. Now, another contributor wants to contribute a translation to Japanese, a language that you don't master either.
 

Loading…

User avatar None

String updated in the repository

  1. po4a
  2. po4a-doc
  3. Polish
master documents ---+---->-------->---------+
(doc authoring) | |
V (po4a executions) >-----+--> translated
| | | documents
existing PO files -->--> updated PO files >-+ |
^ | |
| V |
+----------<---------<-------+ ^
(manual translation process) |
|
addendum -->--------------------------------------+

Dokument wejściowy --\ /--> Dokument wyjściowy
\ / (przetłumaczony)
+-> funkcja parse() ---+
/ \
Wejściowy PO --------/ \--> Wyjściowy PO
(wyodrębniony)

a year ago
User avatar None

Source string changed

  1. po4a
  2. po4a-doc
  3. Polish
Inputmaster documents --\-+---->-------->---------+
(doc authoring) | |
 /---> Output document V (po4a executions) >-----+--> translated
\| | / | (translated)documents
existing PO files -->--> updated PO files >-+ |
^ +-> parse() function -----+
/ \
Input PO --------/ | |
| V |
+----------<---------<-------+ ^
 \---> Output PO(manual translation process) |
(extracted)|
addendum -->--------------------------------------+

a year ago
Browse all string changes

Things to check

Starting spaces

Source and translation do not both start with same number of spaces

Fix string

Reset

Mismatching line breaks

Number of new lines in translation does not match source

Reset

Glossary

English Polish
po4a po4a Glossary

Software name

String information

Source string description
type: verbatim
Flags
no-wrap
Source string location
po4a:9
String age
a year ago
Last updated
11 months ago
Source string age
a year ago
Translation file
po/pod/pl.po, string 42