PO4A(7)

НАЗВА
po4a — набір інструментів для перекладу документації та інших матеріалів

Вступ
po4a («PO for anything» або «PO для усього») спрощує супровід перекладу документації з використанням класичних інструментів gettext Основною перевагою po4a є відокремлення придатного до перекладу вмісту документа від його структури.

Це документ є вступом до документації з проєкту po4a. Акцент у ньому зроблено на відомостях для потенційних користувачів, які розглядають можливість використання цього інструмента і цікавляться тим, чому усе реалізовано саме таким чином.

Чому po4a?
Філософія вільного програмного забезпечення полягає у наданні доступу до технологій усім. Втім, ліцензування не є єдиною причиною: неперекладене вільне програмне забезпечення є недоступним для тих, хто не знає англійської. Для того, щоб зробити його цінним для усіх, слід докласти додаткових зусиль з перекладу.

Усе це добре розуміють у більшості проєктів — зараз усі вже переконані у тому, що перекладати слід усе. Втім, сам переклад є результатом величезних зусиль багатьох осіб, які ускладнюють невеличкі технічні труднощі.

На щастя, саме вільне програмне забезпечення має досить якісний інструментарій для перекладу, дякуючи чудовому набору інструментів gettext. У нас є інструменти для видобування рядків для перекладу з програми і представлення їх у стандартизованому форматі (який називають файлами PO або каталогами перекладу). З'явилася ціла екосистема інструментів, які допомагають перекладачам перекладати ці файли PO. Результат перекладу використовується gettext під час роботи програми для показу кінцевим користувачам перекладених повідомлень.

Якщо ж говорити про документацію, маємо дещо прикру картину. Спершу може здатися, що перекладати документацію простіше за саму програму, оскільки достатньо скопіювати файл документації і почати перекладати його вміст. Втім, якщо до початкового документа буде внесено зміни, стеження за ними може перетворитися на суцільний жах для перекладачів. Виконання цього завдання вручну є неприємною справою, у якій можна дуже просто помилитися.

Застарілі ж переклади часто є більшою проблемою, ніж неперекладена документація. Кінцевого користувача можна ввести в оману документацією, у якій описано поведінку застарілої версії програми. Крім того, користувачі перекладеної версії не можуть безпосередньо взаємодіяти із супровідниками, оскільки мають проблеми у спілкування англійською. До цього додається і те, що супровідник не може виправити проблему, оскільки не знає усі мови, якими перекладено документацію. Ці складнощі, часто викликані неналежним інструментарієм перекладу, можуть відлякати потенційних перекладачів, що робить ситуацію ще проблематичнішою.

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

Ідея полягає у повторному використанні і адаптації підходу gettext. Так само, як і з gettext для програм, текстові фрагменти видобуваються з початкових файлів і надаються перекладачам як каталоги перекладу PO. Перекладачі можуть скористатися класичними засобами gettext для стеження за виконанням завдань, співпраці та організації команд. Далі, po4a вставляє переклади безпосередньо до структури документації з метою створення перекладених початкових файлів, які можна обробляти і поширювати у той самий спосіб, у який обробляються і поширюються файли англійською. У документі-результаті усі неперекладені абзаци лишатимуться написаними англійською, отже кінцеві користувачі ніколи не побачать застарілих перекладів у документації.

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

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

  Підтримувані формати
У поточній версії цей підхід успішно реалізовано для декількох типів документів із текстовим форматуванням:

man (надійний обробник)
    Старий добрий формат сторінок підручника, який використовується у багатьох програмах. Підтримка у po4a тут дуже доречна, оскільки цей формат доволі складний у використанні і не дуже зручний для недосвідчених користувачів.

    У модулі Locale::Po4a::Man(3pm) також передбачена підтримка формату mdoc, який використовується у сторінках підручника BSD (їх також доволі часто використовують у Linux).

AsciiDoc (надійний обробник)
    Цей формат є спрощеним форматом розмітки, призначенням якого є спростити написання документації. Його, наприклад, використано для документування системи git. Такі сторінки підручників перекладено за допомогою po4a.

    Див. Locale::Po4a::AsciiDoc, щоб дізнатися більше.

