Systémové předvolby nápovědy

Systém nápovědy platformy Eclipse lze konfigurovat a označit za účelem přizpůsobení vašemu produktu zadáním uživatelského výchozího nastavení řady předvoleb nápovědy.

Samotný systém nápovědy je rozdělen do určitého počtu samostatných modulů plug-in. Následující tabulky uvádějí dostupné předvolby včetně modulů plug-in, které tyto předvolby definují.  Informace o potlačení některých z těchto předvoleb viz Přizpůsobení produktu.
 

modul plug-in org.eclipse.help:

Klíč předvolby Použití
Výchozí
baseTOCS Řazení obsahu.  Seřazený seznam obsahu nápovědy (knih) uspořádaný tak, jak se má zobrazit v přihrádce. Všechny další obsahy (TOC) budou zařazeny za tyto knihy. Obsah, který není uveden v tomto seznamu, bude ignorován. Použijte umístění jednotlivého obsahu jako /idModuluPlugin/cesta/k/toc.xml. /org.eclipse.platform.doc.user/toc.xml,
/org.eclipse.jdt.doc.user/toc.xml,
/org.eclipse.platform.doc.isv/toc.xml,
/org.eclipse.jdt.doc.isv/toc.xml,
/org.eclipse.pde.doc.user/toc.xml
ignoredTOCS Znepřístupnění obsahů.  Seznam obsahů (knih) nápovědy, které budou systémem nápovědy ignorovány. Znepřístupněný obsah se nebude objevovat v seznamu knih a nelze jej propojit. Hesla nápovědy definovaná ve znepřístupněném obsahu nebudou k dispozici pro prohledávání. Obsah, který není uveden v tomto seznamu, bude ignorován. Použijte umístění jednotlivého obsahu jako /idModuluPlugin/cesta/k/toc.xml.

Modul plug-in org.eclipse.help.base:

Klíč předvolby Použití
Výchozí
banner Umístění stránky s nápisem, která má být zobrazena v horním rámci.
Příklad: banner=/org.eclipse.help.webapp/advanced/banner.html

banner_height Výška rámce nápisu
Příklad: banner_height=60

help_home Stránka, která se má při otevření nápovědy zobrazit v oblasti obsahu. Zadejte svou stránku html jako /idModuluPlugin/cesta/k/home.html. /org.eclipse.help.base/doc/help_home.html
linksView Nastavením hodnoty true nebo false ovládáte viditelnost pohledu souvisejících odkazů.
Poznámka: Tato volba nepracuje v modulu InfoCenter.
true
bookmarksView Nastavením hodnoty true nebo false ovládáte viditelnost pohledu Záložky.
Poznámka: Tato volba nepracuje v modulu InfoCenter.
true
windowTitlePrefix Nastavením hodnoty true nebo false ovládáte titulek okna prohlížeče. Je-li nastavena hodnota true, bude mít titulek formu "Nápověda - <NÁZEV_PRODUKTU>", v opačném případě bude titulek "<NÁZEV_PRODUKTU>", kde <NÁZEV_PRODUKTU> je názvem produktu Eclipse nastavený v primární funkci. true
loadBookAtOnceLimit Maximální počet témat, jež kniha může mít, pro navigaci načítanou prohlížečem jako jediný dokument. Navigace větších knih se načítá dynamicky, tj. vždy zároveň pouze několik úrovní. Další hesla se načtou dle potřeby při rozbalení větví. 1000
dynamicLoadDepthsHint Navržený počet úrovní v navigaci tématu načítaný prohlížečem pro velké knihy. Hodnota musí být větší než 0. Skutečný počet úrovní se může odlišovat v rozsáhlých stromech, pokud navržený počet úrovní obsahuje velký počet témat.
3
imagesDirectory Adresář obsahující obrázky používané v pohledu nápovědy. Obrázky musejí mít název shodný s názvem obrázků v modulu plug-in org.eclipse.help.webapp. Použijte formát /idModuluPlugin/adresář. obrázky
advanced.toolbarBackground Pozadí CSS pro panely nástrojů. Tuto hodnotu používají prohlížeče, které zobrazují rozšířené uživatelské rozhraní nápovědy. ButtonFace
advanced.viewBackground Pozadí CSS navigačních pohledů. Tuto hodnotu používají prohlížeče, které zobrazují rozšířené uživatelské rozhraní nápovědy. Okno
advanced.toolbarFont Písmo CSS pro panely nástrojů. Tuto hodnotu používají prohlížeče, které zobrazují rozšířené uživatelské rozhraní nápovědy. ikona
advanced.viewFont Písmo CSS pro navigační pohledy. Tuto hodnotu používají prohlížeče, které zobrazují rozšířené uživatelské rozhraní nápovědy. ikona
basic.toolbarBackground Barva pozadí panelů nástrojů. Tuto hodnotu používají prohlížeče, které zobrazují základní uživatelské rozhraní nápovědy. #D4D0C8
basic.viewBackground Barva pozadí pro navigační pohledy. Tuto hodnotu používají prohlížeče, které zobrazují základní uživatelské rozhraní nápovědy. #FFFFFF
locales Seznam národních prostředí, které modul InfoCenter rozpoznává a pro které poskytuje přizpůsobený obsah; pokud se národní prostředí (nebo jazyky) akceptované prohlížečem klienta neshodují s žádným národním prostředím v seznamu, prohlížeč obdrží obsah pro výchozí národní prostředí - tj. pro národní prostředí serveru nebo národní prostředí zadané volbou příkazového řádku eclipse -nl; není-li seznam zadán, prohlížeč obdrží obsah určený pro jím upřednostněné národní prostředí; poznámka: neposkytnete-li tuto volbu, může dojít k výraznému vzrůstu nároků na paměť a diskový prostor, protože dojde k vytvoření navigací a rejstříků pro jednotlivá národní prostředí upřednostňovaná prohlížeči, které přistupují k modulu InfoCenter.
Příklad: locales=en ja zh_CN zh_TW

