Ancrages

Les ancrages peuvent être considérés comme le point d'extension équivalent des documents d'aide aux utilisateurs. Tout comme les composants utilisent les points d'extension pour permettre à d'autres composants d'étendre leur fonctionnalité, les documents peuvent utiliser les ancrages pour permettre aux autres composants d'étendre leur contenu d'aide aux utilisateurs.

Imaginons que la documentation du composant A fournisse une liste des formats de fichier qu'il prend en charge. Si le composant B étend la prise en charge du composant A à d'autres formats, vous pouvez placer un ancrage dans la liste de A, et étendre la liste à partir de B. Par exemple :

   <p>La liste suivante affiche les formats pris en charge :</p>
   <ul>
      <li>Portable Network Graphics (.png)</li>
      <li>Joint Photographic Experts Group (.jpeg)</li>
      <li>Graphical Interchange Format (.gif)</li>
      
      <!-- Les formats supplémentaires s'affichent ici -->
      <anchor id="image_format_list"/>
   </ul>

Le composant B peut ensuite apporter une contribution à l'ancrage afin d'ajouter d'autres formats à la liste.

Comment ajouter du contenu à un ancrage ?

Cela dépend du type de document. Généralement, vous définissez une extension qui pointe vers un fichier XML contenant le contenu à ajouter. Suivez les liens de la section ci-dessous pour savoir comment ajouter un contenu dans le type de document que vous utilisez :

Où puis-je utiliser les ancrages ?

Reportez-vous au paragraphe ci-dessous pour obtenir la liste des types de document dans lesquels l'élément includes peut être utilisé. Le format de l'élément path de l'élément include dépend du type de document à partir duquel vous effectuez l'inclusion. Comme le montre l'exemple ci-dessus, le format des documents d'aide XHTML est "<plugin_id>/<path_to_file>/<element_id>". Reportez-vous aux liens suivants pour identifier le format de votre type de document.