Incluindo Ajuda no Nó

Inclua informações de ajuda para o nó que você criou como um arquivo HTML.

Antes de começar:
Inclua as informações de ajuda para o nó que você criou para explicar o motivo e o momento de se utilizar o nó e como ele deve ser configurado:

Todos os três formatos de ajuda são opcionais; você pode criar qualquer um ou mais de três recursos descritos abaixo.

  1. Crie um arquivo help.html dentro do projeto para conter a ajuda on-line que explica o quê o nó faz e como você pode utilizá-lo. Se você possui vários arquivos, crie um subdiretório de documento separado no projeto de plug-in e armazene os arquivos de ajuda on-line nesse diretório.

    Você pode fazer a ajuda on-line aparecer integrada o centro de informações fornecido com o produto, sob o nó folha definido "Nós Definidos pelo Usuário", que você pode localizar em Referência > Fluxos de Mensagens. Para fazer com que a ajuda on-line para o seu nó apareça nesse ponto:

    1. Modifique o arquivo plugin.xml para incluir o seguinte ponto de extensão no Centro de Informações:
      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>
    2. Crie um arquivo toc.xml em seu projeto de nó definido pelo usuário e modifique o atributo link_to para fazer link à âncora "UDNodes" que já está definida no índice do Centro de Informações.
      <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>
      Seu tópico de ajuda agora é exibido no índice sob Referência > Fluxos de Mensagens > Nós Definidos pelo Usuário.

      Os nós de exemplos que são fornecidos com o produto demonstram essa opção.

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

  2. Inclua ajuda contextual (F1) para o nó. A ajuda contextual é exibida ao clicar em um nó em Perspectiva do Desenvolvimento de Aplicativos do Intermediário e pressionar F1.

    Quando um nó é criado, um arquivoHelpContexts.xml é criado. Este arquivo designa um ID de contexto com base no nome do nó. Modifique o arquivo HelpContexts.xml para o seu nó, alterando o texto no campo de descrição. O nome do arquivo HelpContexts.xml deve ser exclusivo dentro do projeto, mas pode conter várias entradas de contexto; por exemplo, se você tiver vários nós dentro de 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 que contém informações adicionais; por exemplo, para a ajuda on-line do nó, descria acima. Codifique o link conforme mostrado abaixo:
    <topic href"../plug-in directory/html file" label="Link title">
  3. Inclua a ajuda instantânea (conhecida como a ajuda de Dicas de Ferramentas no Windows) para o nó. Ao criar um nó definido pelo usuário, um arquivo palette.properties é criado. Modifique esse arquivo para conter a ajuda flutuante do nó, que mostra o nome do nó quando a paleta não for grande o suficiente para exibi-la.

É possível incluir outro recurso opcional, um ícone de nó or um editor de propriedades ou compilador ou você pode testar seu nó.

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 de Extensões Definidas pelo Usuário Fornecidas
Testando um Nó Definido pelo Usuário
Empacotando um Projeto do ambiente de trabalho de Nó Definido pelo Usuário
Referências relacionadas
Extensões Definidas pelo Usuário
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
Última atualização : 2009-02-13 16:13:06

as04497_