Locale::Po4a::AsciiDoc(3pm)

名前
Locale::Po4a::AsciiDoc - PO ファイルと AsciiDoc ドキュメントの変換

説明
po4a (PO for anything) プロジェクトは、gettext ツールが想定していないドキュメントのような領域で翻訳をしやすくすること (またより興味深いのは、翻訳文の保守がしやすくなること) を目標にしています。

Locale::Po4a::AsciiDoc は、AsciiDoc フォーマットのドキュメントを翻訳するのを助けるモジュールです。

このモジュールで使用できるオプション
以下は、このモジュール固有のオプションです:

definitions
    インラインカスタマイズ 節で定義されるような、po4a 用の定義を含むファイル名です。翻訳されるドキュメントに定義を置けない場合、このオプションを利用できます。

    定義ファイルでは、行は二つのスラッシュではなく直接 po4a: で開始しなくてはなりません。

entry
    翻訳したい属性エントリの空白区切りリストです。デフォルトでは、翻訳する属性エントリはありません。

macro
    マクロ定義の空白区切りリストです。

style
    スタイル定義の空白区切りリストです。

forcewrap
    結果がAsciiDocフォーマッタによって誤って解釈される可能性があるとしても、逐語的でないブロックの自動的な行の折り返しを有効にします。

    既定では、po4aは生成されたAsciiDocファイルについては折り返しをしません。折り返しによってフォーマットが変更されないことを確実にするために、手動での検査に委ねられているからです。例えば、次のようなリスト項目を考えてみましょう。

     * a long sentence that is ending with a number 1. A second sentence.

    折り返しによって次のような表示になる場合、その項目は番号のついた副リストに分割されます。さらに悪いことに、翻訳に使用された言語の話者しか検査することができません。

     * a long sentence that is ending with a number
       1. A second sentence.

    なおpo4aによって生成されるファイルが折り返されないのは問題ではないでしょう。これらのファイルは自動的に処理されるためのものだからです。なんにせよソースファイルとして見做すべきではありません。

    このオプションがあればpo4aはより良い見た目のAsciiDocファイルを生成できますが、間違ってフォーマットされた出力となる可能性があります。

noimagetargets
    既定ではブロック画像の対象は翻訳可能となっており、内容を翻訳された画像に向けるようにできます。この挙動はこのオプションを設定することで止められます。

tablecells
    このオプションはセルの内容の副テーブル分割を有効にするフラグです。分割はセルの内容に限られ、その中の解析は行われません。

compat
    異なるツールとの互換性を保つために、解析規則を切り替えます。利用可能なオプションは "asciidoc " と "asciidoctor "です。Asciidoctorは、開閉ブロックフェンスの長さの等しさなど、より厳格な解析規則を持ちます。

nolinting
    リント文言を無効にします。ソースコードがより明確な文書構造になるように修復できなければ、こうした文言は役に立ちません。

yfm_keys
    YAMLフロントマター節で翻訳用に処理されるキーのコンマ区切りリストです。その他全てのキーが読み飛ばされます。キーは大文字小文字を区別するように照合されます。もしyfm_pathsとyfm_keysが一緒に使われていたら、そのうち少なくとも1つのオプションで照合されているときにその値が含められます。配列値は常に翻訳されますが、yfm_skip_arrayオプションを与えることもできます。

yfm_skip_array
    YAMLフロントマター節中の配列の値を翻訳しません。

yfm_paths
    YAMLフロントマター節からの抽出処理をするハッシュパスのコンマ区切りリストで、その他全てのパスが読み飛ばされます。パスは大文字小文字を区別するように照合されます。もしyfm_pathsとyfm_keysが一緒に使われているなら、少なくとも1つのオプションで照合するときに値が含められます。yfm_skip_arrayオプションが与えられていない限り、配列値は常に返されます。

インラインカスタマイズ
AsciiDoc モジュールは、% po4a: で始まる行によりカスタマイズできます。この行はパーサにコマンドとして解釈されます。以下のコマンドを認識します:

//po4a: macro name[attribute list]
    macro パラメータの詳細を記述します。name は有効なマクロ名でなければならず、ターゲットを翻訳しなければならない場合、アンダースコアで終わらなければなりません。

    attribute list 引数は、翻訳できる引数のコンマ区切りリストです。このリストには、位置パラメータを定義する数値か、属性名のどちらでも指定できます。

    name の前にプラス記号 (+) をつけると、マクロとその引数全体が翻訳対象になります。この場合、属性リストの定義は不要ですが、角カッコは必要です。

//po4a: style [attribute list]
    翻訳されなければならないスタイルの属性を詳細に記述します。

    attribute list 引数は、翻訳できる引数のコンマ区切りリストです。このリストには、位置パラメータを定義する数値か、属性名のどちらでも指定できます。先頭の属性はスタイル名で、翻訳対象になりません。

    スタイル名の前にプラス記号 (+) をつけると、属性リスト全体が翻訳対象になります。翻訳する属性の定義は不要です。

    スタイル名の前にマイナス記号 (-) をつけると、この属性は翻訳対象外になります。

//po4a: entry name
    翻訳する属性エントリを定義します。デフォルトでは翻訳しません。

このモジュールの状態
シンプルな AsciiDoc ファイルでのテストが成功しています。

著者
 Nicolas François <nicolas.francois@centraliens.net>
 Denis Barbier <barbier@linuxfr.org>

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

著作権とライセンス
 Copyright © 2005-2008 Nicolas FRANÇOIS <nicolas.francois@centraliens.net>.
 Copyright © 2012 Denis BARBIER <barbier@linuxfr.org>.
 Copyright © 2017 Martin Quinson <mquinson#debian.org>.

本プログラムは自由ソフトウェアです。GPL v2.0以降の条項に基づき再頒布と変更を行えます（COPYINGファイルを参照）。