名前

       po4a-build.conf - 翻訳済み内容ビルド用設定ファイル

概要

       po4a-build.conf は、翻訳されていないソース群およびそれぞれに対応する PO ファイルから翻訳済
       みと未訳のドキュメントをビルドする方法を記述します。

       対応しているあらゆるフォーマットにおいて、サポートするあらゆる組み合わせは単一の設定ファイ
       ル po4a-build.conf で指示し、ただ "po4a-build" を呼び出すだけで処理できます。しかし、po/
       ディレクトリを分割し、各実行を一つの設定ファイルで扱うことも選択できます (それぞれ
       "po4a-build -f FILE" を呼び出してください)。

       po4a-build にスクリプト出力メッセージ翻訳用の gettext サポート追加が含まれているといって
       も、po4a-build.conf 自体はそのような翻訳をサポートしていないことに注意してくださ
       い。po4a-build.conf は、manpage のような静的内容の翻訳にのみ関係します。

       ランタイムメッセージ翻訳の po4a-build サポートについては、po4a-runtime(7) を参照してくださ
       い。

サポートするフォーマット

       現在、"po4a-build" は以下の組み合わせをサポートしています:

       セクション 1, 3 用 DocBook XML
           通常、POD のような独自のドキュメントフォーマットを持たないシェルスクリプトやその他のイ
           ンタプリタで利用されます。既存の manpage から "doclifter"(1) を用いて直接適合する XML
           を生成でき、余計な作業負荷もなく "po4a-build" で POT ファイルを生成できます。その生成
           した POT ファイルは翻訳用に提供でき、適切な po/ ディレクトリに PO ファイルを配置できま
           す。さらに、"po4a-build" は "doclifter" XML による未訳 manpage だけでなく、"PO4a" も利
           用して翻訳済み XML を PO ファイルから生成し、その XML から翻訳済み manpage をビルドし
           ます。

           デフォルトでは docbook-xsl を用いて manpage を生成します。"po4a-build" 設定ファイルの
           "XSLFILE" 設定を用いて使用するスタイルシートを上書きできます。

       HTML 用 DocBook XML
           最終的に HTML を準備するスタイルシートは、デフォルトのままにしておけます。ま
           た、"po4a-build" 設定ファイルの "HTMLXSL" 設定を用いて上書きできます。

       セクション 1, 3, 5, 7 用 POD
           サポートする各セクション用に POD 内容を pod2man で変換します。

           セクション 1 向けに "PODFILE"、セクション 3 向けに "PODMODULES"、セクション 5 向けに
           "POD5FILES"、セクション 7 向けに "POD7FILES" を使用してください。

           セクション 5、7 の内容のファイル名の一部に 5 や 7 が含まれる場合は、(セクション 1 の内
           容でも使われるファイル名にしなければならない傾向があるので) ファイル名の拡張子と共に 5
           や 7 が自動的に取り除かれます。

           例えば /usr/share/man/man7/po4a.7.gz を準備するには:

            # セクション 7 用 POD
            POD7FILES="doc/po4a.7.pod"

