Âncoras

Ãncoras podem ser interpretadas como o ponto de extensão equivalente para os documentos de assistência ao usuário. Da mesma forma como os componentes utilizam pontos de extensão para permitir que outros componentes estendam sua funcionalidade, os documentos podem utilizar âncoras para permitir que outros componentes estendam seu conteúdo de assistência ao usuário.

Digamos que a documentação do componente A apresente uma listagem de formatos de arquivo que ele suporta. Se o componente B estender o suporte do A para muitos outros formatos, você poderá colocar uma âncora na lista do componente A e estender a lista de B. Exemplo:

   <p>A lista a seguir mostra os formatos suportados:</p>
<ul>
      <li>Portable Network Graphics (.png)</li>
      <li>Joint Photographic Experts Group (.jpeg)</li>
      <li>Graphical Interchange Format (.gif)</li>
      
      <!-- Formatos adicionais são colocados aqui -->
      <anchor id="image_format_list"/>
</ul>
        

O componente B pode fazer uma contribuição com a âncora para incluir mais formatos na lista.

Como eu contribuo com conteúdo em uma âncora?

Isso depende do tipo de documento. Geralmente, você define uma extensão que aponta para um arquivo XML que possui o conteúdo a ser incluído. Siga os links contidos na seção a seguir para saber como fazer isso no tipo de documento que você está utilizando:

Onde eu posso utilizar âncoras?

Veja 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.