Графічний огляд

 основні документи---+---->-------->---------+
 (документування)    |                       |
                     V   (виконання po4a)    >-----+--> переклади
                     |                       |     |
 наявні файли PO   -->-> оновлені файли PO >-+     |
      ^                            |               |
      |                            V               |
      +----------<---------<-------+               ^
       (процес перекладу підручника)               |
                                                   |
 додаток --->--------------------------------------+

Написанням основних документів займаються автори документації. Усі внесені ними зміни автоматично відтворюються за допомогою po4a у файлах PO, за оновлення перекладу яких відповідають перекладачі. Усі зміни у файлах PO (внесені вручну або за допомогою po4a) автоматично відтворюються у перекладених документах. Ви можете відтворити поведінку програми po4a за допомогою скриптів po4a-updatepo(1) і po4a-translate(1) у файлах makefile, втім, це доволі складно і марудно (див. po4a(7)). Наполегливо рекомендуємо вам користуватися у ваших скриптах збирання саме po4a.

Параметри для внесення змін до заголовка POT

--porefs тип

Вказує формат посилань. Аргумент тип може мати значення never, якщо не слід взагалі створювати посилань; file, якщо слід вказати файл без номерів рядків; counter, якщо слід замінити номер рядка значенням лічильника; і full, якщо посилання слід включити повністю (типове значення: full).

--wrap-po no|newlines|число (типове значення: 76)

Визначає спосіб перенесення рядків у файлі po. Так можна вибрати між файлами із добре перенесеними рядками, які можуть спричиняти конфлікти у git, та файлами, які простіше обробляються автоматично, але є важчими для читання.

Так історично склалося, що комплект програм gettext виконує переформатування файлів po так, щоб рядки було перенесено на 77-й позиції, з косметичних міркувань. За допомогою цього параметра можна встановити відповідну поведінку po4a. Якщо встановлено числове значення, po4a переноситиме рядки у файлі po після вказаної позиції і після символів розриву рядка у самих рядках. Якщо встановити значення newlines, po4a розриватиме рядки у msgid і msgstr лише після символів нового рядка у вмісті. Якщо встановити значення no, po4a не переноситиме рядки у файлі po взагалі. Перенесення рядків у коментарях виконується завжди інструментами gettext, які програма використовує на внутрішньому рівні.

Зауважте, що цей параметр не стосується того, яким чином переноситимуться рядки у msgid і msgstr, тобто того, у який спосіб до цих рядків додаватимуться символи розриву рядків.

--master-language

Мова файлів, які містять документ для перекладу. Зауважте, що усі основні документи мають належати до однієї мови.

--msgid-bugs-address адреса@електронної.пошти

Встановити адресу для звітування щодо помилок у msgid (початкових неперекладених рядках). Типово, у створених файлах POT не буде полів Report-Msgid-Bugs-To.

--copyright-holder рядок

Встановити запис авторських прав у заголовку POTr. Типовим значенням є «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 або новішу версію. Цей параметр типово задіяно.

Пошук файлів PO і POT

Найпростішим рішенням є явне визначення шляху до файлів POT та PO, ось так:

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

Тут ми спочатку вказуємо шлях до файла POT, а потім шляхи до файлів PO перекладів німецькою та французькою мовами.

Те саме можна записати для зменшення ризику помилок при копіюванні ось так:

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

Компонент $lang буде автоматично розгорнути на основі наданого списку мов. Це зменшить ризик помилки під час вставляння при додаванні нової мови перекладу.

Зробити той самий запис компактнішим можна надавши шлях до каталогу, у якому міститься проєкт з перекладу. Приклад наведено нижче.

 [po_directory] man/po/

У вказаному каталозі має міститися набір файлів PO, назви яких слід записувати у форматі XX.po, де "XX" — код мови перекладу за ISO 639-1. У каталозі також має зберігатися один файл POT із суфіксом назви ".pot". Для першого запуску цей файл може бути порожнім, але має існувати (po4a не може визначити назву, якою слід скористатися перед суфіксом).

Зауважте, що слід вибрати лише один з варіантів, "po_directory" або "po4a_paths". Перший ("po_directory") є компактнішим, зменшує ризик помилки під час копіювання, але примушує вас до використання очікуваної структури проєкту та назв файлів. Другий ("po4a_paths") є більш явним, ймовірно, зручнішим для читання, радимо користуватися ним, якщо ви налаштовуєте ваш перший проєкт у po4a.

Централізовані чи поділені файли PO?

