Âncoras

As âncoras podem ser consideradas como o equivalente de pontos de extensão para documentos de assistência ao utilizador. Assim como os componentes utilizam pontos de extensão para permitir que outros componentes expandam a sua funcionalidade, os documentos podem utilizar âncoras para permitir que outros componentes expandam os respectivos conteúdos de assistência ao utilizador.

Imaginemos que a documentação da componente A faculta uma lista dos formatos de ficheiros que suporta. Se o componente B expandir o suporte do componente A a outros formatos, poderá colocar uma âncora na lista do componente A e expandir a lista do componente B. Por exemplo:

   <p>A seguinte lista apresenta os formatos suportados:</p>
   <ul>
      <li>Portable Network Graphics (.png)</li>
      <li>Joint Photographic Experts Group (.jpeg)</li>
      <li>Graphical Interchange Format (.gif)</li>
      
      <!-- Extra formats go here -->
      <anchor id="image_format_list"/>
</ul>
        

Em seguida, a componente B pode fazer uma contribuição para a âncora de modo a adicionar mais formatos à lista.

Como contribuir com conteúdo para uma âncora?

Isto depende do tipo de documento. Geralmente, o utilizador define uma extensão que indica um ficheiro XML que contenha o conteúdo a ser adicionado. Siga as ligações na secção abaixo apresentada para aprender a proceder a essa contribuição no tipo de documento que estiver a utilizar:

Onde se podem utilizar âncoras?

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.