ヘルプの組み込み

Eclipse プラットフォームのヘルプ機能は、ドキュメンテーションを構造化してプラットフォームに組み込むための未加工のビルディング・ブロックを提供します。 ドキュメンテーションの構造または細分度は、それによっては決定されません。 ドキュメンテーション用のツールと構造は必要に応じて選択できます。  ヘルプ・プラグインを使用すると、目次 (toc) ファイルを使用してプラットフォームに対するドキュメンテーション構造を記述できます。

プラグインのオンライン・ヘルプは、org.eclipse.help.toc 拡張ポイントを使用して組み込まれます。 オンライン・ヘルプをコードのプラグインのパーツとして追加する、 あるいはオンライン・ヘルプ自体のドキュメンテーション・プラグインでオンライン・ヘルプを個別に提供することができます。

ドキュメンテーションを個別のプラグインに分離すると、 コードとドキュメンテーションのチームが別のグループである場合、 またはドキュメンテーションとコードの結合の度合いを小さくしたい場合に役立ちます。

ヘルプ・システムの拡張フィーチャーには、参照リンク付きのコンテキストに依存したヘルプ (infopop と呼ばれる) と、 ドキュメンテーションからプラットフォーム・コードを起動する機能が組み込まれています。  ヘルプ・ブラウザーを使用すると、ドキュメンテーションの表示、印刷、検索が可能になります。   

ヘルプの contribution について理解する最上の方法は、ドキュメンテーション・プラグインを作成することです。

Copyright IBM Corporation and others 2000, 2003.