Scroll to navigation

PO4A-BUILD.CONF(5) Інструменти Po4a PO4A-BUILD.CONF(5)

НАЗВА

po4a-build.conf — файл налаштувань для збирання перекладених даних

Вступ

po4a-build.conf описує, у який спосіб "po4a-build" має збирати перекладену і неперекладену документацію на основі набору неперекладених початкових документів та відповідних файлів PO.

Усі підтримувані формати, у всіх їхніх підтримуваних комбінаціях можна вказати у одному файлі налаштувань po4a-build.conf і у єдиному виклику "po4a-build". Втім, ви можете також відділити каталоги po/ і створити по одному файлу налаштувань на кожен запуск. (Для кожного з файлів доведеться запускати "po4a-build -f ФАЙЛ".)

Зауважте, що хоча до po4a-build включено підтримку додавання підтримки gettext для перекладу виведених скриптом повідомлень, сам файл po4a-build.conf не стосується таких перекладів. po4a-build.conf пов'язано лише з перекладом статичних даних, зокрема сторінок підручника (man).

Щоб дізнатися більше про підтримку у po4a-build перекладу динамічних повідомлень, див. po4a-runtime(7).

Підтримувані формати

У поточній версії "po4a-build" передбачено підтримку таких комбінацій:

Типово використовується для сторінок підручника для скриптів командної оболонки або інших інтерпретаторів, які не мають власного формату документації, подібного до POD. Відповідні XML може бути створено безпосередньо на основі наявної сторінки підручника за допомогою "doclifter"(1), а "po4a-build" без проблем створить на їхній основі файл POT. Файл POT потім можна буде запропонувати перекладачам, а файли PO додати до відповідного каталогу po/. Далі, "po4a-build" не лише приготує неперекладену сторінку підручника на основі XML "doclifter", але і скористається "po4a" для приготування перекладених XML на основі файлів PO, а потім збере перекладені сторінки підручника на основі XML.

Сторінки підручника буде створено за допомогою типової підтримки у docbook-xsl — використану таблицю стилів можна перевизначити за допомогою параметра "XSLFILE" у файлі налаштувань "po4a-build".

Типову таблицю стилів, використану для приготування остаточного HTML можна перевизначити за допомогою параметра "HTMLXSL" у файлі налаштувань "po4a-build".
Для усіх підтримуваних розділів для перетворення даних POD використовується pod2man.

Користуйтеся "PODFILE" для розділу 1, "PODMODULES" для розділу 3, "POD5FILES" для розділу 5 і "POD7FILES" для розділу 7.

Для даних у розділах 5 або 7 (для яких, зазвичай, потрібна назва файла, яка також використовується для даних розділу 1), якщо назва файла містить як частину 5 або 7, цю частину (і будь-який суфікс назви файла) буде автоматично відкинуто.

Наприклад, для приготування /usr/share/man/man7/po4a.7.gz:

 # Файли POD для розділу 7
 POD7FILES="doc/po4a.7.pod"

Вміст файла

Порядок значень налаштувань у файлі налаштування може бути довільним.

Усе у рядку після символу «#» буде проігноровано.

Усі значення, які завжди є порожніми можна безпечно викинути з файла.

Деякі поля налаштувань є обов'язковими — po4a-build не зможе нічого зробити, якщо обов'язкові поля залишаться порожніми.

Обов’язковий.

Назва і розташування (тимчасового) файла налаштувань "po4a", який створить і супроводжуватиме "po4a-build". Цей файл не обов'язково має зберігатися у вашій системі керування версіями — його можна спокійнісінько вилучити після збирання пакунка.

 # назва і розташування файла налаштувань
 CONFIG="_build/po4a.config"
Обов’язковий.

Каталог, у якому містяться файли PO для УСІХ перекладів, які обробляються цим файлом налаштувань. Усі рядки буде об'єднано у один файл POT у цьому каталозі, а усі файли PO буде синхронізовано з файлом POT. Порогове значення KEEP (див. нижче) буде застосовано до усіх рядків із усіх вхідних файлів, вказаних у файлі налаштувань, та усіх файлів PO у цьому каталозі. Каталог не обов'язково має називатися «po». Втім, будь ласка, зауважте, що деякі статичні інструменти вимагають називати цей каталог «po», тому рекомендовано зберігати саме таку назву.

 # каталог po для сторінок підручника або документації
 PODIR="po/pod"
Обов’язковий.

Шлях до файла POT (відносно розташування цього файла налаштувань), який буде створено, оброблено і оновлено за допомогою "po4a-build" для цих перекладів.

 # шлях до файла POT
 POTFILE="po/pod/po4a-pod.pot"
Обов’язковий.

Базовий каталог для запису перекладених даних.

 # базовий каталог для створених файлів, наприклад файлів документації
 BASEDIR="_build"
Обов’язковий.

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

Сам рядок є довільним, але типово складається з назви пакунка. Створені програмою файли згодом буде записано до підкаталогів BASEDIR/BINARIES:

 _build/po4a/man/man1/foo.1

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

Рядки слід відокремлювати пробілами.

 # двійкові пакунки, які міститимуть створені сторінки підручника
 BINARIES="po4a"
