po4av0.52

PO4A-BUILD

Section: PO4A (1)
Updated: 10.09.2017
Index Return to Main Contents
 

NAME

po4a-build - übersetzte Dokumentation erstellen  

ÜBERSICHT

po4a-build [-f | --file
DATEI] [--pot-only]
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 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 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

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.

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

Skriptversion 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 <codehelp@debian.org> geschrieben.

Diese Handbuchseite wurde von Neil Williams <codehelp@debian.org> geschrieben.


 

Index

NAME
ÜBERSICHT
BESCHREIBUNG
Unterstützte Formate
KONFIGURATION
Aufbau der Konfigurationsdatei
BEFEHLE
OPTIONEN
AUTOR

This document was created by using the manual pages.
Time: 07:36:26 GMT, September 10, 2017
català Deutsch English español français Italiano 日本語 polski Português Português (Brasil) Русский