XHTML を使用する理由
ヘルプ・システムは、特殊なタグを使用して、フィルター、インクルードを行い、拡張用のアンカーを指定して、XHTML マークアップに注釈を付けることにより、ダイナミック・ヘルプ・コンテンツを作成する機能を提供します。これらの機能は、HTML を使用する際には利用できません。
XHTML を提供する方法
XHTML ヘルプ文書は、動的コンテンツと検索をサポートするために必要ないくつかの重要な違いを除いては、HTML とほぼ同様の方法で提供されます。これらの必要な変更を以下にリストします。
XHTML 検索参加プログラムをユーザーの DOC プラグインにバインドする必要があります。
Eclipse ヘルプ実装は、検索速度を上げるために、 Lucene を使用して文書に索引を付けます。 文書に索引を付けるために Lucene がフォーマットを読み取ることができる必要があります。Eclipse では既に XHTML 文書の索引付けに検索参加プログラムが提供されているので、ユーザーは、ただ ヘルプ・システムに対してユーザーの文書にそのプログラムを使用することを通知するだけで構いません。 以下の拡張機能をプラグイン・マニフェストに追加します。
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
動的コンテンツを使用する場合は、ユーザーの DOC プラグインに XHTML 動的コンテンツ・プロデューサーをバインドする必要があります。
XML 注釈を使用して動的コンテンツを作成する場合、ユーザーの文書を 処理することをヘルプ・システムに通知する必要があります。 これは、XHTML 動的コンテンツ・プロデューサーをユーザーのプラグインにバインドすることにより行われます。
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
ご使用の XHTML でインクルードを使用する場合、
path
属性の形式は以下のようになります (以下に説明があります)。
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
ここで、フィールドは次のとおりです。
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
属性を追加して設定します (例えば、
my.element.id
)
例えば、プラグイン my.product.plugin
のファイル /copyrights/copyright.xhtml
から my_copyright
という ID のパラグラフ (<p>
要素) をインクルードする場合は、以下のように指定します。
my.product.plugin/copyrights/copyright.xhtml/my_copyright