Koboldトランスレータは、次のファイルから成り立っています。
- Kobold.pl - Koboldトランスレータ本体
- Kobold.cfg - エンジンの設定ファイル
- locale\ - エンジンのロケール設定の定義ファイルが配置されているフォルダ
Kobold.plは、Perlスクリプトで記述されているコマンドラインツールで、引数として次の書式を取ります。「ロケーション」以外は省略できません。
Kobold.pl [共有辞書ファイル] [カバーファイル] [ページファイル] [記事ファイル] [出力先ファイル] [パラメータ]
「共有辞書ファイル」は、ハイライトの付加に使用する辞書ファイルで、CSV形式(カンマ区切りのデータ形式)で記述します。「カバーファイル」「ページファイル」「記事ファイル」はいずれも「Koboldスクリプト」と呼ぶもので、独自の文法に従って記述します。
「出力先ファイル」は、最終的に生成されたウェブドキュメントの出力先です。Koboldスクリプト内で、最後に評価されたelementが出力されます。詳細は、「element定義」を参照してください。
「パラメータ」は、Koboldトランスレータの呼出時にgemを指定するために使います。「キー=値」の形式で与えることで、gem定義として処理されます。