Opcional: Incluindo Ajuda ao Nó

  1. Incluir ajuda on-line para o nó. Você pode criar um arquivo help.html dentro do projeto para conter a ajuda on-line que explica o que o nó faz e como utilizá-lo. Se você tiver vários arquivos, pode considerar a criação de um subdiretório doc separado no projeto plugin e o armazenamento dos arquivos de ajuda on-line nesse subdiretório. Você pode fazer a ajuda on-line aparecer integrada às informações fornecidas com o produto. Nas informações do produto WebSphere Message Broker, sob a Referência > Fluxos de Mensagem, existe um nó folha chamado "Nós Definidos pelo Usuário". Para fazer a ajuda on-line para seu nó aparecer nesse ponto, é preciso:
    1. Modificar o arquivo plugin.xml para incluir o seguinte ponto de extensão na documentação do produto WebSphere Message Broker:
      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>
    2. Crie um arquivo toc.xml no projeto de nó plug-in e modifique o atributo link_to para vincular à âncora "UDNodes" já definida no índice de documentação do WebSphere Message Broker da seguinte forma:
      <toc label="My Plugin Node" topic="my_node.htm"
      link_to="../com.ibm.etools.mft.doc/toc.xml#UDNodes">
      <topic label="Mytopic 1" href="topic1.htm>
      </toc>
      Você deve ser capaz de ver o tópico da ajuda em Referência > Fluxos de Mensagens > Nós definidos pelo usuário, no índice.

      Os nós de amostra fornecidos com o projeto demonstram esse recurso.

      Para obter explicação adicional sobre pontos de extensão e como utilizá-los, consulte o Guia PDE.

  2. Incluir ajuda contextual (F1) para o nó. Esta é a ajuda que você vê quando clica em um nó na e Perspectiva do Desenvolvimento de Aplicativos do Intermediário pressiona F1.

    Quando um nó é criado, um arquivo HelpContexts.xml é criado. Este designa um ID de contexto com base no nome do nó. O arquivo HelpContexts.xml pode ser modificado para seu nó alterando o texto no campo de descrição. O nome do arquivo HelpContexts.xml deve ser exclusivo no projeto mas pode conter várias entradas de contexto, por exemplo, se existem vários nós em um único projeto, cada nó pode ter sua ajuda contextual no arquivo.

    A ajuda contextual é limitada em comprimento. Uma maneira útil de fornecer mais ajuda ao usuário é fazer link da ajuda de F1 para um arquivo HTML contendo informações adicionais, por exemplo, para a ajuda on-line do nó, descrita acima. Esse link deve ser codificado da seguinte forma:
    <topic href"../plugin directory/html file" label="Link title">
  3. Incluir ajuda instantânea (ajuda de descrição de ferramenta) para o nó. Quando um nó é criado, um arquivo palette.properties é criado. Você pode modificar esse arquivo para conter ajuda instantânea para o nó, que é utilizada para mostrar o nome do nó quando a paleta não é grande o suficiente para exibi-la totalmente.

Se não quiser incluir nenhum recurso opcional, poderá testar o nó neste ponto. Para fazer isso, é necessário ativar outra instância do workbenchInício da mudança, consulte Ativando Capacidades do Tempo de Execução do PDEFim da mudança, e selecionar Executar > Executar como > Ambiente de Trabalho do Tempo de Execução. Consulte Guia PDE para obter informações adicionais sobre o teste utilizando o Workbench de Tempo de Execução.

Conceitos relacionados
Nós de Entrada Definidos pelo Usuário
Nós de Processamento de Mensagem Definidos pelo Usuário
Nós de Saída Definidos pelo Usuário
Tarefas relacionadas
Desenvolvendo Extensões Definidas pelo Usuário
Implementando as Amostras Fornecidas
Testando um Nó Definido pelo Usuário
Distribuindo uma Extensão Definida pelo Usuário
Referências relacionadas
Extensões Definidas pelo Usuário
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback
Direitos Autorais IBM Corporation 1999, 2006 Última Atualização: 1 Sep 2006
as04497_