Instalación de documentación propia en z/OS Explorer

Si su organización tiene procesos y procedimientos de sistema operativo, puede que desee incluirlos en el Contenido de ayuda de z/OS® Explorer para que estén disponibles al utilizar z/OS Explorer. Puede crear un plug-in de documentación propia e integrarlo completamente con el Contenido de ayuda de z/OS Explorer o, como paso provisional, puede integrar archivos de texto y HTML con la función de búsqueda de Ayuda de z/OS Explorer.

Creación de un plug-in

z/OS Explorer se basa en la plataforma de código abierto Eclipse, que proporciona un entorno de desarrollo integrado ampliable. Con la plataforma Eclipse, cualquiera puede crear herramientas que se integran perfectamente con el entorno y otras herramientas. La clave de la perfecta integración de herramientas con Eclipse es el plug-in. A excepción de un pequeño kernel de tiempo de ejecución, todo en Eclipse es un plug-in. Esto quiere decir que un plug-in que desarrolle se integra con Eclipse, así como con z/OS Explorer, exactamente de la misma forma que otros plug-ins.

Cuando crea un plug-in de documentación, se integra completamente con z/OS Explorer, y el contenido se muestra en el Contenido de la ayuda.

Puede crear su plug-in de documentación propia utilizando el Entorno de desarrollo de plug-ins de Eclipse (Plug-in Development Environment - PDE), que está disponible en el Entorno de desarrollo integrado (IDE). El entorno de desarrollo integrado de Eclipse es un código abierto que se puede descargar desde el sitio web de Eclipse http://www.eclipse.org. La documentación explica cómo empezar, una hoja de apuntes facilita instrucciones paso a paso para crear un a plug-in.

Integración de archivos de texto y HTML con la búsqueda de la Ayuda de z/OS Explorer

Si todavía no ha creado un plug-in de documentación, pero tiene archivos de texto o HTML a los que desea acceder en z/OS Explorer, puede ubicar los archivos en una carpeta especial para que se incluyan en el índice de búsqueda de z/OS Explorer. Al realizar una búsqueda de información de ayuda, se muestran todas las coincidencias con su documentación junto con los resultados de z/OS Explorer. Sin embargo, cuando ve el Contenido de ayuda, no aparecerán sus documentos.

Este método de integración de archivos de texto y HTML sólo es una solución provisional hasta que cree el plug-in de documentación.

Para incluir sus archivos de texto o HTML en la búsqueda de la Ayuda de z/OS Explorer, realice los siguientes pasos:

  1. Pulse Ayuda > Gestionar documentación personalizada en el menú de entorno de trabajo. El gestor de archivos abre una ventana en el escritorio que muestra el contenido de la carpeta mydocs de z/OS Explorer.
  2. Copie los archivos de texto o HTML que desee incluir en z/OS Explorer y cópielos en la carpeta mydocs.
  3. Cierre la ventana mydocs.
  4. Pulse Ayuda > Volver a crear índice de búsqueda en el menú de entorno de trabajo. Se presenta un diálogo que pide confirmación. La operación requiere que z/OS Explorer se reinicie.
  5. Pulse Aceptar para continuar, o pulse Cancelar si no desea volver a iniciar z/OS Explorer en este momento. Debe realizar el paso de recreación para que se incluyan los archivos en la búsqueda de Ayuda.

Cuando z/OS Explorer se reinicia, cualquier búsqueda de Ayuda que realice buscará su documentación propia, así como la documentación de z/OS Explorer. Los resultados encontrados en su documentación propia se listan antes que los resultados encontrados en la documentación de z/OS Explorer.

Nota: cuando se encuentran resultados de búsqueda en archivos HTML, se muestra el nombre de archivo en las etiquetas <Title></Title>. Sin embargo, los archivos de texto no incluyen etiquetas de título, por lo que los resultados de los archivos de texto muestran la vía de acceso del archivo según se muestra en esta captura de pantalla Captura de pantalla de resultados de búsqueda que muestra los resultados de la documentación propia del cliente al principio de los resultados. Los dos primeros resultados tienen títulos adecuados, ya que son archivos HTML. Los siguientes tres resultados muestran las vías de acceso de los archivos, ya que son archivos de texto..

Tema padre: Tareas