Plusieurs composants d'aide aux utilisateurs vous permettent d'indiquer un contenu dynamique. Cela signifie que le contenu peut varier en fonction de l'environnement de l'utilisateur ou du contexte. Par exemple, vous souhaitez qu'une partie du document d'aide ou de la page de bienvenue s'affiche uniquement si une fonctionnalité de l'utilisateur est activée.
Il existe deux méthodes élémentaires pour créer un contenu dynamique. L'une consiste à ajouter des balises et des attributs (annotations) à votre marquage XML en indiquant au système de filtrer les sections ou les documents, d'inclure des sections d'autres documents, ou d'indiquer des ancrages permettant à d'autres composants d'enrichir votre documentation.
L'autre méthode consiste à écrire votre propre fournisseur de contenu en ajoutant du code Java visant à rédiger entièrement le contenu ou à traiter des documents statiques existants à la volée. Examinons les deux méthodes.
Pour en savoir plus sur l'apparence de chaque marquage, suivez les liens ci-dessus ou recherchez les rubriques dans la table des matières.
Cette opération est illustrée dans le fragment XHTML ci-dessous :
<p> Il s'agit d'un paragraphe statique. </p> <!-- Cette balise sera remplacée par la balise référencée --> <include path="my.plugin.id/path/my_other_document.xhtml/element_id"/> <ul> <li> Il s'agit d'un élément de liste statique. </li> <li filter="os=win32"> Ceci s'affiche uniquement sous Windows. </li> <li filter="plugin!=org.eclipse.help"> Ceci s'affiche uniquement si plugin org.eclipse.help n'est PAS installé. </li> </ul> <!-- Emplacement où d'autres peuvent ajouter du contenu --> <anchor id="my.anchor.id"/>
Un fournisseur de contenu est un dispositif permettant au code Java ajouté de générer le document à la volée. Les fournisseurs de contenu sont plus performants que les annotations XML, mais sont plus complexes à utiliser.
Les fournisseurs de contenu sont pris en charge dans les sections suivantes de l'aide aux utilisateurs :