Hjælp - indholdsproducent
Id:
org.eclipse.help.contentProducer
Fra:
3.0
Beskrivelse:
Bruges til at levere dynamisk hjælpeindhold, genereret ved runtime.Indholdsproducenter er registreret pr. plugin og fungerer kun i plugin-omfanget. For at genbruge en indholdsproducent i en anden plugin skal elementet binding
anvendes. Denne strategi forhindrer plugins i at kapre indhold, der produceres til alle plugins. Ved binding til en indholdsproducent giver plugin'en tilladelse til at styre indhold, der produceres til alle dokumenter i den tildelende plugin.
Konfigurationskode:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST-udvidelse
point CDATA #REQUIRED
id CDATA #IMPLIED
navn CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - implementeringsklassen for
hjælpeindholdsproducenten. Denne klasse skal implementere grænsefladen
org.eclipse.help.IHelpContentProducer.
Denne attribut kan udelades, og det indlejrede
producer-element kan leveres i stedet.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - implementeringsklassen for hjælpeindholdsproducenten.
Denne klasse skal implementere grænsefladen
org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - navn på en parameter, der sendes til
implementeringsklassen
- value - værdien for en parameter, der sendes til
implementeringsklassen
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - et entydigt navn på indholdsproducenten, der er defineret et andet sted vha. elementet contentProducer. Binding tillader en plugin at genbruge indholdsproducenten, der er registreret i en anden plugin, i stedet for at definere sin egen.
Eksempler:
Det følgende er et eksempel på udvidelsespunktet for en indholdsproducent:
<udvidelsespunkt=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"Mit dynamiske hjælpeindhold"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
API-oplysninger:
Den leverede
indholdsproducentklasse skal implementere grænsefladen
org.eclipse.help.IHelpContentProducer.
Producenten er ansvarlig for at levere indhold til dynamiske
hjælperessourcer fra en plugin. Indholdsproducentmetoden kaldes af hjælpen
for hver hjælperessource, der hentes fra plugin'en.
Leveret implementering:
Ingen.
Hvis en dokumentations-plugin ikke leverer en hjælpeindholdsproducent
eller et kald til denne, resulterer det i NULL. Hjælpen gennemsøger
doc.zip og filsystemet på plugin-installationsplaceringen for at finde et
statisk dokument og viser indholdet.
Copyright (c) 2000, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html