Updating Document Translations with po4a-updatepo (with examples)

Updating a PO file according to the modification of its origin file

po4a-updatepo --format text --master path/to/master.txt --po path/to/result.po

Motivation: When updating documentation, it is essential to keep the translations up-to-date. This command allows you to update the translation (in PO format) of a documentation by comparing it with the origin file.

Explanation:

• --format text: Specifies the format of the origin file. In this example, the format is set to plain text.
• --master path/to/master.txt: Specifies the path of the origin file to be compared.
• --po path/to/result.po: Specifies the path of the PO file to be updated.

Example Output: The command updates the PO file path/to/result.po based on the modifications made to the origin file path/to/master.txt.

Getting a List of Available Formats

po4a-updatepo --help-format

Motivation: It is important to know the available formats that can be used with the po4a-updatepo command. This allows you to choose the appropriate format for your documentation.

Explanation: This command displays a list of available formats supported by po4a-updatepo, along with a brief description of each format.

Example Output:

Available formats are:
   amg         : Aide Generic
   texinfo     : GNU Texinfo
   wiki        : MediaWiki
   html        : Hypertext Markup Language
   man         : UNIX man page
   docbook     : DocBook / DocBook XML
   sgml        : Standard Generalized Markup Language
   pod         : Plain Old Documentation
   wml         : Website Meta Language
   xhtml       : Extensible Hypertext Markup Language

Updating Several PO files according to the modification of their origin file

po4a-updatepo --format text --master path/to/master.txt --po path/to/po1.po --po path/to/po2.po

Motivation: When multiple translations exist for a documentation, it is necessary to update all related PO files when the origin file is modified. This command allows you to update several PO files in a single command.

Explanation:

• --format text: Specifies the format of the origin file. In this example, the format is set to plain text.
• --master path/to/master.txt: Specifies the path of the origin file to be compared.
• --po path/to/po1.po --po path/to/po2.po: Specifies the paths of the PO files to be updated.

Example Output: The command updates the PO files path/to/po1.po and path/to/po2.po based on the modifications made to the origin file path/to/master.txt.