インクルードは、他の文書のパーツをユーザーの文書に組み込むために使用されます。マークアップはインクルードする文書および要素を指定します。インクルード要素は、文書がユーザーに表示される前に、参照された要素に置き換え られます。
例えば、ユーザーが提供する各ヘルプ文書の最後に著作権を表示する場合があります。各文書で著作権をコピーおよび貼り付けた場合に、著作権を変更する (例えば、著作権年) と、ユーザー文書の各 著作権を変更する必要があります。
このような場合、次のように、copyright.xhtml
と呼ばれる別の XHTML ファイルに著作権を置いて、固有 ID を割り当てることができます。
<p id="copyright"> Copyright 2006 My Company. All rights reserved. </p>
このようにすると、各文書で、単に著作権パラグラフをインクルードするだけですみます。
<p> これは私の文書です。最後に著作権を表示します。 </p> <include path="my.plugin.id/path/copyright.xhtml/copyright"/>
文書がブラウザーに送られて表示される前に、include
要素は著作権パラグラフに置換 されます。
インクルードを使用できる文書タイプのリストについては、以下を参照してください。インクルードの path
要素の形式は、インクルード元の文書タイプによって異なります。上記の例からわかるように、
XHTML ヘルプ文書の形式は、
"<plugin_id>/<path_to_file>/<element_id>"
です。文書タイプの形式については、以下のリンクを参照してください。