ヘルプ・システム
ヘルプ・システム・プラグイン org.eclipse.help は、
2 つの拡張ポイント ("contexts" および "toc") を定義します。
これらにより個々のプラグインは、コンポーネントのコンテキスト・センシティブなヘルプや
オンライン・ヘルプを提供します。
ドキュメンテーションを提供する通常のプラグインは、これらの拡張ポイントを使用します。
他の拡張ポイントは、ヘルプ・システムの拡張機能を提供します。
より高度なアプリケーションの場合、
ヘルプ・システム UI のプラグインのための拡張ポイント ("support") も存在します。
拡張ポイント
以下の拡張ポイントにより、ヘルプ・システムを拡張することができます。
設定
ヘルプ・システムでは以下の設定値を使用できます。
-
log_level: ヘルプ・ログに書き込まれる情報を示します。
以下のツリー値のいずれかを使用してください。
- 0: エラーのみ記録
- 1: エラーと警告を記録
- 2: エラー、警告、および情報 (デバッグ) メッセージを記録
- banner: ヘルプ・ビューにアプリケーションの商標を表示できます。
会社のロゴなどをヘルプ・ビューの先頭に表示したい場合、HTML ページを /pluginId/path/to/banner.html と指定します。
現在、デフォルト・バナーは /org.eclipse.help.webapp/banner.html です。
この名前を空のストリングに設定すると、バナーは表示されません。
- banner_height: バナー・エリアの高さ。
現在、デフォルトは 45 です。
- help_home: ヘルプをオープンしたときに、コンテンツ・エリアに表示されるページ。
HTML ページを /pluginId/path/to/home.html と指定します。
現在、デフォルト・ホームは /org.eclipse.help/doc/help_home.html です。
- linksView: 関連するリンク・ビューの可視性を制御するため、true または false に設定します。
- baseTOCS: ブックシェルフに表示されるヘルプ TOC (ブック) の番号付きリスト。
他のすべての TOC がこれらのブックに続きます。
このリストに存在しない TOC は無視されます。
TOC それぞれのロケーションを /pluginId/path/to/toc.xml として使用します。