Producent treści pomocy
Identyfikator:
org.eclipse.help.contentProducer
Dostępne od wersji:
3.0
Opis:
Punkt rozszerzenia służący do udostępniania dynamicznej
treści pomocy generowanej w czasie wykonywania.
Znaczniki konfiguracji:
<!ELEMENT extension (contentProducer?)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA
#IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentProducer (producer)>
<!ATTLIST contentProducer
producer CDATA #IMPLIED>
- producer - klasa implementacji dla producenta treści pomocy. Klasa
ta musi implementować interfejs
org.eclipse.help.IHelpContentProducer. Istnieje możliwość
pominięcia tego atrybutu i posłużenia się w zamian zagnieżdżonym elementem
producer.
<!ELEMENT producer (parameter*)>
<!ATTLIST producer
class CDATA #REQUIRED>
- class - klasa implementacji dla producenta treści pomocy. Klasa ta
musi implementować interfejs
org.eclipse.help.IHelpContentProducer.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - nazwa parametru przekazywana do klasy implementacji.
- value - wartość parametru przekazywana do klasy implementacji.
Przykłady:
Oto przykładowe użycie punktu rozszerzenia
przeglądarki:
<extension point=
"org.eclipse.help.contentProducer"
id=
"org.eclipse.myPlugin.myDynamicHelpProducer"
name=
"My Dynamic Help Content"
>
<contentProducer producer=
"org.eclipse.myPlugin.myPackage.Myproducer"
/>
</extension>
Informacje o interfejsie API:
Dostarczana klasa producenta treści
musi implementować interfejs
org.eclipse.help.IHelpContentProducer. Producent odpowiada za
udostępnianie treści na potrzeby dynamicznych zasobów pomocy z modułu
dodatkowego. Metoda producenta pomocy jest wywoływana przez system pomocy dla
każdego zasobu pomocy uzyskanego z danego modułu dodatkowego.
Dostarczana implementacja:
Brak. Jeśli moduł dodatkowy
dokumentacji nie udostępnia producenta treści pomocy albo odwołanie do jego
wyników ma wartość null, system pomocy przeszukuje plik doc.zip oraz system
plików w położeniu instalacyjnym modułu dodatkowego w celu znalezienia
dokumentu statycznego - po znalezieniu tego pliku wyświetla jego treść.
Copyright (c) 2000, 2003 IBM Corporation i inne podmioty.
Wszelkie prawa zastrzeżone. Program ten oraz towarzyszące mu materiały są udostępniane na warunkach licencji EPL (Eclipse Public License), wersja 1.0, dołączonej do nich i dostępnej pod adresem http://www.eclipse.org/legal/epl-v10.html.