ヘルプ・プラグインのビルド

この例では、すでに、ドキュメンテーションの作成者から、 HTML ファイルの形式で、生のドキュメンテーションの提供を受けているものとします。 これらのファイルの細分度と構造は、完全にドキュメンテーション・チームの任意です。 ドキュメンテーションが配布されると、プラグインとトピックのセットアップは別々に行うことができます。

最初に、ドキュメンテーションはすでに次のツリーで提供されているものとします。

doc/
    concepts/
        concept1.html
        concept1_1.html
        concept1_2.html
    tasks/
        task1.html
        task2.html
        task3_1.html
        task3_2.html
    ref/
        ref1.html
        ref2.html

プラグイン名を com.example.helpexample とします。

最初のステップでは、プラットフォームの plugins ディレクトリーの下に、 プラグイン・ディレクトリー com.example.helpexample を作成します。 上で示されている doc\ サブツリーは、このディレクトリーにコピーする必要があります。

ドキュメンテーション・プラグインは、コード・プラグインと全く同様にマニフェストを必要とします。 次のマークアップは、ドキュメンテーション・プラグインを定義しています。

<?xml version="1.0" ?>
<plugin name="Online Help Sample"
    id="com.example.helpexample"
    version="1.0"

    provider-name="MyExample" />