Incluindo Ajuda no Nó

Inclua informações de ajuda incluindo um arquivo HTML no nó que você criou.

Antes de iniciar:
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:

Todas os três formas de ajuda são opcionais; é possível criar qualquer uma ou mais dos três recursos descritos na seção a seguir.

  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 para o nó parecer ser integrada com o centro de informações fornecido com o produto, no nó folha denominado "Nós definidos pelo usuário", que você pode localizar nos Fluxos de Mensagens > de Referência. Para exibir a ajuda on-line para o seu nó 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 do nó definido pelo usuário e modifique o atributo link_to para vincular à âncora "UDNodes" que já está definida nas visualizações de conteúdo 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 nas visualizações de conteúdo sob Referência > Fluxos de mensagem > 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 usá-los, consulte o guia PDE em Documentação do Eclipse.

  2. Inclua ajuda contextual (F1) para o nó. A ajuda contextual é exibida quando você clica em um nó no Perspectiva do Desenvolvimento de Aplicativos do Intermediário e pressione F1.

    Quando um nó é criado, um arquivoHelpContexts.xml é criado. Este arquivo designa um identificador 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 forma útil de fornecer mais ajuda ao usuário é vincular a ajuda F1 a um arquivo HTML que contenha informações adicionais como, por exemplo, à ajuda on-line para o nó, descrito anteriormente. Utilize o código a seguir para o link:
    <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 este arquivo para conter a ajuda instantânea para seu nó, que mostra o nome do nó quando a paleta não foi suficientemente larga para exibir tudo.

É possível incluir outro recurso opcional, um ícone de nó ou um editor de propriedades ou compilador, ou é possível testar seu nó (consulte Criando Ícones do Nó, Incluindo um Editor de Propriedades ou Compilador e Testando um Nó Definido pelo Usuário).

Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback

Copyright IBM Corporation 1999, 2013Copyright IBM Corporation 1999, 2013.

        
        Última atualização
        
        Última atualização : 2013-02-27 20:23:39


Tópico de TarefaTópico de Tarefa | Versão 8.0.0.2 | as04497_