pod (надійний обробник)
    Це формат інтернет-документації до Perl (Perl Online Documentation). За його допомогою документовано саму мову і її розширення, а також більшість із наявних скриптів Perl. Він спрощує синхронізацію документації із кодом, оскільки і документація, і код є частиною одного файла. Це спрощує завдання програміста, але, на жаль, не перекладача, доки ви не скористаєтеся po4a.

    Див. Locale::Po4a::Pod, щоб дізнатися більше.

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

    У поточній версії передбачено підтримку лише DebianDoc і DocBook DTD, але додавання підтримки нових форматі є дуже простим. po4a можна навіть використовувати для невідомих DTD SGML без зміни коду, якщо надати потрібну інформацію за допомогою командного рядка. Див. Locale::Po4a::Sgml(3pm), щоб дізнатися більше.

TeX / LaTeX (надійний обробник)
    Формат LaTeX є основним форматом документації, який використовується у світі вільного програмного забезпечення та для публікацій.

    Модуль Locale::Po4a::LaTeX(3pm) було перевірено на документації до Python, книзі і декількох презентаціях.

text (надійний обробник)
    Текстовий формат є базовим форматом для багатьох інших форматів, у яких ви маєте справу зі довгими блоками тексту, зокрема Markdown, fortune-и, розділ титульних елементів YAML, debian/changelog та debian/control.

    Цей формат є типовим для генераторів статичних сайтів, файлів README та інших систем документації. Див. Locale::Po4a::Text(3pm), щоб дізнатися більше.

xml і XHMTL (ймовірно, надійний обробник)
    Формат XML є базовим для багатьох форматів документації.

    У поточній версії po4a передбачено підтримку DocBook DTD (докладніше про це див. Locale::Po4a::Docbook(3pm)) та XHTML.

BibTex (ймовірно, надійний обробник)
    Формат BibTex використовують разом із LaTex для форматування списку посилань (бібліографій).

    Див. Locale::Po4a::BibTex, щоб дізнатися більше.

Docbook (ймовірно, надійний обробник)
    Заснована на XML мова розмітки, у якій використовують семантичні теґи для опису документів.

    Див. Locale::Po4a:Docbook, щоб дізнатися більше.

Guide XML (ймовірно, надійний обробник)
    Формат документації XML. Цей модуль розроблявся спеціально для того, щоб допомогти із підтримкою та супроводом перекладів документації Gentoo Linux, принаймні до березня 2016 року (дані засновано на даних Wayback Machine). З того часу Gentoo перейшла на формат XML DevBook.

    Див. Locale::Po4a:Guide, щоб дізнатися більше.

Wml (ймовірно, надійний обробник)
    Мова розмітки інтернету (Web Markup Language), не плутати з WML із WAP, яку використовують для стільникового зв'язку. Роботу цього модуля засновано на роботі модуля Xhtml, який сам є надбудовою над модулем XML.

    Див. Locale::Po4a::Wml, щоб дізнатися більше.

Yaml (ймовірно, надійний обробник)
    Строго обмежена надбудова над JSON. YAML часто використовують для проєктів систем або налаштувань. YAML є частиною ядра Ansible від Red Hat.

    Див. Locale::Po4a::Yaml, щоб дізнатися більше.

RubyDoc (ймовірно, надійний обробник)
    Формат документів Ruby (RD), розроблено як типовий формат документації до Ruby і проєктів на Ruby до переходу на RDoc у 2002 році. Втім, принаймні японська версія підручника-довідника з Ruby усе ще використовує RD.

    Див. Locale::Po4a::RubyDoc, щоб дізнатися більше.

Halibut (ймовірно, експериментальний обробник)
    Система створення документації із елементами, подібними до TeX, debiandoc-sgml, TeXinfo та інших систем. Розроблено Саймоном Тетгемом (Simon Tatham), розробником PuTTY.

    Див. Locale::Po4a:Halibut, щоб дізнатися більше.

Ini (ймовірно, експериментальний обробник)
    Формат файлів налаштувань, який став популярним завдяки MS-DOS.

    Див. Locale::Po4a::Ini, щоб дізнатися більше.

texinfo (дуже експериментальний обробник)
    У цьому форматі записано усю документацію GNU (наявність такої документації є навіть однією із вимог для отримання статусу офіційного проєкту GNU). Підтримка модуля Locale::Po4a::Texinfo(3pm) у po4a усе ще перебуває на початковому етапі. Будь ласка, повідомляйте про вади та ваші запити щодо реалізації функціональних можливостей.

gemtext (very highly experimental parser)
    The native plain text format of the Gemini protocol. The extension ".gmi" is commonly used. Support for this module in po4a is still in its infancy. If you find anything, please file a bug or feature request.