ファイル内容

       設定値は設定ファイル内でどのような順番でもかまいません。

       '#' 以降の内容を無視します。

       常に空になる値は、ファイルから取り除けます。

       設定フィールドのいくつかは必須です。必須フィールドを空にすると、po4a-build は何もせずに終
       わります。

       CONFIG
           必須です。

           "po4a-build" が生成して管理する (一時的な) "po4a" 設定ファイルの名前と位置です。この
           ファイルは、バージョン管理システムの管理下にある必要はなく、パッケージのビルドの過程で
           安全に削除できます。

            # 設定ファイルの名前と位置
            CONFIG="_build/po4a.config"

       PODIR
           必須です。

           この設定ファイルで扱うすべての翻訳用 PO ファイルを格納するディレクトリです。文字列はす
           べてこのディレクトリにある POT ファイルにマージされ、全 PO ファイルを この POT ファイ
           ルとマージします。KEEP 閾値 (後述) は、このファイルで指定した全入力ファイルの全文字列
           と、このディレクトリにある全 PO ファイルに適用されます。ディレクトリは 'po' と言う名前
           である必要はありません。しかし、いくつかの統計ツールは名前が 'po' であることを求めてい
           ます。したがって、この名前のままにすることが推奨されることに注意してください。

            # manpage/doc 用 po ディレクトリ
            PODIR="po/pod"

       POTFILE
           必須です。

           POT ファイルへのパス (この設定ファイルの位置からの相対パス) です。ここに対して
           "po4a-build" が翻訳を生成し、保守や更新を行います。

            # POT ファイルのパス
            POTFILE="po/pod/po4a-pod.pot"

       BASEDIR
           必須です。

           翻訳内容を書き出すベースディレクトリ。

            # 生成したファイルのベースディレクトリ、例: doc
            BASEDIR="_build"

       BINARIES
           必須です。

           単一パッケージをビルドするとしても、少なくとも一つは値が必要です。

           この文字列は任意ですが、通常パッケージ名からできています。生成した内容は、以下のように
           BASEDIR/BINARIES のサブディレクトリに現れます:

            _build/po4a/man/man1/foo.1

           複数のバイナリパッケージをビルドする場合 (つまり、一つのソースパッケージと複数の .deb
           ファイルや .rpm ファイル)、このフィールドは各ターゲットを対象とした内容を分離すること
           で、ビルドプロセスの自動化を簡単にします。

           Separate strings with a space.

            # 生成した manpage を含むバイナリパッケージ
            BINARIES="po4a"

       KEEP
           特定の翻訳がビルドから除外される前に "po4a -k" に直接渡される、正しく翻訳される内容の
           閾値です。空のままにしたり、削除したりするとデフォルト値 (80%) を使用します。また、0
           にすると、まったく訳されていなくても、強制的にすべての内容を含めるようになります。

           そのような挙動をすべて制御するために、どのファイルをどの po4a-build.conf 設定ファイル
           に割り当てるかを慎重に決めてください。

           翻訳者にとっては POT ファイルにたくさんのファイルが含まれていると (特に共通する文字列
           が多いと) 都合がよいですが、逆に POT ファイルにたくさんの長い文字列があると、文字列の
           確定に時間がかかり、翻訳者の気力を奪ってしまうということに注意してください。

            # 維持する翻訳率のしきい値
            KEEP=

       XMLMAN1
           セクション 1 の manpage を生成するための DocBook XML です。ファイル名は空白で区切られ
           ます。すべてのファイルが、XMLDIR ディレクトリにある必要があります。

           目次などを提供するために、複数の XML ファイルを一つの book にまとめるのは一般的な手法
           です。book に XMLMAN3 で指定したファイルも含む場合、book 自体ではなく、セクション 1 の
           XML ファイルだけをここに指定してください。book にこのセクションの内容だけがある場
           合、book ファイルを指定してください。

            # セクション 1 用 DocBook XML ファイル
            XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"

       XMLMAN3
           セクション 3 の manpage を生成するための DocBook XML です。ファイル名は空白で区切られ
           ます。すべてのファイルが、XMLDIR ディレクトリにある必要があります。

           目次などを提供するために、複数の XML ファイルを一つの book にまとめるのは、一般的な手
           法です。book に XMLMAN1 で指定したファイルも含む場合、book 自体ではなく、セクション 3
           の XML ファイルだけをここに指定してください。book にこのセクションの内容だけがある場
           合、book ファイルを指定してください。

            # セクション 3 用 DocBook XML manpage
            XMLMAN3=""

       XMLDIR
           すべての DocBook XML ファイルの場所です。現在 "po4a-build" は、このディレクトリにある
           *.xml ファイルを探すと XMLMAN1 と XMLMAN3 に列挙したすべてのファイルが見つかることを期
           待しています。

           XMLMAN1 や XMLMAN3 を使用する場合、指定しなければなりません。設定ファイルの場所からの
           相対パスです。

            # XML ファイルの場所
            XMLDIR="share/doc/"

       XMLPACKAGES
           BINARIES のリスト外で、どのパッケージが XML ソース内容を使用するかを指定します。

           XMLMAN1 や XMLMAN3 で与えた値は、ここにも同様に与えなければなりません。

            # DocBook XML & xsltproc を使用するバイナリパッケージ
            XMLPACKAGES="po4a"

       DOCBOOKDIR
           XMLDIR と同様ですが、翻訳された DocBook ファイルを準備するために使用します。パッケージ
           で .sgml ファイルを使用したい場合は、どのようにビルドするべきかを po4a-devel メーリン
           グリストで議論してください。

            # .docbook ファイルを検索するパターン
            DOCBOOKDIR=""

       XSLFILE
           DocBook XML ファイルから翻訳済みおよび未訳の内容を用意するために使用される XSL スタイ
           ルシートです。

            # DocBook XML に使用する XSL ファイル
            XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"

       PODFILE
           セクション 1 の manpage を生成するための POD ファイルです。POD ファイルを空白で区切り
           ます。使用する場合、設定ファイルの場所からの相対パスを指定する必要があります。

            # セクション 1 用 POD ファイル
            PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"

       PODMODULES
           POD 内容を含む Perl モジュールに特化したサポートです。モジュール名はパスから再構築され
           ます (そのため一般的な Perl のレイアウトであるべきです)。また、manpage を自動的にセク
           ション 3 に配置します。

            # セクション 3 用 POD ファイル - モジュール名はパスから再生成されます
            PODMODULES="lib/Locale/Po4a/*.pm"

       POD5FILES
           セクション 5 の manpage を生成する任意の POD 内容です。使用する場合、設定ファイルの場
           所からの相対パスを指定する必要があります。

           セクション 5、7 の内容のファイル名の一部に 5 や 7 が含まれる場合は、(セクション 1 の内
           容でも使われるファイル名にしなければならない傾向があるので) ファイル名の拡張子と共に 5
           や 7 が自動的に取り除かれます。

            # セクション 5 用 POD ファイル
            POD5FILES="doc/po4a-build.conf.5.pod"

       POD7FILES
           セクション 7 の manpage を生成する任意の POD 内容です。使用する場合、設定ファイルの場
           所からの相対パスを指定する必要があります。

           セクション 5、7 の内容のファイル名の一部に 5 や 7 が含まれる場合は、(セクション 1 の内
           容でも使われるファイル名にしなければならない傾向があるので) ファイル名の拡張子と共に 5
           や 7 が自動的に取り除かれます。

            # セクション 7 用 POD
            POD7FILES="doc/po4a.7.pod"

       PODPACKAGES
           XMLPACKAGES と同様です。内容を POD ファイルからビルドするパッケージは、PODPACKAGES に
           値が含まれている必要があります。PODFILE、PODMODULES、POD5FILES、POD7FILES に何か値を指
           定する場合必須です。

            # POD を使用するバイナリパッケージ
            PODPACKAGES="po4a"

       HTMLDIR
           未訳と翻訳済みの HTML 出力を保存する BASEDIR のサブディレクトリです。

            # HTML 出力 (BASEDIR のサブディレクトリ)
            HTMLDIR=""

       HTMLFILE
           HTML に変換される DocBook ファイルです (XMLMAN1 や XMLMAN3 にあるファイルと同じか
           も)。セクションは HTML 出力と関連がないので、HTML に目次などを作るため、気軽に単一
           book ファイルを使用してください。

            # HTML DocBook file
            HTMLFILE=""

       HTMLXSL
           chunk XSL スタイルシートを使用する際のデフォルト値です。現在、HTML の実行ごとの、複数
           のスタイルシートの使用はサポートしていません。

            # HTML に使用する XSL ファイル
            HTMLXSL="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"

著者

        Neil Williams <linux@codehelp.co.uk>

訳者

        倉澤 望 <nabetaro@debian.or.jp>
        Debian JP Documentation ML <debian-doc@debian.or.jp>