ヘルプのソース文書は XML ファイルです。XML ファイルは HTML に変換され、この HTML が Yelp
ヘルプブラウザに表示されます。HTML は事前生成できます。つまり、ヘルプを使用する前に XML を HTML に変換することが可能です。
事前生成を行わなかった場合は、ヘルプファイルを呼び出したときに変換が自動的に実行されます。ヘルプファイルを呼び出したときに変換が行われると、変換はヘルプ文書の表示速度に重大な影響を及ぼします。
ヘルプのパフォーマンス問題を回避するため、HTML を事前生成し、ヘルプブラウザが変換を行わなくて済むようにしてください。ヘルプ文書の事前生成には、yelp-pregenerate コマンドを使用します。yelp-pregenerate コマンドの構文は、以下のとおりです。
yelp-pregenerate [- a| [-f filename ]] [ locale]以下の表に、yelp-pregenerate コマンドのオプションと引数を示します。
オプションまたは引数 |
説明 |
---|---|
-a |
|
-f |
コマンドで指定した XML ファイルだけを事前生成する |
filename |
事前生成する XML ファイルの名前 |
locale |
XML ファイルを事前生成するロケール。デフォルトのロケールは C (英語) |
たとえば、ファイルシステムのすべての XML ファイルの英語バージョンを事前生成するには、以下のコマンドを実行します
# yelp-pregenerate -a
デフォルトのロケールが C なので、この例ではロケールを指定する必要はありません。gedit
マニュアルのスペイン語バージョンを事前生成するには、以下のコマンドを実行します。
# yelp-pregenerate -f gedit.xml es
ヘルプファイルを開くと、ヘルプブラウザは以下の処理を行います。
ヘルプブラウザは、適切な HTML ファイルを検索します。HTML ファイルを検出すると、ヘルプブラウザはその HTML ファイルと対応する XML ファイルの変更日を比較します。HTML ファイルの日付が XML ファイルより新しい場合は、HTML ファイルが表示されます。
HTML ファイルの日付が XML ファイルより古い場合は、XML ファイルが HTML に変換されます。
ヘルプブラウザがヘルプ文書の HTML ファイルを検出できない場合も、XML ファイルは HTML に変換されます。
言い換えると、事前生成された HTML ファイルが存在する場合は、ヘルプブラウザはその HTML を表示します。事前生成された HTML ファイルが存在しない場合は、ヘルプブラウザは XML ファイルを HTML に変換します。
GNOME デスクトップに追加する新しいアプリケーションのヘルプを事前生成したい場合もあります。お使いの環境の容量制限が厳しい場合は、ヘルプの事前生成を行わない選択をすることもできます。