Ficheros de ayuda en aplicaciones

Laura Folgado Galache | www.laurafolgado.es 1

FICHEROS DE AYUDA EN

APLICACIONES

CICLO: Desarrollo de Aplicaciones MultiplataformaMÓDULO: Desarrollo de InterfacesLAURA FOLGADO GALACHE | WWW.LAURAFOLGADO.ES


FICHERO DE AYUDA

• Generalmente incluye la siguiente información:– Mapa del fichero: asocia los "Identificadores de tema" con el nombre de la URL

o ruta de tema HTML en el fichero de ayuda.– Vista de Información: presenta la información descrita en los navegadores de

fichero de ayuda. El estándar que se utiliza es: • Tabla de contenidos. • Índice.• Búsqueda de texto completo. • Algunos navegadores presentan un glosario y favoritos.


FICHERO DE AYUDA

– Título del fichero de ayuda: aparece en la barra de título de la ventana del fichero de ayuda y en las ventanas secundarias del fichero de ayuda.

– Identificar de inicio (Home ID): el nombre del identificador por defecto que se mostrará cuando el visor de ayuda sea invocado sin especificar un ID.

– Presentación: ventanas en las que se muestran los temas de ayuda.– Sub-Ficheros de ayuda: los ficheros de ayuda pueden estar formados por ficheros

más pequeños, que son fusionados para crear el fichero de ayuda de la aplicación.– Implementación: sección es opcional. Crea un registro que proporciona datos clave

para definir la asignación de la clase HelpBroker para usar el método HelpSet.createHelpBroker. El registro también determina el visor de contenido de usuario para un tipo MIME.

Laura Folgado Galache | www.laurafolgado.es

4

FORMATOS DE F ICHEROS DE AYUDA

• Ayuda online de Microsoft. Se entrega en un archivo binario junto con el chm. Contiene:

– Archivos HTML.– Tabla de contenido con hipervínculos.– Archivo índice.

• Características:– Compresión de datos (LZX).– Construída con motor de búsqueda.– Pueden fusionarse varios ficheros de

ayuda.

CHM (Ayuda HTML Compilado)


5


• HLP o WinHelp– Pueden incluir tabla de contenido (.cnt)– El fichero .gid incluye información como tamaño de

ventana, localización, etc.– Al pulsar en la pestaña “Buscar” se activan las

palabras clave y se crea un archivo con extensión .fts (full text search).

• HPJ:– Fichero de proyecto creado con Help Workshop (o

una herramienta compatible).– Contiene información de los ficheros RTF

compilados, identificadores del mapa y alias de los enlaces.

– Tiene un fichero .cnt (tabla de contenidos) y .shg con un mapa de imagen para presentar gráficos.

HLP y HPJ


6

FORMATOS DE F ICHEROS DE AYUDA• Ayuda en línea e hipertexto.

•Utiliza lenguaje IPF (similar a HTML).

• El archivo IPF se compila con el Compilador IPF y se crea un archivo INF o HLP (diferente del HLP de Windows).

IPF (Information Presentation Facility)


7


• Se llama JavaHelp al sistema de creación de archivos de ayuda y al formato del fichero de ayuda en línea.

• Los ficheros se pueden visualizar en el navegador JavaHelp.

• Están escritos en Java y se usan en aplicaciones Java.

• El formato del fichero está basado en XML.

JavaHelp


HERRAMIENTAS DE GENERACIÓN DE AYUDAS

•Para generación de ayuda hlp en Windows.HelpWorkshop• Para generación de ayuda en aplicaciones Java.JavaHelp• Para generar ayuda y documentación profesionales para aplicaciones de

escritorio y basadas en Web (como .Net).RoboHelp• Para generar ayuda de Windows. Puede generar ficheros compatibles con

hlp.WINHELP• Basado en HTML y DHTML que funciona sobre cualquier plataforma.WEBHELP• Para generar ficheros de ayuda HTML o páginas web.Help Magician


AYUDA GENÉRICA Y SENSIBLE AL CONTEXTOAYUDA GENÉRICA• Presenta todos los contenidos de

ayuda diseñados.• Se suele acceder pulsando F1 o en un

menú.• Podemos navegar por los contenidos o

