PO4A(1p)

НАЗВАНИЕ
po4a - обновление PO-файлов и переведённой документации за один проход

СИНТАКСИС
po4a [параметры] файл_настроек

ОПИСАНИЕ
po4a (PO for anything, PO для всего) упрощает поддержку переводов документации, используя обычные инструменты gettext. Основная идея po4a состоит в том, что оно отделяет перевод содержимого от структуры документа. Пошаговое вводное руководство по работе с данным проектом можно посмотреть на странице po4a(7).

Если вы запускаете программу po4a в первый раз, когда у вас есть только файл настроек и сами документы, которые вы собираетесь переводить (называемые мастер-документами), то она создаёт POT-файл (также называемый «шаблон перевода»), который содержит все переводимые строки документа в формате, который облегчает труд переводчиков.

Такие POT-файлы можно переводить с помощью специальных редакторов, как, например, GNOME Translation Editor, Lokalize из KDE или poedit, или же процесс их перевода можно интегрировать в онлайн-платформу локализации, как weblate или pootle. Результат перевода — это набор PO-файлов; по одному для каждого языка.

Если вы запускаете программу po4a, когда у вас есть и мастер-документ, и PO-файлы, то она создаёт переведённые документы, вставляя содержимое переводов (из PO-файлов) в структуру оригинального мастер-документа.

Если мастер-документы будут изменены в процессе работы, po4a обновит PO и POT-файлы в соответствии с изменениями, дабы переводчики без проблем заметили эти изменения и обновили свои переводы. В зависимости от ваших настроек, po4a или отбросит частично переведённые документы, или создаст документ, сочетая текст на Английском (для новых или изменённых абзацев) и на целевом языке перевода (для абзацев уже присутствующих в PO-файле).

По умолчанию переведённые документы создаются, когда переведено, как минимум, 80% содержимого (см. описание параметра --keep ниже). Если вы будете отбрасывать весь перевод в случае, когда он завершён не на все 100%, то это будет обескураживающим фактором для переводчиков; с другой стороны, вы можете вызвать у конечных пользователей затруднения, предоставляя им «переводы», которые слишком далеки от завершения.

  Наглядный обзор
   мастер-документ -----+--------->-------->--------+
 (создание документа)   |                           |
                        V     (выполнение po4a)     >--+--> переводы
                        |                           |  |
 существующие PO-файлы ->-> обновлённые PO-файлы ->-+  |
        ^                            |                 |
        |                            V                 |
        +----------<---------<-------+                 ^
                 (ручной перевод)                      |
                                                       |
 дополнение -->----------------------------------------+

Мастер-документы создаются авторами, пишущими документацию. Любые изменения po4a автоматически отображает в PO-файлах, которые затем обновляются переводчиками. Все изменения в PO-файлах (как сделанные po4a, так и вручную) автоматически отображаются в переведённых документах. Вы можете сымитировать это поведение с помощью сценариев po4a-updatepo(1) и po4a-translate(1), вызывая их из make-файлов, но это монотонное и докучливое занятие (см. po4a(7)). Настоятельно рекомендуется, вместо этого использовать программу po4a.

ПАРАМЕТРЫ

-k, --keep
    Минимальное пороговое значение, в процентах, для сохранения (например, для записи) результирующего файла (по умолчанию: 80). То есть, по умолчанию, для того чтобы файл был записан, необходимо перевести как минимум 80%.

-h, --help
    Отобразить короткую справку.

-M, --master-charset
    Кодировка файлов переводимых документов. Обратите внимание, что все мастер-документы должны использовать одну и ту же кодировку.

-L, --localized-charset
    Кодировка файлов локализованных документов. Обратите внимание, что все переведённые документы должны использовать одну и ту же кодировку.

-A, --addendum-charset
    Кодировка дополнений. Обратите внимание, что все дополнения должны иметь одну и ту же кодировку.

-V, --version
    Отобразить версию и завершить работу сценария.

-v, --verbose
    Увеличить количество выводимой пояснительной информации.

-q, --quiet
    Уменьшить количество выводимой пояснительной информации.

-d, --debug
    Вывод отладочной информации.

