共有辞書ファイルは、Koboldトランスレータの入力ファイルの一つで、作成するウェブドキュメントにハイライトの付加ができるほか、そのデータは_dictionary_という名前のbasketとしてスクリプト内で参照できます。たとえば、このドキュメントの目次は、共有辞書ファイルの機能を使って作成しています。
共有辞書ファイルは、CSV形式(カンマ区切りのデータ形式)で、言葉とその説明などを記述したものです。たとえば、デフォルト設定では、以下のような形で記述します。
[言葉],[URL],[短い説明],[長い説明],[フラグ]
デフォルトでは、それぞれのパートが、'_dictionary_' basket内の、以下に示すgemに格納されます。
_term_ | [言葉] |
_term.url_ | [URL] |
_term.desc.s_ | [短い説明] |
_term.desc.l_ | [長い説明] |
_term.flag_ | [フラグ] |
ハイライトについての説明は「ハイライトの付加」を参照してください。また、basketの利用方法については、「basket定義」と「major control chore」を参照してください。
共有辞書ファイルの記述形式はtermで始まるdirectiveで、ハイライトの設定はhighlightで始まるdirectiveで、それぞれ設定可能です。これらのdirective設定の詳細について「directiveリファレンス」を参考にしてください。