Значення, яке слід передати безпосередньо "po4a -k" з метою визначення порогового значення правильно перекладених даних потрібного для того, щоб переклад не було відкинуто під час збирання. Не вказуйте або вилучіть, щоб скористатися типовим значенням (80%), або вкажіть нульове значення, щоб включити усі дані, навіть якщо у них не перекладено жодного рядка.

Для точнішого керування поведінкою програми слід уважно стежити за тим, які файли пов'язано із конкретним файлом налаштувань po4a-build.conf.

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

 # мінімальне порогове значення для створення кінцевого файла перекладу
 KEEP=
Файли XML DocBook для створення сторінок підручника у розділі 1. Назви файлів слід відокремлювати пробілом. Усі файли мають зберігатися у каталозі XMLDIR.

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

 # файли XML DocBook для розділу 1
 XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"
Файли XML DocBook для створення сторінок підручника у розділі 3. Назви файлів слід відокремлювати пробілом. Усі файли мають зберігатися у каталозі XMLDIR.

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

 # XML DocBook для розділу 3
 XMLMAN3=""
Розташування усіх файлів XML DocBook. У поточній версії "po4a-build" має знаходити усі файли зі списків XMLMAN1 та XMLMAN3, виконуючи пошук файлів *.xml у цьому каталозі.

Має бути вказано, якщо використано XMLMAN1 або XMLMAN3. Шляхи визначаються відносно розташування файла налаштувань.

 # розташування файлів XML
 XMLDIR="share/doc/"
Визначає, які пакунки зі списку у BINARIES використовують дані XML.

Якщо для XMLMAN1 або XMLMAN3 вказано якісь значення, цей параметр також повинен мати якесь значення.

 # двійкові пакунки, які використовують XML DocBook та xsltproc
 XMLPACKAGES="po4a"
Подібний до XMLDIR, але використовується лише для приготування перекладених файлів DocBook. Якщо у вашому пакунку використовуються файли .sgml, будь ласка, обговоріть їхнє збирання у списку листування po4a-devel. 

 # взірець для пошуку файлів .docbook
 DOCBOOKDIR=""
Таблиця стилів XSL, яка використовується для приготування перекладених і неперекладених даних з файлів XML DocBook. 

 # файл XSL, яким слід скористатися для XML DocBook
 XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
Файли POD для створення вмісту сторінки підручника з розділу 1. Записи файлів POD слід відокремлювати пробілом. Шляхи, якщо це потрібно, слід вказувати відносно розташування вказаного файла налаштувань. 

 # файли POD для розділу 1
 PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"
Спеціалізована підтримка для модулів Perl, які містять дані POD — назву модуля буде відтворено за шляхом (так, щоб зберегти типове компонування модулів Perl), а сторінки підручника буде автоматично розміщено у розділі 3. 

 # файли POD для розділу 3 — назви модулів буде визначено за шляхом
 PODMODULES="lib/Locale/Po4a/*.pm"
Довільні дані POD для створення вмісту сторінки підручника з розділу 5. Шляхи, якщо це потрібно, слід вказувати відносно розташування вказаного файла налаштувань.

Для даних у розділах 5 або 7 (для яких, зазвичай, потрібна назва файла, яка також використовується для даних розділу 1), якщо назва файла містить як частину 5 або 7, цю частину (і будь-який суфікс назви файла) буде автоматично відкинуто.

 # файли POD для розділу 5
 POD5FILES="doc/po4a-build.conf.5.pod"
Довільні дані POD для створення вмісту сторінки підручника з розділу 7. Шляхи, якщо це потрібно, слід вказувати відносно розташування вказаного файла налаштувань.

Для даних у розділах 5 або 7 (для яких, зазвичай, потрібна назва файла, яка також використовується для даних розділу 1), якщо назва файла містить як частину 5 або 7, цю частину (і будь-який суфікс назви файла) буде автоматично відкинуто.

 # Файли POD для розділу 7
 POD7FILES="doc/po4a.7.pod"
Подібний до XMLPACKAGES — будь-який пакунок, у якому дані може бути зібрано з файлів POD, має бути включено до значення PODPACKAGES. Обов'язковий параметр, якщо вказано значення для PODFILE, PODMODULES, POD5FILES або POD7FILES. 

 # двійкові пакунки, які використовують POD
 PODPACKAGES="po4a"
Підкаталог BASEDIR, який буде використано для виведення неперекладених і перекладених даних HTML. 

 # виведення HTML (підкаталог BASEDIR)
 HTMLDIR=""
Файл DocBook, який буде перетворено на HTML (можливо, один із файлів з XMLMAN1 або XMLMAN3). Розділи не пов'язано із виведенням до HTML, отже, можна довільно використовувати будь-який окремий файл книги, щоб у HTML була таблиця змісту та інші потрібні елементи. 

 # файл DocBook HTML
 HTMLFILE=""
Типовим є використання фрагментованої таблиці стилів XSL. У поточній версії не передбачено підтримки використання декількох таблиць стилів на один запуск HTML. 

 # файл XSL, яким слід скористатися для HTML
 HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

АВТОРИ

 Neil Williams <linux@codehelp.co.uk>
2018-05-27 Інструменти Po4a