Contextos

Identificador: org.eclipse.help.contexts

Descrição: definindo o auxílio dependente de contexto para um plug-in individual.

Marcação da Configuração:

   <!ELEMENT contexts EMPTY>
   <!ATTLIST contexts file CDATA #REQUIRED>

Marcação de Configuração para Contextos (isto é o que vai dentro do arquivo manifest de contextos) :

    <!ELEMENT contexts (context)* ) >

    <!ELEMENT context (description?,topic*) >
    <!ATTLIST context id ID #REQUIRED >

    <!ELEMENT description (#PCDATA)>

    <!ELEMENT topic EMPTY >
    <!ATTLIST topic label CDATA #REQUIRED >
    <!ATTLIST topic href CDATA #IMPLIED >

Os arquivos manifest de contextos fornecem todas as informações necessárias quando um auxílio dependente de contexto é solicitado pelo usuário. O ID é transmitido pela plataforma para identificar o contexto atualmente ativo. As definições de contexto com IDs correspondentes são recuperadas. O objeto IContext é criado pelo sistema de ajuda que contém descrições e tópicos de todas as definições de contexto de um ID específico.  A descrição deve ser exibida para o usuário e os tópicos relacionados podem ser úteis ao usuário para entendimento do contexto atual.  O tópico relacionado são os arquivos html compactados no doc.zip, junto com os tópicos que fazem parte da ajuda online.
 

Exemplos:

A seguir um exemplo do uso do ponto de extensão contextos.

(no arquivo plugin.xml)

   <extension point="org.eclipse.help.contexts">
      <contexts file="xyzContexts.xml"/>
   </extensão>
 

(no arquivo xyzContexts.xml)

    <contexts>
      <contexto  id="generalContextId">
        <descrição> Esta é uma </descrição> da amostra da cadeia de ajuda F1.
        <topic href="contexts/RelatedContext1.html"  label="Help Related Topic 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Help Related Topic 2"/>
      </context>
    </contexts>
 

Cadeias de Externalização

Os arquivos XML de Contexto podem ser convertidos e a cópia resultante (com rótulos de descrição convertidos) será colocada no diretório nl/<idioma>/<país> ou nl/<idioma>.  O <idioma> e o <país> significam os códigos de idioma e de país com duas letras conforme utilizados nos códigos o locale.  Por exemplo, as conversões em Chinês Tradicional devem ser colocadas no diretório nl/zh/TW.  O diretório nl/<idioma>/<país> possui uma prioridade maior que nl/<idioma>.  Somente se nenhum arquivo for encontrado no diretório nl/<idioma>/<país>, o arquivo que reside em nl/<idioma> será utilizado.  O diretório raiz de um plug-in será pesquisado por último.

Os tópicos relacionados contidos em doc.zip podem ser localizados através da criação de um arquivo doc.zip com versão convertida de documentos e através da colocação de doc.zip no diretório
nl/<idioma>/<país> ou nl/<idioma>. O sistema de ajuda procurará os arquivos nesses diretórios antes de padronizar o diretório de plug-in.

 
Informações de API: nenhum código é solicitado para utilização desse ponto de extensão. Tudo que é necessário é fornecer o(s) arquivo(s) manifest apropriados mencionados no arquivo plugin.xml.
 

Implementação Fornecida: A implementação padrão do sistema de ajuda da UI fornecido com a plataforma Eclipse suporta completamente o ponto de extensão contexts.


Copyright IBM Corp. e outros 2000, 2002. Todos os Direitos Reservados.