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.

Sekcja ogólna zawiera nazwę i lokalizację pliku konfiguracyjnego po4a (najprawdopodobniej najlepiej byłoby go zostawić jako po4a.config), nazwę katalogu po zwierającego pliki PO dokumentacji (często doc/po), pełną nazwę pliku POT używanego do wygenerowania tłumaczeń, katalog bazowy generowanej dokumentacji (BASEDIR), informacje o tym, czy pakiet zawiera strony podręcznika w sekcji 3 zamiast tylko w sekcji 1 oraz nazwy pakietów binarnych zawierających wygenerowane wyjście.

Sekcja wsparcia dla XML/XSL, określa które z pakietów binarnych używają wsparcia dla XSL (w zmiennej XMLPACKAGES), główny plik DocBook przekazywany do xsltproc oraz lokalizacje plików XML lub DocBook. XSLFILE może zostać nadpisane, jeśli jest to potrzebne.

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
    Aktualizuje tylko plik(i) POT. --pot-only jest przeznaczona dla pakietów, których źródła zawierają wszystkie pliki POT. Pakiety używające Autotools mogą w prosty sposób dodać plik POT do pakietu źródłowego, używając EXTRA_DIST, jednakże w przypadku pakietów używających zwykłych Makefile'i lub pewnych narzędzi pomocniczych z systemu kontroli wersji umieszczenie pliku POT (który jest plikiem generowanym) w pakiecie źródłowym może okazać się niemożliwe bez jednoczesnego dodania go do systemu kontroli wersji. Aby uniknąć tej paskudnej i niepotrzebnej roboty, po4a-build potrafi zaktualizować plik(i) POT na początku budowania pakietu, tak żeby dpkg-source mogło włączyć go do pakietu źródłowego.

    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
    Wyświetla komunikat pomocy i kończy działanie.

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>