Filtros

Se algumas secções do documento apenas foram apresentadas num contexto específico, pode utilizar a marcação de filtração para especificar os critérios que têm de ser cumpridos, para que a secção do documento seja apresentada. Se os critérios não forem cumpridos, a secção do documento não será visível para o utilizador. Os filtros podem ser especificados em qualquer elemento XML, desde que a marcação continue a ser válida após o processamento. Se um elemento for filtrado, todos os elementos e texto contidos num elemento serão filtrados.

A tabela apresentada a seguir contém uma lista completa de todas as propriedades filtradas e os respectivos valores possíveis.

Propriedade Significado Valores Possíveis
os sistema operativo win32, win32, linux, macosx, aix, solaris, hpux, qnx
ws sistema de apresentação em janelas win32, motif, gtk, photon, carbon
arch arquitectura do processador x86, x86_64, ia64, ia64_32, ppc, PA_RISC, sparc
produto identificador de produto do eclipse Qualquer identificador de produto (por exemplo, para SDK, org.eclipse.sdk.ide)
plug-in presença do plug-in Qualquer identificador de plug-in (por exemplo, org.eclipse.help)
categoria categoria das actividades Qualquer identificador de categoria de actividade (por exemplo, para a categoria Equipa, org.eclipse.categories.teamCategory)
actividade actividade (capacidade) Qualquer identificador de actividade (por exemplo para actividades de Suporte CVS, org.eclipse.team.cvs)

Se o nome não corresponder a nenhuma propriedade predefinida, o sistema de ajuda irá utilizar a propriedade do sistema JVM desse nome. Por exemplo, é possível passar em qualquer propriedade definida pelo utilizador no lançamento, tal como -Dlocation=paris,france e filtrada por essa propriedade.

Existem duas formas de especificar filtros num elemento, através da utilização de atributos ou de elementos.

Atributos de Filtro

A primeira forma é adicionando um atributo filtro ao elemento. A forma geral é:

   <element filter="[name][operator][value]">
      Some text.
   </element>

O nome é o nome da propriedade através da qual se filtra, por exemplo, os para sistemas operativos. O operador é um = para assinalar uma correspondência (correspondência exacta, sensível a maiúsculas e minúsculas) ou != para assinalar uma não correspondência. O valor é aquilo a que a propriedade deve (ou não) corresponder. Por exemplo, para os, um dos valores possíveis é win32 (Windows). Está disponível numa lista apresentada abaixo uma lista completa de propriedades de filtros e os respectivos valores.

O exemplo apresentado abaixo mostra a forma de apresentar um parágrafo de texto num documento XHTML ao executar apenas no Linux.

   <p filter="os=linux">
      This message will only appear when viewed on Linux.
</p>
  

Neste segundo exemplo, a ligação será apenas apresentada quando o plug-in com.my.plugin não estiver instalado:

   <a href="..." filter="plugin!=com.my.plugin">
      Click here to download plugin com.my.plugin.
   </a>

Elementos de Filtro

A segunda forma de utilizar um elemento filter como elemento descendente do elemento que pretende filtrar. Esta forma é ligeiramente mais longa do que a forma do atributo, mas é muito mais poderosa, uma vez que permite especificar os filtros de um elemento que desejar. A forma geral é:

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

O nome e o valor são os mesmos do atributo. Contudo, uma vez que estão separados, é necessário utilizar outro modo de especificar se deverá ou não haver correspondência. Por predefinição, se não facultar um modificador, não é presumido que haja correspondência. Se não dever haver correspondência, configure o modificador como "! "

Em seguida, é apresentado o primeiro exemplo mostrado na segunda forma:

   <p> 
 
        <filter name="os" value="linux"/>
      This message will only appear when viewed on Linux.
</p>
  

E aqui é apresentado o segundo exemplo:

   <a href="...">
      <filter name="plugin" value="!com.my.plugin"/>
      Click here to download plugin com.my.plugin.
   </a>

Infocenter

O suporte de filtragem é desligado ao executar a ajuda em modo infocenter, tornando todos os conteúdos visíveis, incluindo o conteúdo filtrado. Se pretender alojar a documentação na área de trabalho e nos modos infocenter, deve utilizar os filtros de um modo que faça sentido, mesmo que a filtragem esteja desligada.

Onde se podem utilizar filtros?

A filtragem pode ser utilizada nos seguintes tipos de documentos:

* Nota: Existem alguns passos extra necessários para activar o conteúdo dinâmico nos documentos XHTML.

Não pode, de modo algum, colocar filtros num elemento em que a remoção desse elemento resultaria num XML inválido. Por exemplo, não deve colocar um filtro no elemento html no XHTML, uma vez que sem esse elemento, o XHTML deixa de ser válido.