Типово, po4a створює по одному файлу PO для кожної мови перекладу. У цих файлах міститиметься увесь ваш проєкт перекладу. Зі зростанням вашого проєкту розмір цих файлів може стати проблемою. При використанні weblate можна встановити для кожного з повідомлень перекладу (тобто msgid) пріоритетність, тому варто встановити її так, щоб важливі рядки було перекладено першими, але деякі команди перекладачів, попри це, можуть просити про поділ даних на декілька файлів.

Щоб створити один файл PO для кожного основного файла, вам слід просто скористатися рядком $master у назві ваших файлів PO у рядку "[po4a_paths]", як це показано нижче.

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

Якщо існуватимуть конфлікти назв, пов'язані із тим, що декілька з файлів матимуть однакові назви, назву основного файла можна вказати за допомогою параметра "master:file="назва:

 [po4a_langs] de fr ja
 [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 \
              de:doc/de/mein_kram.sgml
 [type: man] script fr:doc/fr/script.1 de:doc/de/script.1
 [type: docbook] doc/script.xml fr:doc/fr/script.xml \
             de:doc/de/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"

За будь-яких умов, ці фрагменти налаштувань має бути розташовано наприкінці рядка. Оголошення файлів мають бути першими, далі мають бути додатки, якщо такі є (див. нижче), а лише потім має бути вказано параметри. Групування фрагментів налаштувань не є дуже важливим, оскільки на внутрішньому рівні елементи буде поєднано як рядки. Наступні приклади є еквівалентними:

  [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".

Альтернативи налаштувань

Щоб передати ті самі параметри для декількох файлів, варто створити альтернативний тип у наведений нижче спосіб. У наступному прикладі, "--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]" задають типові значення, які може бути перевизначено у будь-якому іншому джерелі.
• Альтернативні типи, які використано. Специфічні для мов параметри перевизначають параметри, які застосовуються для усіх мов.
• Параметри, які є специфічними для вказаного основного файла, перевизначають як типові параметри, так і параметри, які походять із визначень альтернативних типів. У цьому випадку, так само, специфічні для мови параметри перевизначають загальні.
• Нарешті, параметри, які задаються командним рядком po4a мають вищий пріоритет за будь-які параметри з файла налаштувань.

Приклад

Ось приклад, який демонструє те, як екранувати пробіли і лапки:

 [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

Додаток: додавання даних до перекладу

Якщо вам потрібно додати додатковий розділ до вашого перекладу, наприклад, вказати у ньому подяки перекладачу, вам слід визначити додаток у рядку, який визначає ваш основний файл. Будь ласка, зверніться до сторінки підручника (man) 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" для забезпечення створення перекладених документів навіть для неповних перекладів.

ПРИКЛАД НАЛАШТУВАНЬ

ЗАВДАННЯ: Чи потрібен взагалі цей розділ?

Припустімо, ви є супровідником програми із назвою foo, сторінкою підручника якої є man/foo.1. Актуальний стан, звичайно ж, підтримується лише для англійського варіанта цієї сторінки. Тепер, ви, як супровідник основної версії або пакунків з програмою, хочете створити і супроводжувати переклад. По-перше, вам слід створити файл POT, який ви надішлете перекладачам, за допомогою po4a-gettextize(1).

Отже, у нашому прикладі слід віддати команду

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

Далі, цей файл слід надіслати до відповідних списків листування перекладачів або запропонувати отримувати його з якоїсь адреси на вашому сайті.

Далі, припустімо, що ви отримали три переклади перед наступним випуском програми: de.po (з додатком de.add), sv.po та pt.po. Оскільки ви не хочете вносити зміни до ваших файлів Makefile кожного разу, коли з'являється новий переклад, ви можете скористатися po4a з відповідним файлом налаштувань у вашому Makefile. Нехай файл налаштувань має назву 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"

У цьому прикладі ми припускали, що ваші створені сторінки підручника (і усі файли 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) супроводжується додатком.

Для збирання самих перекладених сторінок підручника вам слід (лише одного разу!) додати такий рядок до цілі build відповідного файла Makefile:

        po4a po4a.cfg

Щойно усе буде налаштовано, вам не доведеться знову редагувати Makefile, якщо з'явиться новий переклад, тобто, якщо, наприклад, перекладачі французькою надішлють вам fr.po і fr.add, ви просто запишете відповідні файли до man/po4a/po/ і man/po4a/add_fr/, і під час наступного збирання програми переклад французькою буде автоматично зібрано до man/translated/fr/.

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

Нарешті, якщо ви не зберігаєте створені файли у вашій системі керування версіями, вам потрібен буде рядок і у вашій цілі clean:
-rm -rf man/translated