-o, --option
    Extra option(s) to pass to the format plugin. See the documentation of each plugin for more information about the valid options and their meanings. For example, you could pass '-o tablecells' to the AsciiDoc parser, while the text parser would accept '-o tabs=split'.

-f, --force
    Всегда создавать POT и PO-файлы, даже если po4a считает, что это не требуется.

    Поведение по умолчанию (когда параметр --force не установлен) следующее:

        Если POT-файл уже существует, он создаётся повторно, если мастер-документ или файл настроек был недавно изменён (и если не задан параметр --no-update). POT-файл также записывается во временный документ и po4a проверяет, что изменения действительно необходимы.

        Кроме того, перевод обновляется (regenerated) только если его мастер-документ, PO-файл, один из его дополнений или файл настроек были недавно обновлены. Чтобы избежать попыток обновления переводов, которые не преодолели порогового значения (см. --keep), можно создать файл с расширением .po4a-stamp (см. --stamp).

    Если мастер-документ включает файлы, вам необходимо использовать флаг --force, потому что время изменения включённых файлов не принимается во внимание.

    PO-файлы всегда обновляются из POT-файлов с помощью msgmerge -U.

--stamp
    Указывает po4a создать файлы-заглушки, если перевод не создаётся, поскольку он не преодолел порогового значения. Эти файлы будут называться также как и переведённый документ, с расширением .po4a-stamp.

    Примечание: Параметр активирует только создание .po4a-stamp файлов. Файлы-заглушки используются всегда если они существуют, и удаляются при выполнении --rm-translations или когда файл полностью переведён.

--no-translations
    Не регенерировать переведённые документы, только обновлять POT и PO-файлы.

--no-update
    Не менять POT и PO-файлы, только обновить переводы.

--keep-translations
    Не удалять файлы перевода даже если перевод не соответствует пороговому значению, заданному --keep. Этот параметр указывает po4a не создавать новые переведённые файлы с недостаточным количеством переведённого материала, а сохранять старые переводы, которые находятся в упадке из-за изменений в мастер-документах.

    ПРЕДУПРЕЖДЕНИЕ: этот флаг изменяет поведение po4a достаточно радикальным образом: ваши переведённые файлы не будут обновляться вообще, пока перевод не улучшится. Используйте этот ключ только если вам больше по нраву поставлять устаревшую, но переведённою документацию, нежели только точную, но непереведённую.

--rm-translations
    Удалить переведённые файлы (подразумевает --no-translations).

--no-backups
    Этот флаг ничего не делает начиная с 0.41 и может быть удалён в последующих версиях.

--rm-backups
    Этот флаг ничего не делает начиная с 0.41 и может быть удалён в последующих версиях.

--translate-only переводимый-файл
    Перевести только указанный файл. Это может быть полезно, чтобы ускорить обработку, когда конфигурационный файл содержит значительное количество файлов. Заметим, что этот параметр не обновляет PO и POT-файлы. Этот параметр может быть указан несколько раз.

--variable переменная=значение
    Определяет переменную которая будет использоваться в файле настроек po4a. Каждое появление $(переменная) будет замещено на значение. Данный параметр можно использовать несколько раз.

--srcdir ИСХОДНЫЙ_КАТАЛОГ
    Задаёт базовый каталог для всех входных документов, указанных в файле настроек po4a.

    If both destdir and srcdir are specified, input files are searched in the following directories, in order: destdir, the current directory and srcdir. Output files are written to destdir if specified, or to the current directory.

--destdir КАТАЛОГ_НАЗНАЧЕНИЯ
    Задаёт базовый каталог для всех выходных документов, указанных в файле настроек po4a (см. описание --srcdir выше).

  Параметры, изменяющие заголовок POT-файла

--porefs тип
    Задаёт формат сносок в комментариях PO-файла. Аргумент l<тип> может быть одним из: never — не выводить никаких сносок, noline — не выводить номера строк (точнее, все номера строк будут заменены на 1), counter — заменяет номера строк инкрементным счётчиком и full — включает полноценные сноски (по умолчанию: full).

