Hjælp - indholdsproducent

org.eclipse.help.contentProducer

3.0

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.

<!ELEMENT extension (contentProducer | binding)>

<!ATTLIST-udvidelse

point CDATA #REQUIRED

id    CDATA #IMPLIED

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


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>

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.

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.