PO4A-GETTEXTIZE.1P

Section: User Contributed Perl Documentation (1)
Updated: 2025-05-04
Index Return to Main Contents

名稱

po4a-gettexalize-convert 將原始檔案(及其翻譯)轉換為 PO 檔案

簡介

po4a-gettextize -f fmt -m master.doc -l XX.doc -p XX.po

(XX.po is the output, all others are inputs)

描述

po4a (PO 代表任何東西)使用經典的 gettext 工具簡化了文件翻譯的維護。po4a 的主要特點是將內容的翻譯與文件結構分離。請參閱 po4a(7) 頁瞭解本專案的詳細介紹。

The po4a-gettextize script helps you converting your previously existing translations into a po4a-based workflow. This is only to be done once to salvage an existing translation while converting to po4a, not on a regular basis after the conversion of your project. This tedious process is explained in details in Section 'Converting a manual translation to po4a' below.

You must provide both a master file (e.g., the source in English) and an existing translated file (e.g., a previous translation attempt without po4a). If you provide more than one master or translation files, they will be used in sequence, but it may be easier to gettextize each page or chapter separately and then use msgmerge to merge all produced PO files. As you wish.

If the master document has non-ASCII characters, the new generated PO file will be in UTF-8. If the master document is completely in ASCII, the generated PO will use the encoding of the translated input document.

選項

-f, --format: 要處理的文件的格式。使用 --help-format 幫助格式選項檢視可用格式的列表。
-m, --master: 包含要翻譯的主文件的檔案。如果要對多個文件進行文字化，可以多次使用此選項。
-M, --master-charset: 包含要翻譯的文件的檔案的字符集。
-l, --localized: 包含本地化（已翻譯）文件的檔案。如果提供了多個主檔案，您可能希望多次使用此選項提供多個本地化檔案。
-L, --localized-charset: 包含本地化文件的檔案的字符集。
-p, --po: 訊息目錄應寫入的檔案。如果未給出，訊息目錄將寫入標準輸出。
-o, --option: 要傳遞給格式外掛的額外選項。有關有效選項及其含義的更多資訊，請參閱每個外掛的文件。例如，您可以將 '-o tablecells' 傳遞給 AsciiDoc 解析器，而文字解析器將接受 '-o tabs=split'。
-h, --help: 顯示簡短的幫助訊息。
--help-format: 列出 po4a 理解的文件格式。
-k --keep-temps: Keep the temporary master and localized POT files built before merging. This can be useful to understand why these files get desynchronized, leading to gettextization problems.
-V, --version: 顯示指令碼的版本並退出。
-v, --verbose: 增加程式的冗長程度。
-d, --debug: 輸出一些除錯資訊。
--msgid-bugs-address email@address: 設定 msgid 錯誤的報告地址。預設情況下，建立的 POT 檔案沒有 Report-Msgid-Bugs-To 欄位。
--copyright-holder string: 在 POT 標頭中設定版權所有者。預設值為“自由軟體基金會有限公司。”
--package-name string: 設定 POT 標頭的程式包名稱。預設值為“封裝”。
--package-version string: 設定 POT 標頭的軟體包版本。預設值為“版本”。

將手動翻譯轉換為 po4a

po4a-gettextize synchronizes the master and localized files to extract their content into a PO file. The content of the master file gives the msgid while the content of the localized file gives the msgstr. This process is somewhat fragile: the Nth string of the translated file is supposed to be the translation of the Nth string in the original.

Gettextization works best if you manage to retrieve the exact version of the original document that was used for translation. Even so, you may need to fiddle with both master and localized files to align their structure if it was changed by the original translator, so working on files' copies is advised.

Internally, each po4a parser reports the syntactical type of each extracted strings. This is how desynchronization are detected during the gettextization. In the example depicted below, it is very unlikely that the 4th string in translation (of type 'chapter') is the translation of the 4th string in original (of type 'paragraph'). It is more likely that a new paragraph was added to the original, or that two original paragraphs were merged together in the translation.

    Original         Translation

  chapter            chapter
    paragraph          paragraph
    paragraph          paragraph
    paragraph        chapter
  chapter              paragraph
    paragraph          paragraph

po4a-gettextize will verbosely diagnose any structure desynchronization. When this happens, you should manually edit the files to add fake paragraphs or remove some content here and there until the structure of both files actually match. Some tricks are given below to salvage the most of the existing translation while doing so.

If you are lucky enough to have a perfect match in the file structures out of the box, building a correct PO file is a matter of seconds. Otherwise, you will soon understand why this process has such an ugly name :) Even so, gettextization often remains faster than translating everything again. I gettextized the French translation of the whole Perl documentation in one day despite the many synchronization issues. Given the amount of text (2MB of original text), restarting the translation without first salvaging the old translations would have required several months of work. In addition, this grunt work is the price to pay to get the comfort of po4a. Once converted, the synchronization between master documents and translations will always be fully automatic.

After a successful gettextization, the produced documents should be manually checked for undetected disparities and silent errors, as explained below.

獲取文字化過程的提示和技巧

