Hjälpinnehållsproducent
ID:
org.eclipse.help.contentProducer
Sedan:
3.0
Beskrivning:
För att tillhandahålla dynamiskt hjälpinnehåll som genereras under körning. Innehållsproducenter registreras per insticksprogram och fungerar endast inom omfånget för insticksprogrammet. Om du vill återanvända en innehållsproducent i ett annat insticksprogram bör du använda elementet binding
. Med den här strategin förhindras insticksprogram från att "kapa" innehållsproduktion för alla insticksprogram. Genom att binda ett insticksprogram till en innehållsproducent får innehållsproducenten behörighet att kontrollera innehållsproduktion för alla dokument i det aktuella insticksprogrammet.
Konfigurationsmärkordsuppsättning:
<!ELEMENT extension (contentProducer | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - implementeringsklass för hjälpinnehållsproducenten. Den hör klassen måste implementera gränssnittet org.eclipse.help.IHelpContentProducer. Det här attributet kan utelämnas och det kapslade elementet producer kan användas i stället.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - implementeringsklassen för hjälpinnehållsproducenten. Den hör klassen måste implementera gränssnittet org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - namnet på en parameter som skickas till implementeringsklassen
- value - värdet för en parameter som skickas till implementeringsklassen
<!ELEMENT binding EMPTY>
<!ATTLIST binding
producerId CDATA #REQUIRED>
- producerId - ett unikt namn på en innehållsproducent som definierats någon annanstans med hjälp av elementet contentProducer. När bindning används kan ett insticksprogram återanvända en innehållsproducent som registrerats i ett annat insticksprogram i stället för att definiera en egen.
Exempel:
Följande är en exempelanvändning av utökningspunkten för innehållsproducenter:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"Mitt dynamiska hjälpinnehåll"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
API-information:
den tillhandahållna innehållsproducerarklassen måste implementera gränssnittet org.eclipse.help.IHelpContentProducer.
Producenten ansvarar för att tillhandahålla innehåll för dynamiska hjälpresurser från ett insticksprogram. Metoden för innehållsproducenten anropas av hjälpen för varje hjälpresurs som inhämtas från insticksprogrammet.
Medföljande implementering:
Ingen. Om ett dokumentationsinsticksprgram inte tillhandahåller hjälpinnehållsproducent eller ett anrop till det resulterar i null, söker hjälpsystemet i doc.zip och filsystemet på insticksprogrammets installationsplats efter ett statiskt dokument och visar dess innehåll.
Copyright (c) 2000, 2006 IBM Corporation and others.
All Rights Reserved. Detta program och medföljande material tillhandahålls under villkoren för Eclipse Public License v1.0 som medföljer denna distribution och finns tillgänglig på
http://www.eclipse.org/legal/epl-v10.html