Include 用来在您的文档中包括其他文档中的部分内容。此标记指定了要包括的文档和元素。在向用户显示该文档前,将把 include 元素替换为所引用的元素。
例如,您可能希望在您提供的每个帮助文档末尾显示版权信息。您可以将此信息复制并粘贴到每个文档中,但是,如果更改了版权信息(例如,更改了版权年份),则必须修改每个文档。
您可以改为将版权信息放到名为 copyright.xhtml
的独立 XHTML 文件中并对其指定唯一的标识,如下所示:
<p id="copyright"> Copyright 2006 My Company. All rights reserved. </p>
然后,在每个文档中,简单地包括版权段落:
<p> This is my document. It should have a copyright at the end. </p> <include path="my.plugin.id/path/copyright.xhtml/copyright"/>
在将该文档发送到浏览器中进行显示之前,include
元素将被版权段落替换。
请参阅以下内容以获取允许使用 include 的文档类型列表。include 的
path
元素格式取决于所包括的文档的类型。正如您在以上示例中看到的那样,XHTML
帮助文档的格式是“<plugin_id>/<path_to_file>/<element_id>”
。请参阅下列链接以了解您使用的文档类型的格式。