Obsah

org.eclipse.help.toc

Pro registrování příspěvku online nápovědy pro individuální modul plug-in.

Z obecného hlediska by měl každý modul plug-in, který přispívá svými soubory nápovědy, dělat následující:

Vyhledávací rejstřík může být volitelně předem sestaven a zaregistrován pomocí prvku index, aby se zvýšila efektivita při prvním pokusu vyhledávání. Pro jeden modul plug-in lze zaregistrovat pouze jeden rejstřík - přítomnost více prvků index způsobí nedefinované chování.

<!ELEMENT extension (toc* , index?)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT toc EMPTY>

<!ATTLIST toc

file     CDATA #REQUIRED

primary  (true | false) "false"

extradir CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

(Od verze 3.1) volitelný prvek umožňující deklaraci předem sestaveného vyhledávacího rejstříku vytvořeného z dokumentů přidaných tímto modulem plug-in.



Následuje příklad použití bodu rozšíření obsahu.

(v souboru plugin.xml)

 

<extension point=

"org.eclipse.help.toc"

>

<toc file=

"maindocs.html"

primary=

"true"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(v souboru maindocs.xml)

<toc label="Příklad systému nápovědy">
 <topic label="Úvod" href="intro.html"/>
 <topic label="Úlohy">
  <topic label="Vytváření projektu" href="tasks/task1.html">
   <topic label="Vytváření webového projektu" href="tasks/task11.html"/>
   <topic label="Vytváření projektu Java" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Testování projektu" href="tasks/taskn.html"/>
 </topic>
 <topic label="Ukázky">
  <topic label="Vytváření projektu Java" href="samples/sample1.html">
   <topic label="Spustit průvodce" href="samples/sample11.html"/>
   <topic label="Nastavit volby" href="samples/sample12.html"/>
   <topic label="Dokončit vytvoření projektu" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(v souboru tasks.xml)

<toc label="Sestavení projektu">
 <topic label="Sestavení projektu" href="build/building.html">
  <topic label="Sestavení webového projektu" href="build/web.html"/>
  <topic label="Sestavení projektu Java" href="build/java.html"/>
 </topic>
</toc>


(v souboru samples.xml)

<toc link_to="maindocs.xml#samples" label="Použití kompilačního nástroje">
 <topic label="Ukázka kompilačního nástroje" href="compilesample/example.html">
  <topic label="Step 1" href="compilesample/step1.html"/>
  <topic label="Step 2" href="compilesample/step2.html"/>
  <topic label="Step 3" href="compilesample/step3.html"/>
  <topic label="Step 4" href="compilesample/step4.html"/>
 </topic>
</toc>

Za předpokladu, že existuje více dokumentů s cestou začínající "samples", nebudou tyto dokumenty zobrazeny v navigačním stromě, ale budou dostupné pomocí vyhledávání.  Důvodem je přítomnost atributu "extradir" v prvku <toc file="sample.xml" extradir="samples" /> uvnitř souboru plugin.xml . Například vyhledávání "Vytvoření projektu Java" může vrátit dokument "Jiné způsoby vytvoření projektu Java", jehož cesta je samples/sample2.html.

Internacionalizace Soubory s obsahem XML je možné přeložit a výsledná kopie (s přeloženými označeními) by měla být umístěna v adresáři nl/<jazyk>/<země> nebo nl/<jazyk>.  <Jazyk> a <země> představují dvoupísmenné kódy jazyka a země, jaké se používají v kódech národních prostředí.  Například překlady do tradiční čínštiny by měly být umístěny v adresáři nl/zh/TW.  Adresář nl/<jazyk>/<země> má vyšší prioritu než adresář nl/<jazyk>.  Pouze když nebude v adresáři nl/<jazyk>/<země> nalezen žádný soubor, použije se soubor umístěný v adresáři nl/<jazyk>.  Nakonec bude prohledán kořenový adresář modulu plug-in.

Dokumentaci obsaženou v doc.zip je možné lokalizovat vytvořením souboru doc.zip s přeloženou verzí dokumentů a tento doc.zip umístit do
adresáře nl/<jazyk>/<země> nebo nl/<jazyk>. Systém nápovědy bude hledat soubory nejprve v těchto adresářích a teprve potom přejde do adresáře modulů plug-in.
 

Pro použití tohoto bodu rozšíření není třeba žádný kód. Stačí jen dodat odpovídající soubory s manifestem uvedené v souboru plugin.xml.

Výchozí implementace uživatelského rozhraní systému nápovědy dodávaná s platformou Eclipse plně podporuje bod rozšíření obsahu.