Szűrők

Ha a dokumentum bizonyos részeinek csak adott kontextusban szabad megjelenniük, akkor szűrő leírónyelvet használhat azon feltétel megadásához, amelynek teljesülnie kell a dokumentumrész megjelenítéséhez. Ha a feltétel nem teljesül, akkor a dokumentum ezen része a felhasználó számára nem lesz látható. Szűrők tetszőleges XML elemhez megadhatók, amíg a leírónyelv a feldolgozás után érvényes marad. Egy elem szűrése esetén az elem alatt található minden elem és szöveg szintén szűrésre kerül.

Az alábbi tábla a szűrőtulajdonságok és lehetséges értékeik teljes listáját tartalmazza.

Tulajdonság Jelentés Lehetséges értékek
os operációs rendszer win32, win32, linux, macosx, aix, solaris, hpux, qnx
ws ablakkezelő rendszer win32, motif, gtk, photon, carbon
arch processzorarchitektúra x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
product eclipse termékazonosító Tetszőleges termékazonosító (SDK esetén például org.eclipse.sdk.ide)
plugin bedolgozó jelenlét Tetszőleges bedolgozóazonosító (például org.eclipse.help)
category tevékenységkategória Tevékenységkategória azonosítója (Munkacsoport kategória esetén például org.eclipse.categories.teamCategory)
activity tevékenység (képesség) Tetszőleges tevékenységazonosító (CVS támogatási tevékenység esetén például org.eclipse.team.cvs)

Ha a név egyik előre meghatározott tulajdonságnak sem felel meg, akkor a súgórendszer a JVM ezen nevű rendszertulajdonságát használja. Indításkor például tetszőleges felhasználó által megadott tulajdonságot átadhat, mint például a -Dlocation=paris,france, és szűrheti ezzel a tulajdonsággal.

Egy elemen kétféleképp adható meg szűrő: attribútumok vagy elemek segítségével.

Szűrő attribútum

Az elemhez adandó első forma a filter attribútum. Az általános forma:

   <element filter="[name][operator][value]">
      Szöveg.
   </element>

A name a tulajdonság neve, amely alapján a szűrés történik, operációs rendszer esetén például os. Az operator egyezés esetén = (pontos egyezés, kis- és nagybetűk eltérőnek számítanak), vagy != nem egyezés jelzéséhez. A value az az érték, amelynek a tulajdonságnak meg kell felelnie (vagy nem). os esetén például az egyik lehetséges érték a win32 (Windows). A szűrőtulajdonságok és értékeik teljes listája az alábbi táblázatban található.

Az alábbi példa megmutatja, hogy hogyan jelenjen meg a szöveg egy bekezdése egy XHTML dokumentumban csak Linux rendszeren futtatás esetén.

   <p filter="os=linux">
Ez az üzenet csak Linux rendszeren jelenik meg.
   </p>

A második példában a hivatkozás csak akkor jelenik meg, ha a com.my.plugin bedolgozó nincs telepítve:

   <a href="..." filter="plugin!=com.my.plugin">
      Kattintson ide a com.my.plugin letöltéséhez.
   </a>

Szűrőelem

A második használandó forma egy filter elem, amely a szűrni kívánt elem leszármazottja. Ez a forma kicsit hosszabb, mint az attribútum forma, de hatékonyabb, mivel egy elemhez tetszőleges számú szűrő megadható. Az általános forma:

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

A name és value ugyanaz, mint attribútum esetén. De mivel ezek külön vannak választva, másképp kell megadni, hogy egyeznie kell-e vagy sem. Alapértelmezésben ha nem ad meg modifier értéket, akkor a rendszer egyezést feltételez. Ha nem szabad egyeznie, akkor állítsa a módosítót "! értékre "

Itt a fenti példa második formája látható:

   <p>
      <filter name="os" value="linux"/>
Ez az üzenet csak Linux rendszeren jelenik meg.
   </p>

És a második példa:

   <a href="...">
      <filter name="plugin" value="!com.my.plugin"/>
      Kattintson ide a com.my.plugin letöltéséhez.
   </a>

Információs központ

A szűrés támogatás kikapcsolt állapotban van Információs központ mód esetén a súgó futása alatt, ezáltal minden tartalom, beleértve a szűrtet is, láthatóvá válik. Ha a munkaterület és az információs központ módban egyaránt birtokolni szeretné a dokumentációt, akkor úgy használja a szűrőket, hogy a szűrés kikapcsolt állapotában is képesek legyenek érzékelni.

Hol használhatók szűrők?

Szűrés a következő dokumentumtípusokban használható:

* Megjegyzés: Néhány extra lépés szükséges XHTML dokumentumokban a dinamikus tartalom engedélyezéséhez.

Nem lehet szűrőket adni olyan elemekhez, amelyek eltávolítása érvénytelen XML-t eredményez. Például nem adható meg szűrő az XHTML html eleméhez, mivel ezen elem nélkül az XHTML nem érvényes.