Scroll to navigation

po4a-build(1) PO4A po4a-build(1)

НАЗВА

po4a-build - збирання перекладеної документації

КОРОТКИЙ ОГЛЯД

po4a-build [-f | --file ФАЙЛ] [--pot-only]

po4a-build [-? | -h | --help | --version]

ОПИС

po4a-build призначено для спрощення створення перекладеної документації таким чином, щоб це було не складнішим за створення поточних неперекладених даних.

Якщо po4a готує перекладені дані у форматі POD або XML DocBook, остаточну документацію можна зібрати за допомогою po4a-build. Неперекладені і перекладені дані збираються у межах одного процесу із одночасним оновленням файлів POT.

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

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

BASEDIR/foo/man/man1/foo.1
BASEDIR/foo/man/de/man1/foo.1
BASEDIR/foo/man/fr/man1/foo.1

Це полегшує включення усіх створених даних до бінарного пакунка із єдиним місцем встановлення:

doc/foo/man/* ./usr/share/man/
doc/foo/html/* ./usr/share/doc/foo/

Це правило не потребуватиме оновлення при додаванні нових перекладів, а додавання другого бінарного пакунка (bar) уможливить окреме розташування даних для нового пакунка.

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

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

1.XML DocBook для розділу 1.

2.XML DocBook для розділу 3.

3.XML DocBook для HTML.

4.POD для розділу 1.

5.POD для розділу 3.

6.POD для розділу 5.

7.POD для розділу 7.

Усі підтримувані формати, у всіх їхніх підтримуваних комбінаціях можна вказати у одному файлі налаштувань po4a-build.conf і у єдиному виклику po4a-build. Див. po4a-build.conf(5).

НАЛАШТОВУВАННЯ

po4a-build використовує типовий файл налаштувань, po4a-build.conf, який має зберігатися у каталозі верхнього рівня системи керування версіями вашого пакунка. (Скористайтеся параметром -f, щоб вказати інший файл.) Див. po4a-build.conf(5).

Приклад 1. приклад файла налаштувань

Приклад файла налаштувань доступний тут:

/usr/share/doc/po4a/examples/po4a-build.conf.example

компонування файла налаштувань

Файл налаштувань складається із декількох розділів, загального розділу, розділу підтримки XML/XSL, розділу підтримки POD та розділу підтримки HTML.

До загального розділу включається назва і розташування файла налаштувань po4a (ймовірно, варто залишити назву po4a.config), каталог po, у якому містяться файли PO документації (часто doc/po), повна назва файла POT, який використовується для створення перекладів, базовий каталог BASEDIR для виведених даних, дані про те, чи містяться у пакунку сторінки підручника (man) у розділі 3, а не лише у розділі 1, та назви бінарних пакунків, у яких міститимуться створені у результаті перекладу дані.

До розділу підтримки XML/XSL включають визначення того, які бінарні пакунки використовують підтримку XSL, у змінній XMLPACKAGES, файл DocBook верхнього рівня, який слід передати xsltproc, та розташування файлів XML або DocBook. Параметр XSLFILE, якщо потрібно, можна перевизначити.

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

У розділі підтримки HTML вказують підкаталог, який слід створити у BASEDIR для неперекладених і перекладених даних HTML, та файл DocBook, призначений для створення HTML. Файл HTMLXSL можна, якщо потрібно, перевизначити.

КОМАНДИ

--pot-only

Лише оновити файли POT. --pot-only призначено для підтримки пакунків, де усі файли POT включаються до пакунку з кодом. До пакунків, де використовується Autotools, файл POT можна додати доволі просто, за допомогою EXTRA_DIST, але у пакунках, де використовується лише Makefile або певні допоміжні засоби збирання системи керування версіями, додавання файла POT (який є створеним файлом) є некрасивим без записування цього файла POT до системи керування версіями. Щоб уникнути марудної і непотрібної роботи, можна скористатися програмою po4a-build, яка може оновити файли POT на початку процесу збирання, щоб згодом програма dpkg-source включила ці файли до архіву tar із початковим кодом.

Приклад 2. Приклад svn-buildpackage

У svn-buildpackage передбачено явну підтримку цього типу додавання за допомогою властивості SVN useNativeDist та цілі Make native-dist.

# додає файл POT до архіву tar з кодом
native-dist: Makefile
	po4a-build --pot-only

$ svn propset useNativeDist 1 debian

-h|--help

вивести повідомлення щодо використання і завершити роботу.

--version

вивести дані щодо версії скрипту і завершити роботу.

ПАРАМЕТРИ

-f|--file ФАЙЛ

Перевизначити типовий файл налаштувань po4a-build (po4a-build.conf) і вказати власний.

АВТОР

po4a-build написано Neil Williams <codehelp@debian.org>.

Цю сторінку підручника написано Neil Williams <codehelp@debian.org>

07/06/2018 PO4A