Inhaltserzeugungsfunktion für Hilfe
Kennung:
org.eclipse.help.contentProducer
Seit:
3.0
Beschreibung:
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.
Konfigurationsbefehle:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer: Die Implementierungsklasse für die Inhaltserzeugungsfunktion für Hilfe. Diese Klasse muss die Schnittstelle org.eclipse.help.IHelpContentProducer implementieren. Dieses Attribut kann übergangen werden, wenn stattdessen das verschachtelte Element producer zur Verfügung gestellt wird.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class: Die Implementierungsklasse für die Inhaltserzeugungsfunktion der Hilfefunktion. Diese Klasse muss die Schnittstelle org.eclipse.help.IHelpContentProducer implementieren.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name: Der Name eines Parameters, der an die Implementierungsklasse weitergegeben wird.
- value: Der Wert eines Parameters, der an die Implementierungsklasse weitergegeben wird.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId: Der eindeutige Name eines Inhaltsproviders, der an einer anderen Stelle mit dem Element contentProducer definiert ist. Durch das Binding kann ein Plug-in eine Inhaltserzeugungsfunktion, die in einem anderen Plug-in registriert ist, wiederverwenden, statt eine eigene Funktion zu definieren.
Beispiele:
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>
API-Informationen:
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.
Bereitgestellte Implementierung:
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.
Copyright (c) 2000, 2006 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.