Dlaczego należy korzystać z języka XHTML?
System pomocy umożliwia tworzenie treści dynamicznej. Polega to na umieszczaniu w kodzie znaczników XHTML adnotacji zawierających specjalne znaczniki, które pozwalają filtrować, włączać lub zakotwiczać rozszerzenia. Opcje te nie są dostępne w języku HTML.
Jak wnosić elementy w języku XHTML?
Dokumenty pomocy w języku XHTML wnosi się podobnie jak dokumenty HTML. Występuje jednak kilka istotnych różnic, które pozwalają zapewnić obsługę treści dynamicznej i umożliwiają wyszukiwanie. Poniżej wymieniono wymagane modyfikacje.
Uczestnik wyszukiwania XHTML musi być powiązany z wtyczką dokumentacji.
W systemie pomocy wdrożonym na platformie Eclipse wykorzystuje się mechanizm Lucene, który umożliwia indeksowanie dokumentów w celu przyspieszenia wyszukiwania. Aby można było zaindeksować dokument, jego format musi być czytelny dla mechanizmu Lucene. Na platformie Eclipse jest już dostępny uczestnik wyszukiwania służący do indeksowania dokumentów XHTML, w związku z czym wystarczy skonfigurować system pomocy tak, aby korzystać z niego w odniesieniu do dokumentów użytkownika. W manifeście wtyczki należy dodać następujące rozszerzenie:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
W przypadku korzystania z treści dynamicznej narzędzie do tworzenia treści w języku XHTML musi być powiązane z wtyczką dokumentacji.
Aby tworzyć treść dynamiczną za pomocą adnotacji XML, należy skonfigurować system pomocy w taki sposób, aby były w nim przetwarzane dokumenty użytkownika. W tym celu należy powiązać narzędzie do tworzenia treści dynamicznej w języku XHTML z wtyczką.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Aby skorzystać w dokumentach XHTML z włączeń, należy zastosować następujący atrybut path
(opisany poniżej):
<identyfikator_wtyczki>/<ścieżka_do_pliku_xhtml>/<nazwa_pliku_xhtml>/<identyfikator_elementu>
gdzie:
org.eclipse.help
);/mój_folder/mój_podfolder/
);mój_plik.xhtml
);id
(np. mój.element.id
).
Na przykład aby włączyć akapit (element <p>
) o identyfikatorze prawa_autorskie
z pliku /copyrights/copyright.xhtml
we wtyczce wtyczka.mojego.produktu
, należy wpisać następujący tekst:
wtyczka.mojego.produktu/copyrights/copyright.xhtml/prawa_autorskie