Inclusões

As inclusões são utilizadas para incluir partes de outros documentos no seu documento. A marcação especifica o documento e o elemento a incluir e, antes de o documento ser apresentada ao utilizador, o elemento de inclusão será substituído pelo elemento referido.

Por exemplo, poderá querer mostrar os direitos de autor no final de cada documento de ajuda que faculte. É possível copiá-los e colá-los a cada documento, mas se os direitos de autor alterarem (como por exemplo, o ano dos direitos de autor), terá de modificar todos os documentos.

Em vez disso, é possível colocar os direitos de autor num ficheiro de XHTML separado denominado copyright.xhtml e atribuir-lhe um identificador único da seguinte forma:

   <p id="copyright">
      Copyright 2006 My Company. All rights reserved.
</p>
  

Em seguida, para cada documento, inclua simplesmente o parágrafo de direitos de autor:

   <p> 
 
        This is my document. It should have a copyright at the end.
</p>
     <include
path="my.plugin.id/path/copyright.xhtml/copyright"/>

Antes de o documento ser enviado para o browser a ser apresentado, o elemento include será substituído pelo parágrafo de direitos de autor.

Onde se podem utilizar as inclusões?

Consulte abaixo uma lista de tipos de documentos no quais podem ser utilizadas inclusões. O formato do elemento path da inclusão depende do tipo de documento a partir do qual está a incluir. Como é possível verificar no exemplo apresentado acima, o formato para os documentos de ajuda XHTML é "<plugin_id>/<path_to_file>/<element_id>". Consulte as ligações apresentadas abaixo para obter o formato do tipo de documento que está a utilizar.