名前
- Provided by: po4a (Version: 0.52-1)
- Report a bug
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" は以下の組み合わせをサポートしています:
デフォルトでは docbook-xsl を用いて manpage を生成します。"po4a-build" 設定ファイルの "XSLFILE" 設定を用いて使用するスタイルシートを上書きできます。
セクション 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 は何もせずに終わります。
"po4a-build" が生成して管理する (一時的な) "po4a" 設定ファイルの名前と位置です。このファイルは、バージョン管理システムの管理下にある必要はなく、パッケージのビルドの過程で安全に削除できます。
# 設定ファイルの名前と位置
CONFIG="_build/po4a.config"
この設定ファイルで扱うすべての翻訳用 PO ファイルを格納するディレクトリです。文字列はすべてこのディレクトリにある POT ファイルにマージされ、全 PO ファイルを この POT ファイルとマージします。KEEP 閾値 (後述) は、このファイルで指定した全入力ファイルの全文字列と、このディレクトリにある全 PO ファイルに適用されます。ディレクトリは 'po' と言う名前である必要はありません。しかし、いくつかの統計ツールは名前が 'po' であることを求めています。したがって、この名前のままにすることが推奨されることに注意してください。
# manpage/doc 用 po ディレクトリ
PODIR="po/pod"
POT ファイルへのパス (この設定ファイルの位置からの相対パス) です。ここに対して "po4a-build" が翻訳を生成し、保守や更新を行います。
# POT ファイルのパス
POTFILE="po/pod/po4a-pod.pot"
翻訳内容を書き出すベースディレクトリ。
# 生成したファイルのベースディレクトリ、例: doc
BASEDIR="_build"
単一パッケージをビルドするとしても、少なくとも一つは値が必要です。
この文字列は任意ですが、通常パッケージ名からできています。生成した内容は、以下のように BASEDIR/BINARIES のサブディレクトリに現れます:
_build/po4a/man/man1/foo.1
複数のバイナリパッケージをビルドする場合 (つまり、一つのソースパッケージと複数の .deb ファイルや .rpm ファイル)、このフィールドは各ターゲットを対象とした内容を分離することで、ビルドプロセスの自動化を簡単にします。
Separate strings with a space.
# 生成した manpage を含むバイナリパッケージ
BINARIES="po4a"
そのような挙動をすべて制御するために、どのファイルをどの po4a-build.conf 設定ファイルに割り当てるかを慎重に決めてください。
翻訳者にとっては POT ファイルにたくさんのファイルが含まれていると (特に共通する文字列が多いと) 都合がよいですが、逆に POT ファイルにたくさんの長い文字列があると、文字列の確定に時間がかかり、翻訳者の気力を奪ってしまうということに注意してください。
# 維持する翻訳率のしきい値
KEEP=
目次などを提供するために、複数の XML ファイルを一つの book にまとめるのは一般的な手法です。book に XMLMAN3 で指定したファイルも含む場合、book 自体ではなく、セクション 1 の XML ファイルだけをここに指定してください。book にこのセクションの内容だけがある場合、book ファイルを指定してください。
# セクション 1 用 DocBook XML ファイル
XMLMAN1="po4a-build.xml po4aman-display-po.xml po4apod-display-po.xml"
目次などを提供するために、複数の XML ファイルを一つの book にまとめるのは、一般的な手法です。book に XMLMAN1 で指定したファイルも含む場合、book 自体ではなく、セクション 3 の XML ファイルだけをここに指定してください。book にこのセクションの内容だけがある場合、book ファイルを指定してください。
# セクション 3 用 DocBook XML manpage
XMLMAN3=""
XMLMAN1 や XMLMAN3 を使用する場合、指定しなければなりません。設定ファイルの場所からの相対パスです。
# XML ファイルの場所
XMLDIR="share/doc/"
XMLMAN1 や XMLMAN3 で与えた値は、ここにも同様に与えなければなりません。
# DocBook XML & xsltproc を使用するバイナリパッケージ
XMLPACKAGES="po4a"
# .docbook ファイルを検索するパターン
DOCBOOKDIR=""
# DocBook XML に使用する XSL ファイル
XSLFILE="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"
# セクション 1 用 POD ファイル
PODFILE="po4a po4a-gettextize po4a-normalize scripts/msguntypot"
# セクション 3 用 POD ファイル - モジュール名はパスから再生成されます
PODMODULES="lib/Locale/Po4a/*.pm"
セクション 5、7 の内容のファイル名の一部に 5 や 7 が含まれる場合は、(セクション 1 の内容でも使われるファイル名にしなければならない傾向があるので) ファイル名の拡張子と共に 5 や 7 が自動的に取り除かれます。
# セクション 5 用 POD ファイル
POD5FILES="doc/po4a-build.conf.5.pod"
セクション 5、7 の内容のファイル名の一部に 5 や 7 が含まれる場合は、(セクション 1 の内容でも使われるファイル名にしなければならない傾向があるので) ファイル名の拡張子と共に 5 や 7 が自動的に取り除かれます。
# セクション 7 用 POD
POD7FILES="doc/po4a.7.pod"
# POD を使用するバイナリパッケージ
PODPACKAGES="po4a"
# HTML 出力 (BASEDIR のサブディレクトリ)
HTMLDIR=""
# HTML DocBook file
HTMLFILE=""
# 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>