Includes

Inclusões são utilizadas para incluir partes de outros documentos no seu documento. A marcação especifica o documento e o elemento a ser incluído, e, antes que o documento seja mostrado ao usuário, o elemento de inclusão será substituído pelo elemento mencionado.

Por exemplo, é possível mostrar direitos autorais no fim de cada documento de ajuda fornecido. Você pode copiá-los e colá-los em cada documento, mas, se os direitos autorais forem alterados (por exemplo, o seu ano), você deverá modificar todos os seus documentos.

Em vez disso, você pode colocar os direitos autorais em um arquivo XHTML separado chamado copyright.xhtml e designá-lo a um identificador exclusivo, como este:

   <p id="copyright">
      Direitos Autorais 2006 Minha Empresa. Todos os direitos reservados.
</p>

Então, para cada documento, basta incluir o parágrafo de direitos autorais:

      <p>
      Este é meu documento. Deve ter os direitos autorais no fim.
</p>
   <incluir caminho="my.plugin.id/path/copyright.xhtml/copyright"/>

Antes que o documento seja enviado para o navegador para ser exibido, o elemento include será substituído pelo parágrafo de direitos autorais.

Onde eu posso utilizar inclusões?

Consulte a seguir uma lista de tipos de documento em que é possível utilizar inclusões. O formato do elemento path da inclusão depende do tipo de documento do qual você está incluindo. Como é possível ver no exemplo anterior, o formato dos documentos de ajuda XHTML é "<plugin_id>/<path_to_file>/<element_id>". Consulte os links a seguir para saber o formato do seu tipo de documento.