Filtros

Si determinadas secciones del documento solo deben aparecer en un contexto específico, puede utilizar códigos de filtrado para especificar criterios que deban cumplirse para que aparezca la sección del documento. Si no se cumplen los criterios, esa sección del documento no será visible para el usuario. Los filtros pueden especificarse en cualquier elemento XML en tanto en cuanto el código siga siendo válido después del proceso. Si se quita un elemento mediante filtro, también se filtrarán todos los elementos y el texto contenidos bajo ese elemento.

La tabla siguiente contiene una lista completa de todas las propiedades y de los valores posibles.

Propiedad Significado Valores posibles
os sistema operativo win32, win32, linux, macosx, aix, solaris, hpux, qnx
ws sistema de ventanas win32, motif, gtk, photon, carbon
arch arquitectura de procesador x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
product identificador de producto Eclipse Cualquier identificador de producto (p.ej., para SDK, org.eclipse.sdk.ide)
plugin presencia de plug-in Cualquier identificador de plug-in (p.ej. org.eclipse.help)
category categoría de actividades Un identificador de categoría de actividades (p.ej. para la categoría Team, org.eclipse.categories.teamCategory)
activity actividad (posibilidad) Cualquier identificador de actividad (p.ej. para la actividad de Soporte de CVS, org.eclipse.team.cvs)

Si el nombre no coincide con ninguna propiedad predefinida, el sistema de ayuda utilizará la propiedad del sistema JVM con ese nombre. Por ejemplo, puede pasar cualquier propiedad definida por el usuario en el lanzamiento, como por ejemplo -Dlocation=paris,france y filtrar por esa propiedad.

Hay dos modos de especificar filtros en un elemento; utilizar atributos o elementos.

Atributo de filtro

El primer modo consiste en añadir un atributo filter al elemento. El formato general es:

   <element filter="[nombre][operador][valor]">
      Texto.
   </element>

E nombre es el nombre de la propiedad por la que filtrar, por ejemplo os para el sistema operativo. El operador es = para indicar coincidencia (coincidencia exacta, sensible a mayúsculas/minúsculas) o != para indicar discrepancia. El valor es aquello con lo que la propiedad debe (o no debe) coincidir. Por ejemplo, para os, uno de los valores posibles es win32 (Windows). A continuación se proporciona una lista completa de las propiedades de filtro y de sus valores.

El ejemplo siguiente muestra como visualizar un párrafo de texto en un documento XHTML solamente cuando se está ejecutando en Linux.

   <p filter="os=linux">
      Este mensaje solo aparecerá cuando se vea en Linux.
   </p>

En este segundo ejemplo, el enlace solo aparecerá cuando el plug-in com.my.plugin no esté instalado:

   <a href="..." filter="plugin!=com.my.plugin">
      Pulse aquí para descargar el plug-in com.my.plugin.
   </a>

Elemento de filtro

El segundo modo consiste en utilizar un elemento filter como hijo del elemento que desea filtrar. Este modo es algo más largo que el del atributo, pero es más poderoso porque puede especificar cualquier número de filtros sobre un elemento. El formato general es:

   <element attribute="value">
      <filter name="[nombre]" value="[modificador][valor]"/>
   </element>

El nombre y el valor son iguales que los del atributo. Sin embargo, puesto que están separados, necesitamos otra manera de especificar si deben coincidir o no. Por omisión, si no proporciona un modificador, se da por supuesta la coincidencia. Si no debe coincidir, establezca el modificador en "! "

A continuación se proporciona el primer ejemplo mostrado más arriba en el segundo formato:

   <p>
      <filter name="os" value="linux"/>
      Este mensaje solo aparecerá cuando se vea en Linux.
   </p>

Y el segundo ejemplo:

   <a href="...">
      <filter name="plugin" value="!com.my.plugin"/>
      Pulse aquí para descargar el plug-in com.my.plugin.
   </a>

Centro informativo (Infocenter)

El soporte de filtrado se desactiva al ejecutar la ayuda en modalidad infocenter, que hace que todo el contenido , incluido el contenido filtrado, sea visible. Si tiene previsto alojar la documentación tanto en la modalidad de entorno de trabajo como en la de infocenter, debe utilizar los filtros de forma que tenga sentido aunque el filtrado esté desactivado.

¿Dónde puedo utilizar filtros?

El filtrado puede utilizarse en los tipos de documentos siguientes:

* Nota: hay unos pocos pasos adicionales necesarios para habilitar el contenido dinámico en los documentos XHTML.

En cualquier caso, no debe colocar filtros en cualquier elemento cuya eliminación llevara a invalidar el XML. Por ejemplo, no debe colocar un filtro en el elemento html de XHTML, porque sin ese elemento, el XHTML ya no es válido.