<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Znaczniki konfiguracji pliku indeksu:
<!ELEMENT index (entry)* >
<!ELEMENT entry (entry | topic)* >
<!ATTLIST entry keyword CDATA #REQUIRED >
<!ELEMENT topic EMPTY >
<!ATTLIST topic href CDATA #REQUIRED >
<!ATTLIST topic title CDATA #IMPLIED >
Element index (indeks)
Element index odnosi się do instancji indeksu. Indeks składa się z wpisów, z których każdy odpowiada konkretnemu słowu kluczowemu. Wszystkie wnoszone indeksy są scalane w jeden indeks nadrzędny, który jest udostępniany użytkownikowi w systemie pomocy. Po zbudowaniu indeksu wpisy dodaje się w kolejności alfabetycznej.
Element entry (wpis)
Element entry odnosi się do słowa kluczowego w indeksie. Każdy wpis może zawierać kilka odsyłaczy do tematów pomocy powiązanych z danym słowem kluczowym. Ponadto wpis może pełnić rolę kontenera, w którym przechowywane są inne wpisy (wpisy podrzędne), umożliwiając tym samym tworzenie hierarchii słów kluczowych. Wpis może jednocześnie zawierać wpisy podrzędne (jako kontener) oraz tematy.
Element topic (temat)
Element topic stanowi odwołanie do treści pomocy związanej z danym słowem kluczowym. Atrybut href jest względny wobec wtyczki, do której należy plik manifestu. Aby uzyskać dostęp do pliku w innej wtyczce, należy skorzystać z następującej składni:
<topic label="Temat w innej wtyczce" href="../other.plugin.id/concepts/some_other_file.html"/>
Atrybut title (tytuł) służy do nadawania nazwy odsyłaczowi do treści pomocy w przypadku, gdy z jednym słowem kluczowym powiązanych jest kilka tematów. Jeśli atrybut nie zostanie określony, tytuł uzyskiwany jest ze spisu treści, do którego należy odsyłacz. Jeśli odsyłacz nie należy do żadnego spisu treści, atrybut title należy określić samodzielnie. W przeciwnym razie pozostanie on niezdefiniowany.
(w pliku plugin.xml)
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
(w pliku index.xml)
<index>
<entry keyword="Pojazd">
<topic href="inventory_of_wheel.html"/>
<entry keyword="Samochód">
<topic href="car.html"/>
</entry>
<entry keyword="Statek">
<topic href="ship.html"/>
</entry>
<entry keyword="Samolot">
<topic href="airplane.html" title="Historia lotnictwa"/>
<topic href="jet.html" title="Silnik odrzutowy"/>
</entry>
</entry>
<entry keyword="Silnik">
<entry keyword="Koń">
<topic href="horse.html"/>
</entry>
<entry keyword="Parowiec">
<topic href="steamer.html"/>
</entry>
<entry keyword="Silnik Wankla">
<topic href="wankel.html"/>
</entry>
<entry keyword="Silnik odrzutowy">
<topic href="jet.html"/>
</entry>
</entry>
<entry keyword="Elektryczność">
<topic href="electricity.html"/>
</entry>
</index>
Obsługa wersji narodowych Pliki XML indeksu można tłumaczyć, a powstałe w ten sposób kopie (zawierające przetłumaczone słowa kluczowe) należy umieszczać w katalogu nl/<język>/<kraj> lub nl/<język>. Elementy <język> i <kraj> odpowiadają dwuliterowym kodom języków i krajów stosowanym w oznaczeniach ustawień narodowych. Na przykład tłumaczenia na język chiński tradycyjny należy umieścić w katalogu nl/zh/TW. Katalog nl/<język>/<kraj> ma wyższy priorytet niż katalog nl/<język>. Plik znajdujący się w katalogu nl/<język> jest wykorzystywany wyłącznie wtedy, gdy w katalogu nl/<język>/<kraj> nie zostanie znaleziony żaden plik. Katalog główny wtyczki jest przeszukiwany na końcu.
Copyright (c) 2006 Intel 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.