Rozszerzenie treści pomocy

org.eclipse.help.contentExtension

Opisywany punkt rozszerzenia służy do obsługi treści dynamicznej i treści nadającej się do ponownego wykorzystania na stronach systemu pomocy. Umożliwia on wnoszenie treści na dotychczasowe strony systemu pomocy. W ramach dowolnej strony XHTML w systemie pomocy można umieścić deklarację zezwalającą na umieszczanie na niej wnoszonej treści, określając punkty wnoszenia za pomocą elementu anchor. Następnie podczas pracy w środowisku wykonawczym można umieszczać w dokumentach fragmenty kodu XHTML.

<!ELEMENT extension (contentExtension+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentExtension EMPTY>

<!ATTLIST contentExtension

file CDATA #REQUIRED>

Element ten służy do definiowania rozszerzenia treści w odniesieniu do jednej lub kilku stron w systemie pomocy. Położenie pliku rozszerzenia treści określa się za pomocą atrybutu file.



Poniżej przedstawiono przykład zastosowania punktu rozszerzenia contentExtension.

(w pliku plugin.xml)

 

<extension point=

"org.eclipse.help.contentExtension"

>

<contentExtension file=

"contentExtensionFile.xml"

/>

</extension>

(w pliku contentExtensionFile.xml)

<contentExtension>

<topicExtension content=

"xhtml/topicA.xhtml"

path=

"org.xxx.yyy.somePluginId/xhtml/someHelpPage.xhtml/topicAnchor"

/>

</contentExtension>

Powyższy element wnoszony pozwala wstawić treść pliku XHTML pod nazwą topicA.xhtml na stronie docelowej systemu pomocy określonej za pomocą atrybutu path. W tym przypadku rozszerzenie treści jest wstawiane w miejscu zakotwiczenia pod nazwą topicAnchor na stronie someHelpPage.xhtml we wtyczce org.xxx.yyy.somePluginId.

Powyższy element wnoszony pozwala wstawić treść pliku XHTML pod nazwą topicA.xhtml na stronie docelowej systemu pomocy określonej za pomocą atrybutu path. W tym przypadku rozszerzenie treści jest wstawiane w miejscu zakotwiczenia pod nazwą topicAnchor na stronie someHelpPage.xhtml we wtyczce org.xxx.yyy.somePluginId.

Do korzystania z tego punktu rozszerzenia nie jest potrzebny żaden kod. Wystarczy jedynie dostarczyć odpowiednie pliki treści wymienione w pliku plugin.xml.

Domyślna implementacja podstawowego systemu pomocy dostarczana wraz z platformą Eclipse zapewnia pełną obsługę punktu rozszerzenia contentExtension.