ヘルプの組み込み

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

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

プラットフォームのヘルプ機能は、ヘルプを構造化し追加するための未加工のビルディング・ブロックを提供します。 ドキュメンテーションの構造または細分度は、それによっては決定されません。 ただし、プラットフォームは、統合化されたヘルプ・ビューアーを提供し、 それをコントロールして、ドキュメンテーションのシームレスな統合を保証します。

org.eclipse.help.contributions 拡張ポイントは、ヘルプを追加するための以下の 4 つのエレメントを提供しています。

提供されるトピック、情報セット、およびアクションはすべて、追加エレメントの詳細を含む、 関連する .xml ファイルを指定します。 これらのエレメントを使用するドキュメンテーション・プラグインを作成すると、それらのエレメントをよく理解できます。