--wrap-po no|newlines|число (по умолчанию: 76)
    Задаёт, как должны переносится строки в PO-файле. С помощью этого параметра можно выбрать или чтобы в файлах были удобно расставлены переносы строк, хотя это и может привести к конфликтам в git, или чтобы файлы больше подходили для автоматической обработки, хотя это и снизит удобство чтения оных людьми.

    Исторически, gettext переносил строки в PO-файлах на 77-м столбце по косметическим соображениям. Этот параметр задаёт поведение po4a. Если в нём указано число, po4a будет переносить строки в PO-файле после данного столбца и после символов перевода строки в содержимом. Если указано newlines, то po4a будет разделять msgid и msgstr на строки только в местах перевода строк в самом их содержимом. Если же указано no, то po4a вообще не будет переносить строки в PO-файле. Строки комментариев со ссылками на местоположение строки в исходном документе всегда разбиваются на строки по усмотрению инструментов gettext, которые используются внутри po4a.

    Замечание: этот параметр ни как не влияет на то, как будут расставлены переносы строк внутри самих msgid и msgstr, т.е. на то, как переносы строк будут добавляться к их содержимому.

--master-language
    Язык файлов переводимых документов. Обратите внимание, что все мастер-документы должны быть на одном языке.

--msgid-bugs-address email@address
    Установить адрес для сообщений об ошибках в msgid. По умолчанию, созданные POT-файлы не имеют поля Report-Msgid-Bugs-To.

--copyright-holder строка
    Указать владельца авторских прав в заголовке POT файла. Значение по умолчанию: «Free Software Foundation, Inc.»

--package-name строка
    Указать имя пакета в заголовке POT-файла. Значение по умолчанию: «PACKAGE».

--package-version строка
    Указать версию пакета в заголовке POT-файла. Значение по умолчанию: «VERSION».

  Параметры, изменяющие PO-файлы

--msgmerge-opt параметры
    Дополнительные параметры для msgmerge(1).

    Примечание: $lang будет заменён на текущий язык.

--no-previous
    Данный параметр удаляет параметр --previous из настроек msgmerge. Это позволяет использовать версии gettext ниже 0.16.

--previous
    Данный параметр добавляет --previous к параметрам, передаваемым msgmerge. Для жтого требуется gettext версии 0.16 или выше; он активирован по умолчанию.

ФАЙЛ НАСТРОЕК
po4a ожидает, что в качестве аргумента ему будет передан файл настроек. Этот файл должен содержать следующие данные:

•   Путь к PO-файлам и список языков, доступных в проекте;

•   Опционально, некоторые глобальные параметры и, так называемые, псевдонимы настроек (configuration aliases), которые можно использовать в качестве шаблонов для настройки отдельных мастер-файлов;

•   Список всех мастер-файлов, которые нужно переводить, и специфические параметры для оных.

Каждая строка файла должна содержать директиву, заключённую в квадратные скобки, и её параметры. Комментарии начинаются с символа «#» и продолжаются до конца строки. Конец строки может быть экранирован (с помощью обратного слеша "\"), в таком случае комментарий может быть растянут на несколько строк.

Some full examples are presented on this page, while other examples can be found in the "t/cfg" directory of the source distribution.

  Поиск POT и PO-файлов
The simplest solution is to explicitly give the path to POT and PO files, as follows:

 [po4a_paths] man/po/project.pot ru:man/po/ru.po fr:man/po/fr.po

Это задаст пути к POT-файлу, а также к русскому и французскому PO-файлам.

The same information can be written as follows to reduce the risk of copy/paste errors:

 [po4a_langs] fr ru
 [po4a_paths] man/po/project.pot $lang:man/po/$lang.po

Вместо $lang будет автоматически подставлен, код языка из списка, что уменьшает риск ошибок, вызванных копированием/вставкой при добавлении нового языка.

You can further compact the same information by only providing the path to the directory containing your translation project, as follows.

 [po_directory] man/po/

The provided directory must contain a set of PO files, each named XX.po with "XX" the ISO 639-1 of the language used in this file. The directory must also contain a single POT file, with the ".pot" file extension. For the first run, this file can be empty but it must exist (po4a cannot guess the name to use before the extension).

Note that you must choose only one between "po_directory" and "po4a_paths". The first one ("po_directory") is more compact, further reduces the risk of copy/paste error, but forces you to use the expected project structure and file names. The second one ("po4a_paths"), is more explicit, probably more readable, and advised when you setup your first project with po4a.