Інші підтримувані формати
    Крім того, po4a також може працювати із іншими рідкісними і спеціалізованими форматами, зокрема документацією до параметрів компіляції ядер Linux 2.4+ (Locale::Po4a::KernelHelp) та діаграмами, які створено за допомогою програми Dia (Locale::Po4a:Dia). Додати новий формат часто доволі просто. Основним у цьому є є створення обробника початкового формату. Докладніший опис цього можна знайти у розділі Locale::Po4a::TransTractor(3pm).

Непідтримувані формати
    На жаль, у po4a досі не реалізовано підтримку декількох форматів документації. Підтримку багатьох з них могло б бути доволі просто реалізовано у po4a. Це стосується і форматів, які не є форматами документації, зокрема описів пакунків (deb і rpm), питань у скриптах встановлення пакунків, журналів змін пакунків та усіх спеціалізованих форматів файлів, які використовуються програмами, зокрема сценаріїв ігор та файлів ресурсів wine.

Користування po4a
Найпростішим способом використання цього інструмента у вашому проєкті є написання файла налаштувань для програми po4a із наступною роботою лише із цією програмою. Будь ласка, зверніться до документації у підручнику з po4a(1). Решту цього розділу присвячено подробицям для досвідчених користувачів po4a, які хочуть дізнатися більше про роботу програми.

  Докладна схема робочого процесу po4a
Спочатку ознайомтеся із підручником з po4a(1), щоб дізнатися про базові принципи роботи po4a. Повертайтеся до цього докладного опису, якщо хочете дізнатися про майже усі подробиці.

На наведеній нижче схемі основний.документ — приклад назви документації, яку слід перекласти; XX.документ — відповідний перекладений документ мовою XX, а doc.XX.po — каталог перекладу для цього документа мовою XX. Автори документації, здебільшого мають перейматися файлом основний.документ (це може бути сторінка підручника (man), документ XML, файл AsciiDoc або подібний документ); перекладачі, здебільшого, працюють із файлом PO, а кінцеві користувачі бачать лише файл XX.документ.

Переходи із квадратними дужками, зокрема "[po4a оновлює po]", означають виконання програми po4a, а переходи із фігурними дужками, зокрема "{оновлення основний.документ}", означають внесення до файлів проєкту змін вручну.

                                   основний.документ
                                       |
                                       V
     +<-----<----+<-----<-----<--------+------->-------->-------+
     :           |                     |                        :
{переклад}       |     {оновлення основний.документ}          :
     :           |                     |                        :
 XX.документ     |                     V                        V
