Se determinate sezioni del documento devono essere visualizzate solo in un determinato contesto, è possibile utilizzare la markup di filtro per specificare i criteri che devono essere soddisfatti perché venga visualizzata la sezione del documento. Se i criteri non vengono soddisfatti, questa sezione del documento non sarà visibile all'utente. I filtri possono essere specificati su qualsiasi elemento XML sempre che la markup sia valida in seguito all'elaborazione. Se un elemento viene filtrato, verranno filtrati anche tutti gli elementi e il testo contenuto nell'elemento.
La tabella riportata di seguito contiene un elenco completo di tutte le proprietà dei filtri e i possibili valori.
Proprietà | Significato | Valori possibili |
os
|
sistema operativo (operating system) |
win32, win32, linux, macosx, aix, solaris, hpux, qnx
|
ws
|
sistema windowing (windowing system) |
win32, motif, gtk, photon, carbon
|
arch
|
architettura del processore |
x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
|
product
|
identificativo del prodotto eclipse |
Qualsiasi identificativo del prodotto (ad esempio, per SDK, org.eclipse.sdk.ide )
|
plugin
|
presenza dei plug-in |
Qualsiasi identificativo del plug-in (ad esempio, org.eclipse.help )
|
category
|
categoria di attività |
Qualsiasi identificativo di categoria di attività (ad esempio, per la categoria Team org.eclipse.categories.teamCategory )
|
activity
|
attività (capacità) |
Qualsiasi identificativo di attività (ad esempio, per l'attività Supporto CVS, org.eclipse.team.cvs )
|
Se il nome non corrisponde a una proprietà predefinita, il sistema della guida utilizzerà la proprietà di sistema JVM con quel nome. Ad esempio, è possibile inoltrare qualsiasi proprietà definita dall'utente all'avvio, ad esempio -Dlocation=paris,france
e filtrare in base a tale proprietà.
Esistono due modi per specificare i filtri su un elemento: mediante gli attributi o mediante gli elementi.
Il primo modo consiste nell'aggiungere un attributo filter
all'elemento. Il formato generale è:
<element filter="[name][operator][value]"> Testo. </element>
name
è il nome della proprietà mediante la quale applicare il filtro, ad esempio os
per il sistema operativo. operator
è =
per indicare una corrispondenza (corrispondenza esatta, sensibile al maiuscolo/minuscolo) o !=
per indicare una mancata corrispondenza. value
è il valore a cui la proprietà deve corrispondere. Ad esempio, per os
, uno dei valori possibili è win32
(Windows). Nella tabella riportata di seguito è riportato un elenco completo di proprietà di filtro e i relativi valori.
L'esempio riportato di seguito mostra come visualizzare un paragrafo di testo in un documento XHTML in esecuzione su Linux.
<p filter="os=linux"> Questo messaggio viene visualizzato solo su Linux. </p>
In questo secondo esempio, il link viene visualizzato solo se il plugin
com.my.plugin
non è installato:
<a href="..." filter="plugin!=com.my.plugin"> Fare clic qui per scaricare il plugin com.my.plugin. </a>
Il secondo modo consiste nell'utilizzare un elemento filter
come elemento secondario dell'elemento che si desidera filtrare. Questo modo è leggermente differente dal modo dell'attributo, ma in genere è più efficace in quanto è possibile specificare un qualsiasi numero di filtri su un elemento. Il formato generale è:
<element attribute="value">
<filter name="[name]" value="[modifier][value]"/>
</element>
name
e
value
sono gli stessi dell'attributo. Tuttavia, poiché sono separati, è necessario un altro modo per specificare se corrispondono o meno. Per impostazione predefinita, se non si fornisce un modificatore
,
si assume che si verifica una corrispondenza. Se non corrisponde, impostare il modificatore su "!
"
Di seguito è riportato un esempio del secondo modo:
<p> <filter name="os" value="linux"/> Questo messaggio viene visualizzato solo su Linux. </p>
Questo è un secondo esempio:
<a href="..."> <filter name="plugin" value="!com.my.plugin"/> Fare clic qui per scaricare il plugin com.my.plugin. </a>
Filtering support is turned off when running help in infocenter mode, causing all content, including filtered content, to be visible. If you intent to host your documentation in both workbench and infocenter modes, you should use filters in a way that makes sense even if filtering is turned off.
I filtri possono essere utilizzati nei seguenti tipi di documenti:
* Nota: è necessario effettuare delle operazioni aggiuntive per abilitare il contenuto dinamico nei documento XHTML.
In ogni caso, è necessario non inserire i filtri su elementi che, una volta rimossi, provocano un XML non valido. Ad esempio, non inserire un filtro sull'elemento html
in XHTML, in quanto senza questo elemento, XHTML non sarà più valido.