Générateur de contenu d'aide

org.eclipse.help.contentProducer

3.0

Fournit un contenu d'aide dynamique et généré au moment de l'exécution. Les générateurs de contenu sont enregistrés par plug-in et fonctionnent uniquement dans la portée de celui-ci. Pour réutiliser un générateur de contenu dans un autre plug-in, l'élément binding doit être utilisé. Cette stratégie empêche les plug-ins de détourner le contenu généré pour tous les plug-ins. En s'associant à un générateur de contenu, un plug-in l'autorise à contrôler la génération de contenu pour tous les documents dans le plug-in fournisseur.

<!ELEMENT extension (contentProducer | binding)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentProducer (producer)>

<!ATTLIST contentProducer

producer CDATA #IMPLIED>


<!ELEMENT producer (parameter*)>

<!ATTLIST producer

class CDATA #REQUIRED>


<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>


<!ELEMENT binding EMPTY>

<!ATTLIST binding

producerId CDATA #REQUIRED>


L'exemple suivant illustre l'utilisation du point d'extension de générateur de contenu :

  

<extension point=

"org.eclipse.help.contentProducer"

id=

"org.eclipse.myPlugin.myDynamicHelpProducer"

name=

"Mon contenu d'aide dynamique"

>

<contentProducer producer=

"org.eclipse.myPlugin.myPackage.Myproducer"

/>

</extension>

La classe du générateur de contenu doit implémenter l'interface org.eclipse.help.IHelpContentProducer. Le générateur est chargé de fournir du contenu pour les ressources d'aide dynamiques à partir d'un plug-in. La méthode du générateur de contenu est appelée par l'aide pour chaque ressource obtenue à partir d'un plug-in.

Aucune. Si un plug-in de documentation ne fournit pas de générateur de contenu d'aide ou si un appel de ce plug-in échoue, le système d'aide recherche dans doc.zip et dans le système de fichiers à l'emplacement d'installation du plug-in un document statique, puis en affiche le contenu.