(необов'язковий) |              основний.документ ->------>---->+
     :           |                 (новий)                      |
     V           V                     |                        |
  [po4a-gettextize] документ.XX.po>+   |                        |
          |          (старий)      |   |                        |
          |              ^         V   V                        |
          |              |     [po4a оновлює po]                  |
          V              |           |                          V
     переклад.pot        ^           V                          |
          |              |      документ.XX.po                  |
          |              |       (неточний)                     |
     {переклад}        |           |                          |
          |              ^           V                          V
          |              |    {редагування вручну}              |
          |              |           |                          |
          V              |           V                          V
 документ.XX.po --->---->+<---<-документ.XX.po додаток  основний.документ
    (початковий)               (актуальний) (необов'язковий)(актуальний)
          :                          |            |             |
          :                          V            |             |
          +----->----->----->------> +            |             |
                                     |            |             |
                                     V            V             V
                                     +------>-----+------<------+
                                                  |
                                                  V
                                           [po4a оновлює переклади]
                                                  |
                                                  V
                                             XX.документ
                                             (актуальний)

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

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

У верхній частині праворуч зображено роботу автора початкового тексту (оновлення документації). У середній частині праворуч зображено послідовність автоматичних оновлень файлів перекладу. Новий тестовий матеріал видобувається з документа і порівнюється із наявним перекладом. Виявляються частини, які не змінилися, — для них використовується наявний переклад. Частини, які зазнали часткових змін також пов'язуються із попереднім перекладом, але із особливою позначкою, яка вказує на те, що переклад має бути оновлено. Новий або значно змінений матеріал лишається неперекладеним.

Далі, пункт редагування вручну показує роботу перекладачів, які вносять зміни до файлів PO, перекладаючи усі початкові рядки або абзаци. Переклад можна здійснювати або за допомогою спеціалізованого редактора, зокрема Редактора перекладів GNOME або Lokalize з KDE або poedit, чи інтегрувати до платформи інтернет-перекладу, зокрема weblate або pootle. Результатом перекладу є набір файлів PO, по одному на кожну мову перекладу. Докладніший опис можна знайти у документації до gettext.

У нижній частині схеми показано, як po4a створює перекладений початкових документ на основі документа основний.документ та каталогу перекладу документ.XX.po, який було оновлено перекладачами. Програма використовує структуру початкового документа, але замінює початковий вміст на перекладені блоки. Якщо потрібно, може бути використано додаток для вставляння певного додаткового тексту до перекладу. Такі додатки часто використовуються для додавання імені перекладача до остаточного документа. Подробиці наведено нижче.

Після виклику po4a оновлює файли перекладу та файли перекладеної документації автоматично.

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

Якщо у вас вже є переклади, тобто файли документації, які було перекладено вручну, ви можете інтегрувати ці дані до вашого робочого процесу po4a за допомогою po4a-gettextize. Це дещо марудне заняття (як його описано на сторінці підручника програми), але після перетворення вашого проєкту до робочого процесу po4a усі дані оновлюватимуться автоматично.

  Оновлення перекладів і документів
Після встановлення достатньо викликати po4a, щоб оновити як файл PO перекладу, так і перекладені документи. Ви можете передати "--no-translations" до po4a, щоб не оновлювати переклади (таким чином оновлюючи лише файли PO) або "--no-update", щоб не оновлювати файли PO (таким чином оновлюючи лише переклади). Це приблизно відповідає окремим скриптам po4a-updatepo і po4a-translate, які зараз не рекомендуються (див. «Чому окремі скрипти застаріли» у розділі поширених питань нижче).

  Використання додатків для вставляння додаткового тексту до перекладів
Додавання нового тексту до перекладу є, ймовірно, єдиною дією, яку простіше виконувати, якщо ви перекладаєте файли вручну :). Додавання може знадобитися, якщо вам потрібно додати до перекладеного документа додатковий розділ, який не відповідає жодного з розділів у початковому документі. Класичним випадком є додавання подяк команді перекладачів та вставляння нотатки щодо того, як повідомляти про вади, які пов'язано із перекладом.

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

Рядок заголовка має розпочинатися з рядка PO4A-HEADER:, за яким має бути вказано список відокремлених крапкою з комою полів ключ=значення.

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

 PO4A-HEADER: mode=eof

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

 PO4A-HEADER: position=Про цей документ; mode=after; endboundary=</section>

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

 PO4A-HEADER: position=À propos de ce document; mode=after; endboundary=</section>

Щойно аргумент ключа "position" буде знайдено у документі призначення, po4a виконає пошук наступного рядка після "position", який відповідає аргументу, заданому "endboundary". Додаток буде додано одразу після цього рядка (оскільки нами надано endboundary — межу поточного розділу).

Точно такого самого ефекту можна досягти із наведеним нижче заголовком, який є еквівалентним до вже використаного:

 PO4A-HEADER: position=Про цей документ; mode=after; beginboundary=<section>

Тут po4a шукає перший рядок, який відповідає "<section>" після рядка "Про цей документ" у перекладі, і вставляє додаток до цього рядка, оскільки вказано beginboundary, тобто початкову межу наступного розділу. Отже, цей рядок заголовка вимагає від програми вставити додаток після розділу, що містить рядок "Про цей документ", і вказує po4a, що розділ починається з рядка, що містить теґ "<section>". Це еквівалентно до попереднього прикладу, оскільки насправді нам потрібно вставити цей додаток або після "</section>", або перед "<section>".

Ви також можете встановити режим вставляння у значення "before", використовуючи подібну семантику "mode=before" з "endboundary" призведе до вставляння додатка одразу після відповідної межі, який є останнім потенційним обмежувальним рядком перед "position". Поєднання "mode=before" із "beginboundary" призведе до вставляння додатка одразу перед відповідною межею, яка є останнім потенційним обмежувальним рядком перед "position".

  Режим  |    Тип межі   |     Використана межа     | Точка вставляння відносно межі
 ========|===============|==========================|=======================================
 'before'| 'endboundary' | остання перед 'position' | Одразу після вибраної межі
 'before'|'beginboundary'| остання перед 'position' | Одразу перед вибраною межею
 'after' | 'endboundary' | перша після 'position'   | Одразу після вибраної межі
 'after' |'beginboundary'| перша після 'position'   | Одразу перед вибраною межею
 'eof'   |   (немає)     |  н/д                   | Кінець файла

Підказки і настанови щодо додатків

•   Пам'ятайте, що ці рядки є формальними виразами. Наприклад, якщо ви хочете знайти кінець розділу nroff, що завершується рядком ".fi", не використовуйте ".fi" у полі endboundary, оскільки вказаний рядок є формальним виразом, за яким може бути знайдено, наприклад, рядок "the[ fi]le", що, звичайно ж, є небажаним. Правильним значенням для endboundary у цьому випадку буде таке: "^\.fi$".

•   Пробіли є важливими у сенсі "position" і меж. Отже, два наступних рядки є різними. Другий рядок буде знайдено, лише якщо у перекладеному документі достатньо кінцевих пробілів.

     PO4A-HEADER: position=Про цей документ; mode=after; beginboundary=<section>
     PO4A-HEADER: position=Про цей документ ; mode=after; beginboundary=<section>

•   Хоча цей контекстний пошук можна розглядати як такий, що працює має із усіма рядками перекладеного документа, насправді, він працює з внутрішніми даними рядка перекладеного документа. Цей внутрішній рядок даних може бути фрагментом тексту абзацу із декількох рядків або може бути лише теґом XML. Точна точка вставлення додатка має знаходитися до або після внутрішнього рядка даних і не може перебувати всередині внутрішнього рядка даних.

•   Щоб зрозуміти, як програма вставляє додаток у переклад, передайте po4a аргумент "-vv". Також може бути корисним запуск po4a у режимі діагностики, щоб переглянути справжні внутрішні дані, якщо програма відмовляється вставляти ваш додаток.

Приклади додатків

•   Якщо ви хочете додати щось після такого розділу nroff:

      .SH "AUTHORS"

    Вам слід вибрати двокроковий підхід встановленням значення mode=after. Далі, вам слід звузити пошук до рядка після AUTHORS за допомогою параметра формального виразу position. Далі, вам потрібно встановити відповідність початку нового розділу (тобто, ^\.SH) за допомогою параметра формального виразу beginboundary. Тобто, слід зробити так:

     PO4A-HEADER:mode=after;position=AUTHORS;beginboundary=\.SH

•   Якщо ви хочете додати щось одразу після заданого рядка (наприклад, після «Copyright Big Dude»), вкажіть для position критерій пошуку відповідного рядка, mode=after, а для beginboundary вкажіть відповідник будь-якого рядка.

     PO4A-HEADER:mode=after;position=Copyright Big Dude, 2004;beginboundary=^

•   Якщо ви хочете щось додати наприкінці документа, вкажіть для position відповідник будь-якого рядка вашого документа (але лише одного, бо po4a відмовиться виконувати дію, якщо буде знайдено декілька таких рядків), а для endboundary вкажіть рядок, якого немає у документі. Не використовуйте для цього рядка надто прості варіанти, наприклад "EOF", — вкажіть щось, що має набагато менші шанси бути знайденим у документі.

     PO4A-HEADER:mode=after;position=Про цей документ;beginboundary=FakePo4aBoundary

Докладніший приклад

Початковий документ (у форматуванні POD):

 |=head1 NAME
 |
 |dummy - a dummy program
 |
 |=head1 AUTHOR
 |
 |me

Далі, наведений нижче додаток забезпечить додавання розділу (українською) щодо перекладачів наприкінці файла.

 |PO4A-HEADER:mode=after;position=АВТОР;beginboundary=^=head
 |
 |=head1 ПЕРЕКЛАДАЧ
 |
 |я
 |

Щоб розташувати ваш додаток перед записом АВТОР, скористайтеся таким заголовком:

 PO4A-HEADER:mode=after;position=ІМ'Я;beginboundary=^=head1

Це працює, оскільки наступний рядок відповідника beginboundary "/^=head1/" після розділу «NAME» (перекладеного як «ІМ'Я» українською) є розділ зі списком авторів. Отже, додаток буде розташовано між вказаними розділами. Зауважте, що якщо між розділами NAME і AUTHOR згодом буде додано ще якийсь розділ, po4a помилково додасть додаток перед новим розділом.

Щоб уникнути цього, ви можете досягти результату у інший спосіб за допомогою mode=before:

 PO4A-HEADER:mode=before;position=^=head1 АВТОР

Як усе це працює?
У цій главі наведено короткий огляд нутрощів po4a, який надасть вам впевненості, якщо ви захочете допомогти нам із супроводом та розвитком комплекту програм. Цей огляд також може допомогти вам зрозуміти, чому програма працює не так, як ви того сподівалися, та як усунути вашу проблему.

  TransTractor-и та архітектура проєкту
В основі проєкту po4a клас Locale::Po4a::TransTractor(3pm) є спільним предком для усіх обробників po4a. Ця дивна назва походить від того факту, що він водночас відповідає за переклад документа (translator) та видобування рядків (extractor).

Формально, він отримує документ для перекладу і файл PO з перекладами на вході і створює два потоки виведених даних: ще один файл PO (який є результатом видобування придатних до перекладу рядків із вхідного документа) та перекладений документ (тієї самої структури, що і вхідний, але із заміною усіх придатних до перекладу рядків на вміст вхідного файла PO). Ось графічне представлення обробки:

   Вхідний документ --\                             /---> Вихідний документ
                     \      TransTractor::       /       (перекладений)
                      +-->--   parse()  --------+
                     /                           \
 Вхідний PO --------/                             \---> Вихідний PO
                                                         (видобутий)

Ця маленька часточка коду є ядром усієї архітектури po4a. Якщо ви надаєте вхідні дані та ігноруєте вихідний PO, ви отримуєте po4a-translate. Якщо натомість проігнорувати вихідний документ, ви отримаєте po4a-updatepo. po4a використовує перший TransTractor, щоб отримати оновлений вихідний файл POT (без урахування вихідних документів), викликає msgmerge -U, щоб оновити файли PO перекладу на диску, і будує другий TransTractor з цими оновленими файлами PO для оновлення вихідних документів. Коротше кажучи, po4a забезпечує універсальне рішення для оновлення того, що потрібно, за допомогою єдиного файла налаштувань.

po4a-gettextize також використовує два TransTractor-и, але у інший спосіб: вона створює один TransTractor для кожної мови, а потім створює новий файл PO, використовуючи msgid початкового документа як msgid, і msgid перекладеного документа як msgstr. Слід бути дуже уважним і переконатися, що рядки, зіставлені таким чином, дійсно збігаються, як описано у po4a-gettextize(1).

  Специфічні обробники форматів
Усі обробники форматів po4a реалізовано на основі TransTractor. Деякі з них дуже прості, наприклад Text, Markdown і AsciiDoc. Вони завантажують рядки один за одним за допомогою "TransTractor::shiftline()", накопичують дані абзаців або щось інше. Після повного аналізу рядка аналізатор використовує "TransTractor::translate()", щоб (1) додати цей рядок до вихідного файла PO та (2) отримати переклад із вхідного файла PO. Потім аналізатор надсилає результат у вихідний файл за допомогою "TransTractor::pushline()".

Деякі інші аналізатори є більш складними, оскільки вони покладаються на зовнішній аналізатор для аналізу вхідного документа. Обробники Xml, HTML, SGML і Pod побудовані на основі обробників SAX. Вони оголошують зворотні виклики до таких подій, як «Я знайшов новий заголовок із таким вмістом», щоб оновити вихідний документ і вихідні файли POT відповідно до вхідних даних за допомогою "TransTractor::translate()" і "TransTractor::pushline ()". Синтаксичний аналізатор Yaml подібний, але відрізняється: він серіалізує структуру даних, створену обробником YAML::Tiny. Ось чому модуль Yaml po4a не може оголосити еталонні рядки: розташування кожного рядка у вхідному файлі не зберігається аналізатором, тому ми можемо надати лише "$назва_файла:1" як розташування рядка. SAX-орієнтовані обробники використовують змінні загального рівня та інші трюки, щоб зберегти назву файла та номери рядків посилань.

Одна конкретна проблема виникає через кодування файлів і позначки порядку байтів. Прості обробники можуть пропустити цю проблему, яку вирішує "TransTractor::read()" (використовується всередині для отримання рядків вхідного документа), але модулі, які покладаються на зовнішній аналізатор, повинні гарантувати, що всі файли читаються за допомогою відповідного шару декодування PerlIO. Найпростіший — відкрити файл самостійно та надати дескриптор файла або безпосередньо повний рядок зовнішньому обробнику. Наприклад, перевірте "Pod::read()" і "Pod::parse()". Дані, прочитані TransTractor, буде проігноровано, але новий дескриптор файла буде передано зовнішньому аналізатору. Важливою частиною є режим "<:encoding($charset)", який буде передано до функції perl open().

  Об'єкти PO
Клас Locale::Po4a::Po(3pm) відповідає за завантаження та використання файлів PO і POT. Загалом, ви можете прочитати файл, додати записи, отримати переклади за допомогою методу gettext(), записати PO до файла. Додаткові функціональні можливості, такі як об’єднання файла PO з файлом POT або перевірка файла, передано до msgmerge і msgfmt відповідно.

  Участь у розробці po4a
Навіть якщо ви ніколи раніше не брали участі в жодному проєкті з відкритим кодом, ласкаво просимо: ми готові допомогти та наставити вас тут. Найкращий супровід po4a можуть надати лише його користувачі. Оскільки нам не вистачає розробників, ми намагаємося зробити проєкт якомога гостиннішим, покращуючи документацію та автоматичні тести, щоб ви були впевнені у своєму внеску до проєкту. Для отримання додаткової інформації зверніться до файла CONTRIBUTING.md.

Проєкти із відкритим кодом, у яких використовується po4a
Це лише частина списку проєктів, у яких використовується po4a для роботи з документацією. Якщо хочете додати ваш проєкт до списку, просто надішліть ваше прохання електронною поштою (або створіть запит щодо об'єднання у сховищі з кодом).

•   adduser (man): інструмент для керування записами користувачів і груп.

•   apt (man, docbook): програма для керування пакунками Debian.

•   aptitude (docbook, svg): програма для керування пакунками у терміналі Debian

•   Сайт F-Droid <https://gitlab.com/fdroid/fdroid-website> (markdown): каталог вільних програм з відкритим кодом для платформи Android.

•   git <https://github.com/jnavila/git-manpages-l10n> (asciidoc): розподілена система керування версіями для стеження за змінами у початковому коді програм і документації.

•   Сторінки підручника Linux <https://salsa.debian.org/manpages-l10n-team/manpages-l10n> (man)

    Цей проєкт надає інфраструктуру для перекладу багатьох сторінок підручника різними мовами. Результати інтегруються до декількох основних дистрибутивів (Arch Linux, Debian і похідні, Fedora).

•   Stellarium <https://github.com/Stellarium/stellarium> (HTML): вільний планетарій з відкритим кодом для вашого комп'ютера. po4a використовується для перекладу описів картин зоряного неба.

•   Jamulus <https://jamulus.io/> (markdown, yaml, HTML): вільний проєкт з відкритим кодом для створення інтернет-джемів у режимі реального часу. Супровід документації на сайті виконується декількома мовами за допомогою po4a.

•   Інші пункти для упорядковування: <https://gitlab.com/fdroid/fdroid-website/> <https://github.com/fsfe/reuse-docs/pull/61>

Поширені питання

  Як вимовляти po4a?
Особисто автор вимовляє це як pouah <https://en.wiktionary.org/wiki/pouah>, — французький аналог нашого «пхе!» :) Можливо, в автора дивне почуття гумору :)

  Чому окремі скрипти вважаються застарілими?
Справді, po4a-updatepo і po4a-translate застаріли, і перевагу слід надавати po4a. Причина полягає в тому, що хоча po4a можна використовувати як додаткову заміну для цих скриптів, маємо досить багато дубльованого коду. Окремі скрипти містять приблизно 150 рядків коду, тоді як програма po4a складається з 1200 рядків, тому ці рядки виконують додаткові завдання щодо загальних вбудованих функцій. Дублювання коду призводить до помилок, що виникають в обох версіях і потребують двох виправлень. Одним із прикладів такого дублювання є помилка №1022216 у Debian і проблема №442 у GitHub, які мали те саме виправлення, але одне у po4a, а інше — po4a-updatepo.

Зрештою, автор хотів би відмовитися від окремих скриптів і підтримувати лише одну версію цього коду. Звичайно, окремі сценарії більше не покращуватимуться, тому лише po4a отримає нові можливості. Зважаючи на це, вилучення скриптів не є нагальною потребою. Я планую зберігати окремі скрипти якомога довше і принаймні до 2030 року. Якщо ваш проєкт все ще використовуватиме po4a-updatepo та po4a-translate у 2030 році, у вас можуть виникнути проблеми.

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

  Як щодо інших засобів перекладу документації, де використовується gettext?
Їх декілька. Нижче наведено неповний список. Існують плани щодо впровадження у декількох інших програмах.

poxml
    Це програма, яку розроблено KDE для роботи із XML DocBook. Наскільки мені відомо, це була перша програма, яка видобувала рядки для перекладу з документації до файлів PO і вставляла ці рядки назад після перекладу.

    Ця програма може працювати лише із форматом XML і лише з певним DTD. Мені не дуже подобається робота зі списками у ній, оскільки використання списків за певних умов призводить до створення величезних msgid. Якщо список дуже великий, перекладати його стає дуже складно.

po-debiandoc
    Цю програму створено Денісом Барбьє (Denis Barbier) як певним чином попередницю модуля SGML po4a, який більшою чи меншою мірою зробив цю програму застарілою. Як можна зрозуміти з назви, програма здатна працювати лише з DTD DebianDoc, який є більшою чи меншою мірою застарілим DTD.

xml2po.py
    Використовують у команді з документування GIMP з 2004 року. Працює доволі добре, незважаючи на те, що, як зрозуміло з назви, працює лише з файлами XML і потребує спеціально налаштованиих файлів make.

Sphinx
    У проєкті з документування Sphinx також широко використовують gettext для керування перекладами. На жаль, це працює лише для декількох текстових форматів, rest та markdown, хоча, можливо, це єдиний інструмент, який може керувати усім процесом перекладу.

Основною перевагою po4a над цими програмами є простора додавання додаткових даних (що важко або неможливо зробити у цих програмах) та можливість перетворення даних до стандартного формату gettext.

  РЕЗЮМЕ щодо переваг заснованого на gettext підходу

•   Переклади не зберігаються разом із оригіналами, що робить можливим виявлення перекладів, які застаріли.

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

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

•   Для кінцевого користувача нічого не міняється (окрім факту кращого супроводу перекладів). Остаточний файл документації розповсюджується у звичний спосіб.

•   Перекладачам не потрібно вивчати новий синтаксис файлів, а їхня улюблена програма для перекладу (наприклад, режим PO у Emacs, Lokalize чи Gtranslator) легко може бути використана для перекладу.

•   У gettext передбачено прості способи отримання статистичних даних щодо виконаної роботи, потрібного рецензування та оновлення, а також обсягу роботи, яку ще треба виконати. Приклади можна знайти за цими адресами:

     - https://docs.kde.org/stable5/uk/kdesdk/lokalize/project-view.html
     - http://www.debian.org/intl/l10n/

Втім, не усе так безхмарно. У цього підходу також є недоліки, з якими доводиться мати справу.

•   Додатки… вони на перший погляд доволі дивні.

•   Ви не можете адаптувати перекладений текст згідно до власних уподобань, зокрема поділити абзац на два або з'єднати два абзаци. Втім, у певному сенсі, потреба у таких змінах означає ваду у початковому тексті, — про неї усе одно довелося б повідомити авторові тексту.

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

    Однією з моїх мрій є інтеграція po4a до Gtranslator або Lokalize. При відкритті файла документації програма автоматично б видобувала рядки для перекладу, а перекладений файл і файл po записувала б на диск. Якщо б нам вдалося створити модуль MS Word™ (принаймні модуль для RTF), такою комбінацією модуля з програмами для перекладу могли б користуватися навіть професійні перекладачі.

ТАКОЖ ПЕРЕГЛЯНЬТЕ

•   Документація до універсального інструмента, яким вам слід користуватися: po4a(1).

•   Документація до окремих скриптів po4a: po4a-gettextize(1), po4a-updatepo(1), po4a-translate(1), po4a-normalize(1).

•   Додаткові допоміжні скрипти: msguntypot(1), po4a-display-man(1), po4a-display-pod(1).

•   Обробники для усіх форматів, зокрема для перегляду параметрів, які приймає кожен з них: Locale::Po4a::AsciiDoc(3pm) Locale::Po4a::Dia(3pm), Locale::Po4a::Guide(3pm), Locale::Po4a::Ini(3pm), Locale::Po4a::KernelHelp(3pm), Locale::Po4a::Man(3pm), Locale::Po4a::RubyDoc(3pm), Locale::Po4a::Texinfo(3pm), Locale::Po4a::Text(3pm), Locale::Po4a::Xhtml(3pm), Locale::Po4a::Yaml(3pm), Locale::Po4a::BibTeX(3pm), Locale::Po4a::Docbook(3pm), Locale::Po4a::Halibut(3pm), Locale::Po4a::LaTeX(3pm), Locale::Po4a::Pod(3pm), Locale::Po4a::Sgml(3pm), Locale::Po4a::TeX(3pm), Locale::Po4a::Wml(3pm), Locale::Po4a::Xml(3pm).

•   Реалізація базової інфраструктури: Locale::Po4a::TransTractor(3pm) (частково важливо розуміти організацію коду), Locale::Po4a::Chooser(3pm), Locale::Po4a::Po(3pm), Locale::Po4a::Common(3pm). Будь ласка, ознайомтеся також із файлом CONTRIBUTING.md у дереві початкового коду.

АВТОРИ
 Denis Barbier <barbier,linuxfr.org>
 Martin Quinson (mquinson#debian.org)