The gettextization stops as soon as a desynchronization is detected. When this happens, you need to edit the files as much as needed to re-align the files' structures. po4a-gettextize is rather verbose when things go wrong. It reports the strings that don't match, their positions in the text, and the type of each of them. Moreover, the PO file generated so far is dumped as gettextization.failed.po for further inspection.

Here are some tricks to help you in this tedious process and ensure that you salvage the most of the previous translation:

•: Remove all extra content of the translations, such as the section giving credits to the translators. They should be added separately to po4a as addenda (see po4a(7)).
•: When editing the files to align their structures, prefer editing the translation if possible. Indeed, if the changes to the original are too intrusive, the old and new versions will not be matched during the first po4a run after gettextization (see below). Any unmatched translation will be dumped anyway. That being said, you still want to edit the original document if it's too hard to get the gettextization to proceed otherwise, even if it means that one paragraph of the translation is dumped. The important thing is to get a first PO file to start with.
•: 不要猶豫，殺死任何原始內容，將不存在在翻譯版本。將 PO 檔案與文件同步時，以後將自動重新引入此內容。
•: You should probably inform the original author of any structural change in the translation that seems justified. Issues in the original document should reported to the author. Fixing them in your translation only fixes them for a part of the community. Plus, it is impossible to do so when using po4a ;) But you probably want to wait until the end of the conversion to po4a before changing the original files.
•: 有時，段落內容確實匹配，但不匹配其型別。修復它與格式相當相關。在 POD 和人中，它通常來自這樣一個事實，即其中一個包含以空白開頭的行，而另一個則不包含。在這些格式中，此類段落不能換行，因此成為不同的型別。只需刪除空間，您就沒事了。它也可能在 XML 中的標記名稱中出現拼寫錯誤。
同樣，當分隔線包含某些空格時，或者當 =item 行和項內容之間沒有空行時，兩個段落可能會合併到 POD 中。
•: Sometimes, the desynchronization message seems odd because the translation is attached to the wrong original paragraph. It is the sign of an undetected issue earlier in the process. Search for the actual desynchronization point by inspecting the file gettextization.failed.po that was produced, and fix the problem where it really is.
•: Other issues may come from duplicated strings in either the original or translation. Duplicated strings are merged in PO files, with two references. This constitutes a difficulty for the gettextization algorithm, that is a simple one to one pairing between the msgids of both the master and the localized files. It is however believed that recent versions of po4a deal properly with duplicated strings, so you should report any remaining issue that you may encounter.

Reviewing files produced by po4a-gettextize

Any file produced by po4a-gettextize should be manually reviewed, even when the script terminates successfully. You should skim over the PO file, ensuring that the msgid and msgstr actually match. It is not necessary to ensure that the translation is perfectly correct yet, as all entries are marked as fuzzy translations anyway. You only need to check for obvious matching issues because badly matched translations will be dumped in subsequent steps while you want to salvage them.

Fortunately, this step does not require to master the target languages as you only want to recognize similar elements in each msgid and its corresponding msgstr. As a speaker of French, English, and some German myself, I can do this for all European languages at least, even if I cannot say one word of most of these languages. I sometimes manage to detect matching issues in non-Latin languages by looking at string length, phrase structures (does the amount of interrogation marks match?) and other clues, but I prefer when someone else can review those languages.

If you detect a mismatch, edit the original and translation files as if po4a-gettextize reported an error, and try again. Once you have a decent PO file for your previous translation, backup it until you get po4a working correctly.

Running po4a for the first time

The easiest way to setup po4a is to write a po4a.conf configuration file, and use the integrated po4a program (po4a-updatepo and po4a-translate are deprecated). Please check the "CONFIGURATION FILE" Section in po4a(1) documentation for more details.

When po4a runs for the first time, the current version of the master documents will be used to update the PO files containing the old translations that you salvaged through gettextization. This can take quite a long time, because many of the msgids of from the gettextization do not exactly match the elements of the POT file built from the recent master files. This forces gettext to search for the closest one using a costly string proximity algorithm. For example, the first run over the Perl documentation's French translation (5.5 MB PO file) took about 48 hours (yes, two days) while the subsequent ones only take seconds.

Moving your translations to production

After this first run, the PO files are ready to be reviewed by translators. All entries were marked as fuzzy in the PO file by po4a-gettextization, forcing their careful review before use. Translators should take each entry to verify that the salvaged translation actually match the current original text, update the translation on need, and remove the fuzzy markers.

Once enough fuzzy markers are removed, po4a will start generating the translation files on disk, and you're ready to move your translation workflow to production. Some projects find it useful to rely on weblate to coordinate between translators and maintainers, but that's beyond po4a' scope.

另請參見

po4a(1), po4a-normalize(1), po4a-translate(1), po4a-updatepo(1), po4a(7).

作者

 Denis Barbier <barbier@linuxfr.org>
 Nicolas François <nicolas.francois@centraliens.net>
 Martin Quinson (mquinson#debian.org)

版權和許可

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

Index

將手動翻譯轉換為 po4a
Reviewing files produced by po4a-gettextize
Running po4a for the first time
Moving your translations to production

另請參見

作者

版權和許可

This document was created by using the manual pages.
Time: 17:05:10 GMT, May 04, 2025