Inhaltserzeugungsfunktion für Hilfe

org.eclipse.help.contentProducer

3.0

Dieser Erweiterungspunkt dient zur Bereitstellung von dynamischem Hilfeinhalt, der zur Laufzeit generiert wurde. Inhaltsprovider werden jeweils für ein Plug-in registriert und können nur im Geltungsbereich des Plug-ins verwendet werden. Um eine Inhaltserzeugungsfunktion in einem anderen Plug-in wiederzuverwenden, sollte das Element binding verwendet werden. Diese Strategie verhindert, dass Plug-ins die Inhaltserzeugung unbefugt für alle Plug-ins verwenden. Durch ein Binding an einen Inhaltsprovider genehmigt das Plug-in die Steuerung der Inhaltserzeugung für alle Dokumente durch das erteilende Plug-in.

<!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>


Das folgende Beispiel zeigt die Verwendung des Erweiterungspunktes für Inhaltserzeugungsfunktionen:

  

<extension point=

"org.eclipse.help.contentProducer"

id=

"org.eclipse.myPlugin.myDynamicHelpProducer"

name=

"My Dynamic Help Content"

>

<contentProducer producer=

"org.eclipse.myPlugin.myPackage.Myproducer"

/>

</extension>

Die bereitgestellte Inhaltserzeugungsklasse muss die Schnittstelle org.eclipse.help.IHelpContentProducer implementieren. Der Erzeuger ist verantwortlich für die Bereitstellung von Inhalt für dynamische Hilfequellen von einem Plug-in. Die Methode der Inhaltserzeugungsfunktion wird durch die Hilfe für jede Hilfequelle aufgerufen, die man von dem Plug-in erhält.

Keine. Wenn ein Dokumentations-Plug-in keine Inhaltserzeugungsfunktion für die Hilfe bereitstellt oder ein Aufruf zu dem Ergebnis Null führt, sucht die Hilfefunktion in Dateien "doc.zip" und im Dateisystem in der Plug-in-Installationsposition nach einem statischen Dokument und zeigt seinen Inhalt an.