productIndex Je-li s produktem poskytnut předem sestavený rejstřík dokumentace k celému produktu, je zapotřebí zde pro systém nápovědy zadat ID modulu plug-in, který rejstřík poskytuje.
always_external_browser
Použití vloženého prohlížeče, kde je to možné (Windows nebo Linux) nebo trvalé používání externího prohlížeče.  Nastavení hodnoty true vynucuje použití externího prohlížeče.  Volba nemá žádný účinek, pokud na dané platformě není k dispozici vložený prohlížeč.
false
default_browser

Výchozí externí prohlížeč.  ID některého z externích webových prohlížečů zadané v bodu rozšíření org.eclipse.help.base.browser. Systém nápovědy bude používat tento externí prohlížeč. Metoda adaptéru prohlížeče available() musí na použitém systému vracet hodnotu true.

Tato předvolba řídí externí webové prohlížeče v samostatném režimu Nápověda. V režimu modulu Workbench používá nápověda prohlížeče poskytované podporou prohlížeče modulu Workbench.

Při výchozím nastavení se nastavuje dynamicky na prohlížeč dostupný v daném systému.
custom_browser_path

Spustitelná cesta pro vlastní prohlížeč.

Tato předvolba řídí externí webové prohlížeče v samostatném režimu Nápověda. V režimu modulu Workbench používá nápověda prohlížeče poskytované podporou prohlížeče modulu Workbench.

C:\Program Files\Internet Explorer\IEXPLORE.EXE" %1 - ve Windows,
"konqueror %1" - na systému Linux
"mozilla %1" - na ostatních platformách
showDisabledActivityTopics Systém nápovědy odděluje zobrazení hesel neaktivních funkcí.  Tato volba ovládá uvedené chování a existenci tlačítka  Zobrazit všechna témata.
Povolené hodnoty: never, off, on, always
 never - Hesla deaktivovaných funkcí se nezobrazují.
 off - Uživatel může zvolit zobrazení všech témat, na počátku jsou témata znepřístupněných funkcí skryta.
 on - Uživatel může zvolit zobrazení všech témat, na počátku se zobrazují všechna témata.
 always - Zobrazují se témata znepřístupněných funkcí (filtrování je vypnuté).
off
activeHelp Umožňuje zpřístupnění a znepřístupnění provedení aktivní nápovědy. Volba se neuplatní, pokud je v modulu InfoCenter aktivní nápověda znepřístupněna.
Přijatelné hodnoty:
 true - Výchozí akce aktivní nápovědy jsou zpřístupněny.
 false - Infrastruktura aktivní nápovědy je znepřístupněna.
true
window_infopop Umožňuje zpřístupnění rozevíracích informačních oken staršího stylu při stisknutí klávesy nápovědy (Help) v oknech pracovního plochy. Pokud má hodnotu false, otevře se namísto toho nový pohled dynamické nápovědy. false
dialog_infopop
Umožňuje zpřístupnění rozevíracích informačních oken staršího stylu při stisku klávesy Help v dialogových oknech. Pokud má hodnotu false, otevře se namísto toho nové okno dynamické nápovědy.
false

Modul plug-in org.eclipse.help.appserver:

Klíč předvolby Použití
Výchozí
port Číslo portu, na kterém server očekává požadavky http. Pokud port není zadán, systém zvolí libovolný port.  
host

Adresa nebo název hostitele pro účely připojení k serveru. Výchozí hodnota je prázdná, Eclipse vyhledá dostupnou lokální adresu.

Produkty používající nápovědu v lokálním režimu (workbench nebo samostatně, nikoli modul InfoCenter), mohou tuto předvolbu nastavit na "127.0.0.1", a tím zajistit, že server nápovědy bude chráněn před dalšími uživateli na síti.


Modul plug-in org.eclipse.tomcat:

Klíč předvolby Použití
Výchozí
acceptCount Maximální délka fronty příchozích požadavků na spojení, jsou-li v činnosti všechna vlákna zpracovávající požadavky. Požadavky obdržené po zaplnění fronty jsou odmítány. 100
maxProcessors
Maximální počet vláken zpracovávajících požadavky, která má vytvořit tento Konektor, jenž tímto způsobem určí maximální počet požadavků, které lze zároveň zpracovat.
75
minProcessors
Počet vláken zpracovávajících požadavky, která mají být vytvořena při prvním spuštění tohoto Konektoru. Tento atribut by měl mít hodnotu menší, než je hodnota atributu maxProcessors.
5