Централизованные или раздельные PO-файлы?

By default, po4a produces one single PO file per target language, containing the whole content of your translation project. As your project grows, the size of these files may become problematic. When using weblate, it is possible to specify priorities for each translation segment (i.e., msgid) so that the important ones get translated first. Still, some translation teams prefer to split the content in several files.

Чтобы использовать отдельный PO-файл для каждого мастер-файла, просто добавьте $master в имя своего PO-файла в директиве "[po4a_paths]":

 [po4a_paths] doc/$master/$master.pot $lang:doc/$master/$lang.po

Если возникают конфликты из-за того, что у нескольких файлов одинаковые имена, то имя мастер-файла может быть задано добавлением параметра "master:file="имя:

 [po4a_langs] de fr ru
 [po4a_paths] l10n/po/$master.pot $lang:l10n/po/$master.$lang.po
 [type: xml] foo/gui.xml $lang:foo/gui.$lang.xml master:file=foo-gui
 [type: xml] bar/gui.xml $lang:bar/gui.$lang.xml master:file=bar-gui

В раздельном режиме po4a создаёт временный сборник всех переводов во время обновления PO-файлов, чтобы объединить перевод одинаковых строк из различных PO-файлов. Если два PO-файла имеют различные переводы для одной и той же строки, po4a пометит данные переводы как неточные и добавит оба варианта в каждый PO-файл, содержащий эту строку. Затем, когда переводчик снимет пометку «неточно» хотя бы в одном PO-файле, перевод данной строки будет обновлён во всех PO-файлах автоматически.

  Задание документов для перевода
Вы также должны перечислить список документов, которые следует переводить. Для каждого мастер-файла нужно указать, какой использовать парсер формата, местоположение, куда записывать переведённые документы, а также, по необходимости, некоторые дополнительные параметры, например:

 [type: sgml] doc/my_stuff.sgml fr:doc/fr/mon_truc.sgml \
              ru:doc/ru/mein_kram.sgml
 [type: man] script fr:doc/fr/script.1 ru:doc/ru/script.1
 [type: docbook] doc/script.xml fr:doc/fr/script.xml \
             ru:doc/ru/script.xml

Но, опять же, такие тяжеловесные конструкции сложно читать и изменять, например, когда нужно добавить новый язык. Намного проще будет реорганизовать всё это с помощью шаблонов с $lang:

 [type: sgml]    doc/my_stuff.sgml $lang:doc/$lang/my_stuff.sgml
 [type: man]     script.1          $lang:po/$lang/script.1
 [type: docbook] doc/script.xml    $lang:doc/$lang/script.xml

  Задание параметров
Есть два вида параметров: параметры po4a, которые задают значения по умолчанию для параметров командной строки самого po4a, и параметры форматов, которые изменяют поведение парсера конкретного формата. Параметром po4a будет являться, например, если вы зададите в своём файле настроек, что значение по умолчанию параметра командной строки --keep будет 50% вместо 80%. Параметры форматов описаны на справочной странице каждого отдельного модуля парсера конкретного формата, например Locale::Po4a::Xml(3pm). Вы, например, можете передать nostrip парсеру XML, чтобы он не убирал пробелы у извлекаемых им строк.

Вы можете передать эти параметры для конкретного мастер-файла или даже для перевода файла на конкретный язык, используя "opt:" и "opt_XX:" для языка "XX". В примере ниже, параметр nostrip передаётся парсеру XML (для всех языков), а порог завершения перевода будет уменьшен до 0% только для французского (чтобы он никогда не отбрасывался).

 [type:xml] toto.xml $lang:toto.$lang.xml opt:"-o nostrip" opt_fr:"--keep 0"