buscar a través del buscador.• Con JavaHelp, esta ayuda está en

ficheros HelpSet, visibles con hsviewer.

AYUDA SENSIBLE AL CONTEXTO

• Ayuda en línea en función del software activo o de la situación de la aplicación que se está ejecutando.

• Suele mostrar una breve explicación del control seleccionado en la ventana de la aplicación.


CREACIÓN DE UN SISTEMA DE AYUDAJ AVA H E L P


GENERACIÓN DE UN SISTEMA DE AYUDA

Creación de los temas de ayuda

Creación de los ficheros metadatos JavaHelp

Encapsulación en un jar o adicción a

la aplicación

Fichero map.

Fichero helpset.

Fichero tabla de

contenidos.Fichero índice.

Fichero con la base de datos de

búsqueda.


ORGANIZACIÓN DE FICHEROS• /help

– Fichero_helpset.hs– Fichero_map.jhm– Fichero_toc.xml– Fichero_index.xml

• /fuentes– Topic1.html– Topic2.html

• /JavaHelpSearch


13

TOPIC S HTML• Se puede usar cualquier herramienta de edición de ficheros.

• Están hechos en HTML.

• Los Topics se organizan jerárquicamente.

• Se almacenan en un subdirectorio propio.


14

FICHERO MAP• Tiene extensión jhm (JavaHelp Map).

• Asocia los ficheros HTML, imágenes… con un identificador.

• La sintaxis es XML.


15

FICHERO HELPSET

• En este fichero se fusionan todos los archivos de ayuda y tiene la información para que se pueda ejecutar el sistema de ayuda.

• Tiene extensión .hs.


• Tiene una etiqueta <Home ID> con la página principal.


16

FICHERO TOC (TABLE OF CONTENTS)•Describe el contenido de la

ayuda y su distribución en la tabla de contenidos.



17

FICHERO ÍNDICE•Describe la distribución del contenido de nuestro sistema de ayuda.



18

BÚSQUEDA• Se puede generar un sistema de ayuda para

buscar por determinados términos o conceptos.

• Se necesita la herramienta jhindexer para que se genere la base de datos de búsqueda (almacenada en JavaHelpSearch):

– Generación de la base de datos:jhindexer directorio_con_archivos_ayuda

– Verificación del funcionamiento:jhsearch JavaHelpSearch

• La creación de esta base de datos se realiza sobre los ficheros de contenidos.


GENERACIÓN DE FICHEROS JAR• Para distribuir el sistema de ayuda en ficheros independientes (jar) utilizamos

la orden siguiente en el directorio donde están todos los archivos de ayuda.– jar –cvf ayuda.jar *

• Para ver los archivos del jar ejecutaremos:– Jar –tvf ayuda.jar

• Para extraer los archivos del jar ejecutaremos:– Jar –xvf ayuda.jar


AÑADIR AYUDA A APLICACIONES JAVA• Debemos incluir en nuestro proyecto lo siguiente:

– Paquete javax.help.* incluye la clase HelpSet y la clase HelpBroker.– Clase HelpSet: nos permite utilizar los ficheros y datos del sistema de ayuda.– Clase HelpBroker: visualiza el contenido de la ayuda de la aplicación.– Métodos findHelpSet: localiza el fichero HelpSet y devuelve su URL.– Método createHelpBroker: crea un objeto HelpBroker para el HelpSet.– Método enableHelpKey: habilita la tecla de ayuda sobre un componente.– Método enableHelpOnButton: se despliega la ayuda al pulsar un botón o un elemento del

menú.– Método enableHelp: indica el tema de ayuda a mostrar al hacer clic sobre un componente.


CRÉDITOS

• Los contenidos de esta presentación han sido extraídos de los Materiales Formativos de FP Online, propiedad del Ministerio de Educación, Cultura y Deporte.

• Su uso está restringido a fines exclusivamente relacionados con ofertas de enseñanza de Formación Profesional.

• El aviso legal de estos contenidos puede ser consultado en el siguiente enlace:

Aviso legal.

http://www.mecd.gob.es/fponline/aviso-legal.html

Ficheros de ayuda en aplicaciones

Education

Transcript of Ficheros de ayuda en aplicaciones