po4a\-build

Section: PO4A (1)
Updated: 02/09/2019
Page Index

ИМЯ

po4a-build - собрать переведенную документацию

СИНОПСИС

po4a-build [-f | --file: FILE] [--pot-only]
po4a-build [-? | -h | --help | --version]

ОПИСАНИЕ

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

как только po4a приготовила переведенное содержимое в формате POD или DocBook XML, документация может быть собрана с помощью команды 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. DocBook XML для section 1.

: 2. DocBook XML для section 3.

: 3. DocBook XML для HTML.

: 4. POD для section 1.

: 5. POD для section 3.

: 6. POD для section 5.

: 7. POD для section 7.

Настройки для все поддерживаемых форматов и всех поддерживаемых комбинаций содержатся в одном файле po4a-build.conf, обработка производится вызовом команды po4a-build. См. po4a-build.conf(5).

НАСТРОЙКИ

po4a-build обычно использует файл настройки po4a-build.conf который должен находиться в корневом каталоге VCS вашего пакета. (Используйте параметр -f для определения другого файла.) См. po4a-build.conf(5).

Пример 1. пример файла настройки

Пример файла настройки можно прочитать тут:

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

схема файла настройки

Файл настройки состоит из нескольких секций(параграфов), основной части, настроек XML/XSL, POD и HTML.

General includes the name and location of the po4a config file (probably best to leave this as po4a.config), the po directory containing the documentation PO files (often doc/po), the full name of the POT file used to create the translations, the BASEDIR for the generated output, whether the package contains manpages in section 3 rather than just section 1 and the names of the binary packages which are to contain the generated output.

XML/XSL support includes specifying which of the binary packages use XSL support in the XMLPACKAGES variable, the top level DocBook file to pass to xsltproc and the location of the XML or DocBook files. The XSLFILE can be overridden, if necessary.

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

HTML поддержка позволяет определять подкаталоги которые необходимо создавать в каталоге BASEDIR для не переведенных и переведенных HTML и DocBook файлов необходимых при создании HTML. HTMLXSL файл может быть перезаписан при необходимости.

КОМАНДЫ

--pot-only

Обновить только POT файл(ы). --pot-only предназначен для поддержки пакетов исходных текстов, включающих все POT файлы. В пакетах использующих Autotools можно легко добавить POT файл с помощью EXTRA_DIST, но в пакетах использующих Makefile или другие средства сборки VCS можно достаточно неудобно добавлять POT файл без размещения его в VCS. Чтобы избежать этой ненужно работы po4a-build может обновить POT файл(ы) в самом начале сборки, так что dpkg-source включит их в архив (tarball) исходных текстов.

Пример 2. пример использования svn-buildpackage

svn-buildpackage имеет явную поддержку такого рода дополнений, используя способность SVN useNativeDist и цель сборщика (Make) native-dist.

# добавить POT файл в архив исходных текстов
native-dist: Makefile
        po4a-build --pot-only

$ svn propset useNativeDist 1 debian

-h|--help

: распечатать инструкцию по использованию и выйти.

--version

: распечатать инструкцию по использованию и выйти.

ПАРАМЕТРЫ

-f|--file FILE

: Указать po4a-build не использовать файл настройки (po4a-build.conf) по умолчанию и предоставить свой собственный.

АВТОР

po4a-build был написан Нейлом Уильямсом (Neil Williams) <codehelp@debian.org>.

Эта man-страница была написана Нейлом Уильямсом (Neil Williams) <codehelp@debian.org>