Producent treści pomocy

org.eclipse.help.contentProducer

3.0

Punkt rozszerzenia służący do udostępniania dynamicznej treści pomocy generowanej w czasie wykonywania. Narzędzia do tworzenia treści rejestruje się w odniesieniu do wtyczek; działają one wyłącznie w obrębie danej wtyczki. Ponowne wykorzystanie narzędzia do tworzenia treści w innej wtyczce wymaga zastosowania elementu binding. Dzięki zastosowaniu tej metody wtyczki nie mogą przejmować zadania tworzenia treści w odniesieniu do wszystkich wtyczek. Utworzenie powiązania z narzędziem do tworzenia treści oznacza zezwolenie mu na sterowanie tworzeniem treści w odniesieniu do wszystkich dokumentów zawartych we wtyczce udzielającej takiego zezwolenia.

<!ELEMENT extension (contentProducer | binding)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

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


Poniżej przedstawiono przykład zastosowania punktu rozszerzenia narzędzia do tworzenia treści.

  

<extension point=

"org.eclipse.help.contentProducer"

id=

"org.eclipse.myPlugin.myDynamicHelpProducer"

name=

"My Dynamic Help Content"

>

<contentProducer producer=

"org.eclipse.myPlugin.myPackage.Myproducer"

/>

</extension>

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 wtyczki. Metoda producenta pomocy jest wywoływana przez system pomocy dla każdego zasobu pomocy uzyskanego z danej wtyczki.

Brak. Jeśli wtyczka 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 wtyczki w celu znalezienia dokumentu statycznego - po znalezieniu tego pliku wyświetla jego treść.