Filtry

Pokud chcete, aby se jisté oddíly vašeho dokumentu zobrazovaly pouze v rámci určitého kontextu, můžete pomocí markupu filtrování stanovit kritéria, jejichž splnění je podmínkou pro zobrazení daného oddílu dokumentu. Pokud nebudou zadané podmínky splněny, daný oddíl dokumentu se uživateli nezobrazí. Filtry lze specifikovat na prvku any XML za předpokladu, že markup bude platný i po zpracování. Pokud je prvek filtrován, budou filtrovány i veškeré prvky a všechen text obsažené v tomto prvku.

Níže uvedená tabulka obsahuje úplný seznam všech vlastností filtru a jejich možné hodnoty.

Vlastnost Význam Možné hodnoty
os operační systém win32, win32, linux, macosx, aix, solaris, hpux, qnx
ws systém oken win32, motif, gtk, photon, carbon
arch architektura procesoru x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
product identifikátor produktu eclipse Libovolný identifikátor produktu (např. pro SDK org.eclipse.sdk.ide)
plugin přítomnost modulu plug-in Libovolný identifikátor modulu plug-in (např. org.eclipse.help)
category kategorie aktivit Libovolný identifikátor kategorie aktivity (např. pro týmovou kategorii org.eclipse.categories.teamCategory)
activity aktivita (schopnost) Libovolný identifikátor aktivity (např. pro aktivitu podpory CVS org.eclipse.team.cvs)

Pokud název neodpovídá žádné předdefinované vlastnosti, systém nápovědy použije vlastnost systému JVM příslušného názvu. Můžete například zadat jakoukoli uživatelem definovanou vlastnost při spuštění, jako například -Dlocation=paris,france a filtrovat podle této vlastnosti.

Existují dva způsoby zadání filtrů na prvek; prostřednictvím atributů nebo prostřednictvím prvků.

Atribut Filter

Prvním způsobem je přidat atribut filter do prvku. Obecná forma je:

   <element filter="[name][operator][value]">
      Nějaký text.
   </element>

name je název vlastnosti, podle které se má filtrovat, například os pro operační systém. operator je buď = pro označení shody (přesná shoda, rozlišování malých a velkých písmen), nebo != pro označení neshody (rozdílu). value označuje, s čím by se vlastnost měla (nebo neměla) shodovat. Například pro parametr os je jednou z možných hodnot win32 (Windows). Úplný seznam vlastností filtru a jejich hodnot je k dispozici v níže uvedené tabulce.

Níže uvedený příklad znázorňuje, jak zobrazit odstavec textu v dokumentu XHTML při provozu pouze na systému Linux.

   <p filter="os=linux">
      Tato zpráva se zobrazí pouze při prohlížení v systému Linux.
   </p>

V tomto druhém příkladu se odkaz zobrazí pouze tehdy, pokud není nainstalován modul plug-in com.my.plugin:

   <a href="..." filter="plugin!=com.my.plugin">
      Pro stažení modulu plug-in com.my.plugin klepněte zde.
   </a>

Prvek Filter

Druhým způsobem je použít prvek filter jako podřízený prvek prvku, který chcete filtrovat. Tento způsob je o něco delší než použití atributu filter, ale je účinnější, protože můžete zadat libovolný počet filtrů v prvku. Obecná forma je:

   <element attribute="value">
      <filter name="[name]" value="[modifier][value]"/>
   </element>

name a value jsou stejné, jako v případě atributu filter. Jelikož jsou ale oddělené, je nutné použít jiný způsob určení případné shody či neshody. Ve výchozím nastavení, pokud neposkytnete modifier, bude předpokládána shoda. Pokud se nemají shodovat, nastavte modifikátor na "! "

Zde je první výše uvedený příklad ve druhé podobě:

   <p>
      <filter name="os" value="linux"/>
      Tato zpráva se zobrazí pouze při prohlížení v systému Linux.
   </p>

A druhý příklad:

   <a href="...">
      <filter name="plugin" value="!com.my.plugin"/>
      Pro stažení modulu plug-in com.my.plugin klepněte zde.
   </a>

Informační centrum

Podpora filtrování je při spuštění nápovědy v režimu Informačního centra vypnuta, čímž dojde k zobrazení veškerého obsahu, včetně obsahu filtrovaného. Pokud zamýšlíte používat dokumentaci v režimech pracovní plochy i Informačního centra, měli byste filtry použít způsobem, který dává smysl i při vypnutém filtrování.

Kde je možné použít filtry?

Filtrování lze použít v následujících typech dokumentů:

* Poznámka: Pro zpřístupnění dynamického obsahu v dokumentech XHTML je nutné provést několik dodatečných kroků.

V každém případě nesmíte umísťovat filtry na prvky, u kterých by odebrání prvku vedlo k neplatnému XML. Neměli byste například umístit filtr na prvek html v XHTML, protože bez tohoto prvku se již nejedná o platné XHTML.