Indeks słów kluczowych

org.eclipse.help.index

3.2

Opisywany punkt rozszerzenia służy do rejestrowania indeksu słów kluczowych w odniesieniu do wnoszonej treści pomocy.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


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

(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.

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

Domyślna implementacja interfejsu użytkownika systemu pomocy dostarczona wraz z platformą Eclipse zapewnia pełną obsługę punktu rozszerzenia index.