PO4A-BUILD(1)

名前
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. セクション 1 用 DocBook XML

    2. セクション 3 用 DocBook XML

    3. HTML 用 DocBook XML

    4. セクション 1 用 POD

    5. セクション 3 用 POD

    6. セクション 5 用 POD

    7. セクション 7 用 POD

すべてのサポートするフォーマットは、すべての組み合わせを、ひとつの po4a-build.conf 設定ファイルで扱い、po4a-build を一度呼び出すだけですみます。po4a-build.conf(5) をご覧ください。

設定

po4a-build は、パッケージ VCS のトップディレクトリにある po4a-build.conf を、デフォルト設定ファイルとして使用します (他のファイルを使用するには -f オプションを使用してください)。po4a-build.conf(5) をご覧ください。

例1 サンプル設定ファイル

サンプル設定ファイルは以下にあります。

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

  設定ファイルレイアウト

設定ファイルは、全般、XML/XSL サポート、POD サポート、HTML サポートのセクションから成っています。

全般には、po4a 設定ファイルの名前や場所 (po4a.config のままにしておくのが最善でしょう) や、ドキュメントの PO ファイルがある po ディレクトリ (通常 doc/po)、翻訳を作成する POT ファイルのフルネーム、生成物を出力する BASEDIR、パッケージのmanpageをセクション 1 ではなくてセクション 3 に格納するかどうか、生成物を格納するバイナリパッケージ名が含まれます。

XML/XSL サポートには、どのパッケージが XMLPACKAGES 変数により XSL サポートを使うかの指定や、xsltproc に渡す最上位の DocBookファイル、XML や DocBook ファイルの場所が含まれます。必要なら XSLFILE を上書きできます。

POD サポートには、どのパッケージが PODPACKAGES 変数により POD サポートを使うかの指定や、POD ファイルのフルネームが含まれます。

HTML サポートでは、BASEDIR 以下に作成する既訳・未訳 HTML 内容のサブディレクトリや、HTML を生成する DocBook ファイルを指定します。必要なら HTMLXSL を上書きできます。

コマンド

--pot-only
    POT ファイルの更新のみ行います。--pot-only は、パッケージソースにあるすべての POT ファイルがパッケージに含まれるように、支援することを意図しています。Autotools を使用したパッケージは、EXTRA_DIST により POT ファイルを簡単に追加できますが、単に Makefile を使用したり、特定の VCS ヘルパーを使用したパッケージは、VCS に POT ファイルを追加せずに、(生成した) POT ファイルを追加するのは厄介であることがわかります。面倒で不要な作業を避けるために、po4a-build は構築開始時に POT ファイルを更新し、dpkg-source がソース tarball に含められるようにします。

    例2 svn-buildpackage サンプル

    svn-buildpackage は、この種の追加を明示的にサポートしています。useNativeDist SVN 属性と native-dist Make ターゲットを用います。

        # ソース tarball に 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> によって書かれました。

このマニュアルページは Neil Williams <codehelp@debian.org> によって書かれました