Filter

Om vissa avsnitt i dokumentet endast ska visas i ett visst sammanhang kan du använda filtreringsmärkord till att ange de villkor som måste uppfyllas för att avsnittet i dokumentet ska visas. Om villkoren inte uppfylls visas inte avsnittet för användaren. Filter kan anges för valfritt XML-element så länge märkorden är giltiga efter bearbetning. Om ett element filtreras även alla element och all text som ingår i elementet.

I tabellen nedan visas en fullständig lista med filteregenskaper och möjliga värden för dem.

Egenskap Innebörd Möjliga värden
os operativsystem win32, win32, linux, macosx, aix, solaris, hpux, qnx
ws fönstersystem win32, motif, gtk, photon, carbon
arch processorarkitektur x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
product id för eclipse-produkt Produkt-ID (till exempel org.eclipse.sdk.ide för SDK)
plugin aktuellt insticksprogram ID för insticksprogram (till exempel org.eclipse.help)
category kategori för aktiviteter ID för aktivitetskategori (till exempel org.eclipse.categories.teamCategory för gruppkategori)
activity aktivitet (funktioner) Aktivitets-ID (till exempel org.eclipse.team.cvs för CVS-funktionsaktivitet)

Om namnet inte överensstämmer med någon fördefinierad egenskap används JVM-systemegenskapen för namnet. Du kan till exempel överföra valfri användardefinierad egenskap vid start, till exempel -Dlocation=paris,france, och filtrera efter den egenskapen.

Du kan ange filter för ett element på två sätt; med hjälp av attribut eller element.

Filterattribut

Den första sättet är att lägga till attributet filter till elementet. Den allmänna formen ser ut på följande sätt:

   <element filter="[namn][operator][värde]">
      Text.
   </element>

namn är namnet på den egenskap som filtreringen ska göras efter, till exempel os för operativsystem. operator är antingen = som anger matchning (exakt, skiftlägeskänslig matchning) eller != som anger ingen matchning. värde är vad egenskapen ska (eller inte ska) överensstämma med. Till exempel för os är ett möjligt värde win32 (Windows). En fullständig lista med filteregenskaper och värden för dem finns i tabellen nedan.

I exemplet nedan visas hur du visar ett textstycke i ett XHTML-dokument när du endast kör Linux.

   <p filter="os=linux">
      Det här meddelandet visas endast i Linux.
   </p>

I det här andra exemplet visas länken endast när insticksprogrammet com.my.plugin inte är installerat:

   <a href="..." filter="plugin!=com.my.plugin">
      Klicka här om du vill hämta insticksprogrammet com.my.plugin.
   </a>

Filterelement

Det andra sättet är att använda ett filter-element som ett underordnat element till det element du vill filtrera. Den här formen är något längre än attributformen men den är kraftfullare eftersom du kan ange valfritt antal filter för ett element. Den allmänna formen ser ut på följande sätt:

   <element attribute="value">
      <filter name="[namn]" value="[modifierare][värde]"/>
   </element>

namn och värde har här samma innebörd som för attributet. Men eftersom de är separerade behöver vi ett annat sätt att ange om de ska överensstämma. Som standard, om du inte anger en modifierare, förusätts att de överensstämmer. Om de inte ska överensstämma ger du modifieraren värdet ! "

Här är det första exemplet ovan i den andra formen:

   <p>
      <filter name="os" value="linux"/>
      Det här meddelandet visas endast i Linux.
   </p>

Och det andra exemplet:

   <a href="...">
      <filter name="plugin" value="!com.my.plugin"/>
      Klicka här om du vill hämta insticksprogrammet com.my.plugin.
   </a>

Infocenter

Funktioner för filtrering är avaktiverade när hjälp körs i läget infocenter, vilket innebär att allt innehåll, inklusive filtrerat innehåll, visas. Om du vill att din dokumentation ska vara tillgänglig i både arbetsmiljö- och infocenterlägena bör du använda filter på ett sätt så att visningen blir logisk även när filtrering är avaktiverat.

Var kan jag använda filter?

Filtrering kan användas i följande typer av dokument:

*Obs! Det krävs några extra åtgärder för att aktivera dynamiskt innehåll i XHTML-dokument.

Placera inte filter för element där det leder till ogiltig XML-kod om elementet tas bort. Placera till exempel inte ett filter för html-elementet i XHTML eftersom utan det elementet är XHTML inte längre giltig.