Adición de ayuda al nodo

Añada información de ayuda para el nodo que se ha creado como archivo HTML.

Antes de empezar:
Añada información de ayuda para el nodo que ha creado, para explicar por qué y cuándo utilizar el nodo, y cómo debe configurarse:

Las tres formas de ayuda son opcionales; puede crear cualquiera de los tres recursos descritos arriba, o incluso más.

  1. Cree un archivo help.html dentro del proyecto para que contenga la ayuda en línea que explica lo que hace el nodo y cómo puede utilizarlo. Si tiene varios archivos, cree un subdirectorio doc aparte en el proyecto de plug-in y almacene los archivos de ayuda en línea en ese directorio.

    Puede hacer que la ayuda en línea del nodo aparezca integrada en el centro de información proporcionado por el producto, bajo el nodo secundario denominado "Nodos definidos por el usuario", que puede encontrar en Referencia > Flujos de mensajes. Para que la ayuda en línea para el nodo aparezca en este punto, tiene que:

    1. Modificar el archivo plugin.xml para que incluya el siguiente punto de extensión en el centro de información:
      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>
    2. Crear un archivo toc.xml en el proyecto de nodo definido por el usuario y modificar el atributo link_to para enlazar con el ancla "UDNodes" que ya está definido en la tabla de contenido del centro de información:
      <toc label="Mi Nodo de Plugin" topic="mi_nodo.htm"
      	link_to="../com.ibm.etools.mft.doc/toc.xml#UDNodes">
      <topic label="Mitema 1" href="tema1.htm>
      </toc>
      Ahora el tema de ayuda aparecerá en la tabla de contenido bajo Referencia > Flujos de mensajes > Nodos definidos por el usuario.

      Los nodos de ejemplo que se proporcionan con el producto muestran esta opción.

      Para obtener una descripción adicional de los puntos de extensión y cómo se utilizan, consulte PDE Guide.

  2. Añada ayuda según contexto (F1) al nodo. La ayuda según contexto se muestra al pulsar sobre un nodo en la Perspectiva de Desarrollo de aplicaciones de intermediario y pulsar F1.

    Cuando se crea un nodo, se crea un archivo HelpContexts.xml. Este archivo asigna un id de contexto basado en el nombre del nodo. Modifique el archivo HelpContexts.xml para el nodo, cambiando el texto en el campo de descripción. El nombre del archivo HelpContexts.xml debe ser exclusivo dentro del proyecto, pero puede contener varias entradas de contexto; por ejemplo, si tiene varios nodos dentro de un solo proyecto, cada nodo puede tener su ayuda según contexto en el archivo.

    La ayuda según contexto tiene una longitud limitada. Un modo práctico de proporcionar más ayuda al usuario es enlazar desde la ayuda de F1 con un archivo HTML que contenga más información; por ejemplo, con la ayuda en línea del nodo, como se ha descrito anteriormente. Codifique el enlace tal como se muestra a continuación:
    <topic href"../directorio plug-in/archivo html" label="Link title">
  3. Añada ayuda contextual (conocida como ayuda sobre herramientas en Windows) para el nodo. Cuando crea un nodo definido por el usuario, se crea un archivo palette.properties. Modifique este archivo para que contenga ayuda contextual para el nodo, que muestra el nombre del nodo cuando la paleta no es lo suficientemente grande como para visualizarlo todo.

Puede añadir otra característica opcional, un icono de nodo o un editor o compilador de propiedades o bien puede probar el nodo.

Conceptos relacionados
Nodos de entrada definidos por el usuario
Nodos de proceso de mensajes definidos por el usuario
Nodos de salida definidos por el usuario
Tareas relacionadas
Desarrollo de extensiones definidas por el usuario
Implementación de los ejemplos de extensión definidos por el usuario proporcionados
Comprobación de un nodo definido por el usuario
Empaquetado de un proyecto de entorno de trabajo de nodo definido por el usuario
Referencia relacionada
Extensiones definidas por el usuario
Avisos | Marcas registradas | Descargas | Biblioteca | Soporte | Su opinión

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
Última actualización : 2009-02-16 13:56:09

as04497_