Adición de ayuda al nodo

Añada la información de ayuda añadiendo un archivo HTML al nodo que ha creado.

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 en la siguiente sección, 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 tenga un aspecto como si estuviera 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:

    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. Cree un archivo toc.xml en su proyecto de nodo definido por el usuario y modifique el atributo link_to para que enlace con el ancla "UDNodes" que ya está definido en las vistas 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 las vistas 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 explicación adicional de los puntos de extensión y sobre cómo utilizarlos, consulte la guía de PDE en Documentación de Eclipse.

  2. Añada ayuda según contexto (F1) al nodo. La ayuda según contexto aparece cuando se pulsa un nodo de Perspectiva de Desarrollo de aplicaciones de intermediario y pulsa F1.

    Cuando se crea un nodo, se crea un archivo HelpContexts.xml. Este archivo asigna un identificador 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 proporciona 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, que se ha descrito anteriormente. Utilice el código siguiente para el enlace:
    <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 la 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 puede probar el nodo, consulte Creación de iconos de nodos, Adición de un editor de propiedades o compilador y Comprobación de un nodo definido por el usuario.

Avisos | Marcas registradas | Descargas | Biblioteca | Soporte | Su opinión

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

        
        Última actualización
        
        Última actualización : 2013-02-27 18:25:15


Tema de tareaTema de tarea | Versión 8.0.0.2 | as04497_