Inhaltserzeugungsfunktion für Hilfe
Kennung:
org.eclipse.help.contentProducer
Seit:
3.0
Beschreibung:
Zur Bereitstellung von dynamischem Hilfeinhalt, der zur Laufzeit generiert wurde.
Konfigurationsbefehle:
<!ELEMENT extension (contentProducer?)>
<!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 - Name eines Parameters, der an die Implementierungsklasse weitergegeben wird
- value - Wert eines Parameters, der an die Implementierungsklasse weitergegeben wird
Beispiele:
Das folgende Beispiel verwendet den
Browser-Erweiterungspunkt:
<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-Information:
Die bereitgestellte Inhaltserzeugungsklasse muss die Schnittstelle org.eclipse.help.IHelpContentProducer implementieren.
Der Erzeuger ist verantwortlich für die Bereistellung von Inhalt für dynamische Hilfequellen von einem Plug-in. Die Methode des Inhatserzeugers wird durch die Hilfe für jede Hilfsquelle aufgerufen, die man von dem Plug-in erhält.
Bereitgestellte Implementierung:
Keine. Wenn ein Dokumentations-Plug-In keine Inhaltserzeugungsfunktion für Hilfe bereitstellt oder einen Aufruf zu den Ergebnissen mit Null, sucht das Hilfesystem doc.zip-Dateien und das Dateisystem in der Plug-in-Installationsposition für ein statisches Dokument und zeigt seinen Inhalt an.
Copyright (c) 2000, 2003 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.