Scroll to navigation

PO4A-BUILD(1) PO4A PO4A-BUILD(1)

NAZWA

po4a-build - buduje przetłumaczoną dokumentację

STRESZCZENIE

po4a-build [-f | --file PLIK] [--pot-only]

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

OPIS

po4a-build ma sprawiać, że tworzenie przetłumaczonej dokumentacji będzie tak samo łatwe jak tworzenie treści nieprzetłumaczonej.

Kiedy po4a utworzy przetłumaczoną zawartość jako pliki POD lub DocBook XML, po4a-build może zbudować końcową dokumentację. Zarówno przetłumaczona, jak i nieprzetłumaczona zawartość jest budowana przez pojedynczy proces, aktualizujący jednocześnie pliki POT.

Istniejące instrukcje budowania są zastępowane przez pojedyncze wywołanie po4a-build i prosty plik konfiguracyjny używany przez po4a-build do określenia, jak zbudować każdy element i które pakiety binarne mają zawierać treści przetłumaczone i nieprzetłumaczone.

Po zbudowaniu zawartość będzie się znajdować w odpowiednich dla pakietów podkatalogach katalogu podanego w opcji BASEDIR pliku konfiguracyjnego. Dla pakietu binarnego o nazwie bla, zawierającego francuskie i niemieckie tłumaczenia, wynikiem będzie:

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

Ułatwia to włączanie wszystkich wygenerowanych treści do pakietu binarnego:

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

Nie będzie trzeba aktualizować powyższej reguły po dodaniu nowych tłumaczeń, a dodanie kolejnego pakietu binarnego (ble) pozwoli na rozdzielenie zawartości tych pakietów.

Obsługiwane formaty

Obecnie po4a-build obsługuje następujące kombinacje:

1.DocBook XML dla sekcji 1.

2.DocBook XML dla sekcji 3.

3.DocBook XML dla HTML.

4.POD dla sekcji 1.

5.POD dla sekcji 3.

6.POD dla sekcji 5.

7.POD dla sekcji 7.

Wszystkie dostępne formaty i wszystkie dostępne kombinacje można zawrzeć w pojedynczym pliku konfiguracyjnym po4a-build.conf i w pojedynczym wywołaniu programu po4a-build. Szczegóły można znaleźć w po4a-build.conf(5).

KONFIGURACJA

po4a-build używa domyślnego pliku konfiguracyjnego, po4a-build.conf, który powinien być umieszczony w głównym katalogu źródeł pakietu (Proszę użyć opcji-f, aby podać inny plik). Zobacz także po4a-build.conf(5).

Przykład 1. przykładowy plik konfiguracji

Przykładowy plik konfiguracji jest dostępny w:

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

Układ pliku konfiguracji

Plik konfiguracyjny składa się z kilku sekcji: ogólna, wsparcie dla XML/XSL, wsparcie dla POD oraz wsparcie dla HTML-a.

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.

Sekcja wsparcia dla POD określa, które z pakietów binarnych używają wsparcia dla POD w zmiennej PODPACKAGES oraz pełną nazwę pliku POD.

Sekcja wsparcia dla HTML-a podaje podkatalog katalogu BASEDIR zawierający nieprzetłumaczone i przetłumaczone dokumenty HTML oraz plik DocBook do wygenerowania HTML-a. Plik HTMLXSL może zostać nadpisany, jeśli jest to potrzebne.

POLECENIA

--pot-only

Only updates the POT file(s). --pot-only is intended to support packages including all POT files in the package source. Packages using Autotools can easily add the POT file via EXTRA_DIST but packages just using a Makefile or certain VCS build helpers can find it awkward to add the POT file (which is a generated file) without putting the POT file into the VCS. To avoid this ugly and unnecessary work, po4a-build can update the POT file(s) at the start of the build, so that dpkg-source includes them into the source tarball.

Przykład 2. Przykład svn-buildpackage.

svn-buildpackage otwarcie wspiera taki dodatek, za pomocą właściwości SVN useNativeDist oraz celu native-dist programu make.

# dodaje plik POT do archiwum źródeł
native-dist: Makefile
	po4a-build --pot-only


            

$ svn propset useNativeDist 1 debian

-h|--help

Wyświetla komunikat pomocy i kończy działanie.

--version

print the script version and exit.

OPCJE

-f|--file PLIK

Nadpisuje domyślny plik konfiguracyjny polecenia po4a-build (tj. plik po4a-build.conf).

AUTOR

po4a-build napisał Neil Williams <codehelp@debian.org>.

Tę stronę podręcznika napisał Neil Williams <codehelp@debian.org>

05/27/2018 PO4A