名 前
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 フ ァ イ ル )、 こ の フ ィ ー ル ド は 各 タ ー ゲ ッ ト を 対 象 と し た 内 容 を 分 離 す る こ と で 、 ビ ル ド プ ロ セ ス の 自 動 化 を 簡 単 に し ま す 。 空 白 で 文 字 列 を 分 割 し ま す 。
# 生 成 し た 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 [AT] codehelp.uk>
訳 者
倉 澤 望
<nabetaro [AT] debian.jp>
Debian JP Documentation ML
<debian−doc [AT] debian.jp>