man po4a-build (1): übersetzte Dokumentation erstellen

ÜBERSICHT

po4a-build [-f | --file: DATEI
po4a-build [-? | -h | --help | --version]

BESCHREIBUNG

po4a-build

ist für die leichte Erstellung übersetzter Dokumentation gedacht, da es den derzeitigen unübersetzten Inhalt erstellen kann.

Wenn po4a den übersetzten Inhalt als POD oder DocBook XML vorbereitet, kann die endgültige Dokumentation mit po4a-build erstellt werden. Sowohl der übersetzte als auch der unübersetzte Inhalt wird in einem Durchgang gebaut, gleichzeitig wird die POT-Datei aktualisiert.

Bestehende Erstellungsanweisungen werden durch einen einzelnen Aufruf von po4a-build ersetzt und eine einfache Konfigurationsdatei wird verwandt, um po4a-build mitzuteilen, wie jedes Element erstellt wird und welche binären Pakete die übersetzten und unübersetzten Inhalte enthalten werden.

Nach der Erstellung befindet sich der Inhalt in Paket-spezifischen Verzeichnissen unterhalb des in der Konfigurationsdatei angegebenen BASEDIR. Für ein Binärpaket foo, mit Übersetzungen nach Deutsch und Französisch, entstünde damit Folgendes:

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

Damit kann leicht der gesamte erstellte Inhalt mit einer einzigen Install-Angabe in das Binärpaket aufgenommen werden:

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

Diese Regel muss nicht aktualisiert werden, wenn neue Übersetzungen hinzugefügt werden und wird ein zweites Binärpaket (bar) hinzugefügt, kann der Inhalt für dieses Paket getrennt gehalten werden.

Unterstützte Formate

Derzeit unterstützt po4a-build die folgenden Kombinationen:

: 1. DocBook XML für Abschnitt 1

: 2. DocBook XML für Abschnitt 3

: 3. DocBook XML für HTML

: 4. POD für Abschnitt 1

: 5. POD für Abschnitt 3

: 6. POD für Abschnitt 5

: 7. POD für Abschnitt 7

Alle unterstützen Formate, in allen unterstützten Kombinationen, können in einer einzigen Konfigurationsdatei po4a-build.conf und in einem einzigen Aufruf von po4a-build vereint werden. Lesen Sie po4a-build.conf(5).

KONFIGURATION

po4a-build verwendet eine Standardkonfigurationsdatei po4a-build.conf, die sich in dem obersten Verzeichnis des VCS Ihres Paketes befinden sollte. (Verwenden Sie die Option -f, um eine andere Datei anzugeben.) Siehe po4a-build.conf(5).

Beispiel 1. Beispielkonfigurationsdatei

Eine Beispielkonfigurationsdatei ist an folgender Stelle verfügbar:

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

Aufbau der Konfigurationsdatei

Die Konfigurationsdatei besteht aus verschiedenen Abschnitten: general, XML/XSL support, POD support und HTML support.

»General« enthält den Namen und Ablageort der Po4a-Konfigurationsdatei (am besten bei po4a.config zu belassen), das PO-Verzeichnis, das die PO-Dokumentationsdateien enthält (oft doc/po), den vollen Namen der zu Erstellung der Übersetzung verwandten POT-Datei, das BASEDIR für die erstellte Ausgabe, ob das Paket Handbuchseiten in Abschnitt 3, statt bloß Abschnitt 1 enthält und die Namen der Binärpakete, die die erstellten Ausgaben enthalten sollen.

»XML/XSL support« enthält die Angabe, welches der Binärpakete XML-Unterstützung in der XMLPACKAGES-Variablen enthält, die oberste DocBook-Datei, die an xsltproc übergeben werden soll und den Ablageort der XML- oder DocBook-Dateien. Falls notwendig, kann XSLFILE überschrieben werden.

»POD support« enthält die Angabe, welches der Binärpakete die POD-Unterstützung in der PODPACKAGES-Variablen enthält und den kompletten Namen der POD-Datei.

»HTML support« gibt das Unterverzeichnis an, das unterhalb von BASEDIR für den unübersetzten und den übersetzten HTML-Inhalt und für die DocBook-Datei, die das HTML erstellt, erstellt werden soll. Falls notwendig, kann die HTMLXSL-Datei überschrieben werden.

BEFEHLE

--pot-only

Aktualisiert nur die POT-Datei(en). --pot-only ist zur Unterstützung von Paketen gedacht, die alle POT-Dateien in den Paketquellen enthalten. Pakete, die die Autotools verwenden, können die POT-Dateien leicht mittels EXTRA_DIST hinzufügen, aber Pakete, die nur eine Makefile oder bestimmte VCS-Bau-Hilfsprogramme verwenden, können es als komisch empfinden, die POT-Datei hinzuzufügen (da es eine generierte Datei ist), ohne die POT-Datei in das VCS aufzunehmen. Um diese hässliche und unnötige Arbeit zu vermeiden, kann po4a-build die POT-Datei(en) am Beginn des Paketbaus aktualisieren, so dass dpkg-source sie in den Quell-Tarball aufnimmt.

Beispiel 2. svn-buildpackage-Beispiel

svn-buildpackage unterstützt explizit diese Art von Zusatz, die mit der SVN-Eigenschaft useNativeDist und dem Make-Ziel native-dist verwandt wird.

# fügt die POT-Datei zum Quell-Tarball hinzu
native-dist: Makefile
        po4a-build --pot-only

$ svn propset useNativeDist 1 debian

-h|--help

: Benutzungshinweis ausgeben und Programm beenden

--version

: Benutzungshinweis ausgeben und Programm beenden

OPTIONEN

-f|--file DATEI

: Angabe einer eigenen Konfigurationsdatei statt der standardmäßigen Datei (po4a-build.conf).

AUTOR

po4a-build wurde von Neil Williams <[email protected]> geschrieben.

Diese Handbuchseite wurde von Neil Williams <[email protected]> geschrieben.