Générateur de contenu d'aide
Identificateur :
org.eclipse.help.contentProducer
Depuis :
3.0
Description :
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.
Marques de configuration :
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - classe d'implémentation pour le générateur de
contenu d'aide. Cette classe doit implémenter l'interface
org.eclipse.help.IHelpContentProducer. Cet attribut
peut être omis et l'élément producer imbriqué
fourni à la place.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - classe d'implémentation pour le générateur de
contenu d'aide. Cette classe doit implémenter l'interface
org.eclipse.help.IHelpContentProducer.
<!ELEMENT
parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - nom d'un paramètre transmis à la classe d'implémentation.
- value - valeur d'un paramètre transmis à la classe d'implémentation.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId : nom unique d'un générateur de contenu défini ailleurs à l'aide de l'élément contentProducer. La liaison permet à un plug-in de réutiliser un générateur de contenu dans un autre plug-in au lieu de définir son propre générateur.
Exemples:
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>
Informations d'API :
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.
Implémentations fournies :
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.
Copyright (c) 2000, 2006 IBM Corporation and others.
All rights reserved. Ce programme et les produits associés sont
distribués sous licence v1.0 et disponibles à
l'adresse suivante :
http://www.eclipse.org/legal/epl-v10.html