XHTML ヘルプ文書の提供

XHTML を使用する理由

ヘルプ・システムは、特殊なタグを使用して、フィルターインクルードを行い、拡張用のアンカーを指定して、XHTML マークアップに注釈を付けることにより、ダイナミック・ヘルプ・コンテンツを作成する機能を提供します。これらの機能は、HTML を使用する際には利用できません。

XHTML を提供する方法

XHTML ヘルプ文書は、動的コンテンツと検索をサポートするために必要ないくつかの重要な違いを除いては、HTML とほぼ同様の方法で提供されます。これらの必要な変更を以下にリストします。

XHTML インクルード形式

ご使用の XHTML でインクルードを使用する場合、 path 属性の形式は以下のようになります (以下に説明があります)。

   <plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>

ここで、フィールドは次のとおりです。

例えば、プラグイン my.product.plugin のファイル /copyrights/copyright.xhtml から my_copyright という ID のパラグラフ (<p> 要素) をインクルードする場合は、以下のように指定します。

   my.product.plugin/copyrights/copyright.xhtml/my_copyright