Filters

Als u wilt dat bepaalde gedeelten van uw document alleen in een bepaalde context worden weergegeven, gebruikt u de filtermarkup om op te geven aan welke criteria moet worden voldaan voordat het betreffende gedeelte wordt afgebeeld. Als niet aan de criteria wordt voldaan, is dat gedeelte van het document niet zichtbaar voor de gebruiker. U kunt voor elk XML-element filters opgeven, zolang de markup nog steeds geldig is na verwerking. Als u een filter op een element toepast, wordt datzelfde filter ook toegepast op alle onderliggende elementen en teksten van dat element.

In de onderstaande vindt u een compleet overzicht van alle filtereigenschappen en hun mogelijke waarden.

Eigenschap Betekenis Mogelijke waarden
os besturingssysteem win32, win32, linux, macosx, aix, solaris, hpux, qnx
ws venstersysteem win32, motif, gtk, photon, carbon
arch processorarchitectuur x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
product Eclipse-product-ID Product-ID (voor de SDK is dit bijvoorbeeld org.eclipse.sdk.ide)
plugin plugin-ID Plugin-ID (bijvoorbeeld org.eclipse.help)
category activiteitencategorie Activiteitencategorie-ID (voor de categorie Team is dit bijvoorbeeld org.eclipse.categories.teamCategory)
activity activiteit (voorziening) Activiteit-ID (voor CVS-ondersteuning is dit bijvoorbeeld org.eclipse.team.cvs)

Als de naam niet overeenkomt met een vooraf gedefinieerde eigenschap, wordt door het Help-systeem de JVM-systeemeigenschap van die naam gebruikt. U kunt bijvoorbeeld bij het opstarten een willekeurige eigenschap definiėren, zoals -Dlocation=amsterdam,nederland, en op die eigenschap filteren.

U kunt op twee manieren filters voor een element opgeven: met filterkenmerken of met filterelementen.

Filterkenmerk

De eerste manier is een filterkenmerk aan het element toe te voegen. De algemene vorm hiervoor is:

   <element filter="[naam][operator][waarde]">
      Willekeurige tekst.
   </element>

De naam is de naam van de eigenschap waarop moet worden gefilterd, bijvoorbeeld os voor het besturingssysteem. De operator is ofwel = om een overeenkomst (exacte overeenkomst, hoofdlettergevoelig) aan te duiden, ofwel != om juist geen overeenkomst aan te duiden. De waarde is de waarde waarmee de eigenschap al dan niet moet overeenkomen. Zo is win32 (Windows) een mogelijke waarde voor os. In de onderstaande tabel vindt u een compleet overzicht van alle filtereigenschappen en hun mogelijke waarden.

In het volgende voorbeeld ziet u hoe u ervoor kunt zorgen dat een alinea tekst in een XHTML-document alleen wordt weergegeven op een Linux-systeem.

   <p filter="os=linux">
      Dit bericht wordt alleen weergegeven op een Linux-systeem.
   </p>

In dit tweede voorbeeld wordt een link alleen weergegeven als de plugin com.my.plugin niet is geļnstalleerd:

   <a href="..." filter="plugin!=com.my.plugin">
      Klik hier om de plugin com.my.plugin te downloaden.
   </a>

Filterelement

De tweede manier is een filterelement te gebruiken als onderliggend element van het element dat u wilt filteren. De syntaxis hiervoor is iets langer dan die voor een filterkenmerk, maar biedt meer mogelijkheden omdat u elk gewenst aantal filters voor een element kunt opgeven. De algemene vorm hiervoor is:

   <element attribute="value">
      <filter name="[naam]" value="[parameter][waarde]"/>
   </element>

De naam en waarde zijn hier hetzelfde als bij het kenmerk. Maar omdat ze gescheiden zijn, moet op een andere manier worden opgegeven of de naam en de waarde moeten overeenkomen of niet. Als u geen parameter opgeeft, wordt deze standaard geļnterpreteerd als overeenkomst. Als dit geen overeenkomst moet zijn, stelt u de parameter in op "!. "

Hieronder ziet u het eerste voorbeeld nogmaals, maar dan in de tweede vorm:

   <p>
      <filter name="os" value="linux"/>
      Dit bericht wordt alleen weergegeven op een Linux-systeem.
   </p>

En het tweede voorbeeld:

   <a href="...">
      <filter name="plugin" value="!com.my.plugin"/>
      Klik hier om de plugin com.my.plugin te downloaden.
   </a>

Informatiecentrum

De ondersteuning voor filters wordt uitgeschakeld als u Help uitvoert in de werkstand Informatiecentrum zodat alle content, inclusief gefilterde content, zichtbaar is. Als u van plan bent om uw documentatie zowel in de workbench- als de informatiecentrumwerkstand te hosten, dient u de filters zodanig te definiėren dat deze ook een logisch geheel opleveren als ze uitgeschakeld worden.

Waar kan ik filters gebruiken?

Filters kunnen worden gebruikt in de volgende typen documenten:

* Opmerking: u moet een aantal extra stappen uitvoeren om dynamische content in XHTML-documenten mogelijk te maken.

U dient in elk geval geen filters te definiėren voor elementen waarbij verwijdering van dat element zou resulteren in ongeldige XML. U mag bijvoorbeeld geen filter instellen voor het element html in XHTML, omdat het element anders geen geldige XHTML meer zou zijn.