В любом случае, такие настройки должны находится в конце строки. Имена файлов должны идти вначале, затем дополнение, если есть (см. ниже), и только затем параметры. Группировка разных частей строки параметров не очень важна, ибо внутри себя po4a просто соединяет их все в одну строку. Следующие варианты абсолютно эквивалентны:

  [type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20" opt:"-o nostrip" opt_fr:"--keep 0"
  [type:xml] toto.xml $lang:toto.$lang.xml opt:"--keep 20 -o nostrip" opt_fr:"--keep 0"
  [type:xml] toto.xml $lang:toto.$lang.xml opt:--keep opt:20 opt:-o opt:nostrip opt_fr:--keep opt_fr:0

Заметьте, что параметры, специфичные для отдельных языков не используются во время создания POT-файла. Например, невозможно передать nostrip парсеру только для французского перевода, так как тот же самый POT-файл используется для обновления всех языков. Так что специфичными для языка могут быть только те параметры, которые используются во время создания перевода, как параметр "--keep".

Настройка псевдонимов (aliases)

Наилучшим способом передать одинаковые параметры различным файлам будет определить псевдоним (alias) типа, как это показано ниже. В примере "--keep 0" передаётся всех документов на итальянский с помощью типа "test", который является расширением типа "man":

  [po4a_alias:test] man opt_it:"--keep 0"
  [type: test] man/page.1 $lang:man/$lang/page.1

Вы также можете расширить существующий тип, использовав то же самое имя для псевдонима. Это не будет считаться ошибкой рекурсивного определения:

  [po4a_alias:man] man opt_it:"--keep 0"
  [type: man] man/page.1 $lang:man/$lang/page.1

Глобальные параметры по умолчанию

Вы также можете использовать строки с директивой "[options]", чтобы определить параметры, которые должны использоваться для всех файлов, независимо от их типа.

  [options] --keep 20 --option nostrip

Как и параметры командной строки, параметры передаваемые в файле настроек можно сокращать:

  [options] -k 20 -o nostrip

Приоритет параметров

Параметры из каждого источника соединяются в одну строку, что гарантирует, что значения по умолчанию могут быть переопределены более специфическими параметрами. Порядок приоритетов следующий:

•   Директивы "[options]" задают значения по умолчанию, которые могут быть переопределены любым другим источником.

•   Затем идут псевдонимы типов.При этом настройки, специфичные для конкретных языков переопределяют те что применяются ко всем языкам.

•   Настройки, специфичные для конкретного мастер-файла переопределяют и настройки по умолчанию и те что заданы в псевдонимах типов. В данном случае настройки, специфичные для языков, также переопределяют общие.

•   Наконец, параметры, переданные в командной строке переопределяют любые параметры из файла настройки.

Пример

Пример, показывающий, как следует экранировать пробелы и кавычки:

 [po_directory] man/po/

 [options] --master-charset UTF-8

 [po4a_alias:man] man opt:"-o \"mdoc=NAME,SEE ALSO\""
 [type:man] t-05-config/test02_man.1 $lang:tmp/test02_man.$lang.1 \
            opt:"-k 75" opt_it:"-L UTF-8" opt_fr:--verbose

  Дополнение (addendum): добавление дополнительного содержимого в перевод
Если вы хотите добавить дополнительный раздел в перевод, например отдать дань уважения переводчику, тогда вам нужно указать дополнение, при определении мастер-документа. Подробности о синтаксисе файлов-дополнений можно получить на справочной странице po4a(7).

 [type: pod] script fr:doc/fr/script.1 \
             add_fr:doc/l10n/script.fr.add

Вы также можете использовать шаблоны языков:

 [type: pod] script $lang:doc/$lang/script.1 \
             add_$lang:doc/l10n/script.$lang.add

Если дополнение не получается применить, то весь перевод отбрасывается.

Модификаторы объявления дополнений

Модификаторы дополнений могут делать файл настройки проще, когда не все языки имеют дополнение или когда список дополнений меняется от языка к языку. Модификатор — это один символ, стоящий перед именем файла.

?   Использовать файл путь_к_дополнению, если этот файл существует, в противном случае — ничего не делать.

@   путь_к_дополнению является не обычным дополнением, а файлом содержащим список дополнений, по одному в каждой строке. Каждое такое дополнение также могут предварять свои модификаторы.

!   путь_к_дополнению отбрасывается, он не загружается и не будет загружаться никакими будущими определениями дополнений.

Например, чтобы включить дополнение для любого языка, для которого оно существует можно сделать следующее (если дополнение не существует, то сообщение об ошибке не будет выдано):

 [type: pod] script $lang:doc/$lang/script.1  add_$lang:?doc/l10n/script.$lang.add

Следующий пример задаёт список дополнений для каждого языка:

 [type: pod] script $lang:doc/$lang/script.1  add_$lang:@doc/l10n/script.$lang.add

  Фильтрация переведённых строк
Иногда, вам хочется скрыть некоторые строки от переводчиков. Для этого вы можете задать параметр "pot_in" в определении мастер-файла, дабы указать имя файла, из которого следует извлекать строки для создания POT-файла для перевода вместо настоящего мастер-файла. Например:

  [type:docbook] book.xml          \
          pot_in:book-filtered.xml \
          $lang:book.$lang.xml

С такими настройками строки для перевода будут извлекаться из book-filtered.xml (который должен быть создан до вызова po4a), а переведённые документы будут собираться на основе book.xml. В результате, все строки, которые есть только в book.xml, но не в book-filtered.xml не будут включены в PO-файлы, что предотвратит возможность того, что переводчики переведут что-то, что не должно быть переведено. Таким образом, эти строки останутся без изменений во время создания переведённых документов. Это, конечно, снижает фактический уровень готовности перевода, так что вам придётся снизить значение параметра "--keep", дабы документ всё равно создавался.

  ПРИМЕР ФАЙЛА НАСТРОЕК
TODO: Этот раздел действительно полезен?

Предположим, что вы сопровождаете программу foo, у которой есть man-страница man/foo.1, которая изначально поддерживается только на английском. Теперь вы как upstream или downstream сопровождающий хотите создать и поддерживать перевод. Сначала вам надо создать POT-файл, который вы позже отправите переводчикам, с помощью po4a-gettextize(1).

Так что в нашем случае мы бы выполнили

 cd man && po4a-gettextize -f man -m foo.1 -p foo.pot

Затем вы, вероятно, отправите этот файл в соответствующие группы перевода или предложите его для скачивания на своём web-сайте.

Теперь, предположим, вы получили три перевода перед выпуском новой версии вашего пакета: de.po (включая файл дополнений de.add), sv.po и pt.po. Поскольку вы не хотите менять свой Makefile всякий раз, когда вым присылают новый перевод, вы можете воспользоваться po4a с соответствующим файлом конфигурации. Давайте назовём его po4a.cfg. В нашем примере он будет иметь следующий вид:

 [po_directory] man/po4a/po/

 [type: man] man/foo.1 $lang:man/translated/$lang/foo.1 \
            add_$lang:?man/po4a/add_$lang/$lang.add opt:"-k 80"

В этом примере мы предположим, что ваши генерируемые переведённые man-страницы (а также все PO-файлы и файлы дополнений) должны хранится в man/translated/$lang/ (и соответственно в man/po4a/po/ и man/po4a/add_$lang/). В нашем примере каталог man/po4a/po/ будет содержать: de.po, pt.po и sv.po, а каталог man/po4a/add_de/ будет содержать de.add.

Отметим, использование модификатора ? т.к. только с немецким переводом (de.po)вам прислали файл дополнений.

Чтобы фактически собрать переводы man-страниц, вам осталось бы (только один раз!) добавить следующую строку к цели build соответствующего Makefile-а:

        po4a po4a.cfg

Как только это сделано, вам более не нужно менять Makefile, когда готовы новые переводы, то есть если французская команда присылает вам fr.po и fr.add, то вы просто кладёте их соответственно в man/po4a/po/ и man/po4a/add_fr/ и во время следующей сборки французский перевод автоматически создаётся в man/translated/fr/.

Заметьте, что вам по-прежнему нужна подходящая цель, чтобы устанавливать локализованные man-страницы вместе с Английскими.

В заключении, если вы не храните сгенерированные файлы в вашей системе контроля версий, вам также понадобится строка в вашей цели clean:
        -rm -rf man/translated

СМОТРИТЕ ТАКЖЕ
po4a-gettextize(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)

АВТОРСКИЕ ПРАВА И ЛИЦЕНЗИИ
Copyright 2002-2020 by SPI, inc.

Данная программа является свободным программным обеспечением; вы можете распространять и/или изменять её на условиях Универсальной общественной лицензии (GPL) GNU (см. файл COPYING).