Caso práctico
Antonio, que conoce los contenidos que va a incorporar la ayuda, se pregunta la forma de indexarlos, para que el usuario de la aplicación pueda consultarlos de forma ordenada.
Antonio, que conoce los contenidos que va a incorporar la ayuda, se pregunta la forma de indexarlos, para que el usuario de la aplicación pueda consultarlos de forma ordenada.
Para facilitar el acceso a los términos de ayuda, la ayuda suele contar con un índice. El índice es una lista de palabras claves ordenadas alfabéticamente. El índice es similar a un glosario de términos o una guía de definiciones, salvo que el objetivo es aclarar un concepto o un procedimiento de uso de la aplicación en la que está insertada. Por ejemplo, si se realiza la ayuda del lenguaje de programación Java, las palabras reservadas del lenguaje serían palabras clave.
Normalmente, para acceder al índice, podemos navegar por la ventana de términos indexados, y seleccionar el que nos interese aclarar, o bien, rellenar un campo de texto y que el sistema busque el término en todas las ayudas.
Si estamos implementando aplicaciones en Java y queremos dotar al sistema de ayuda JavaHelp de un índice, podemos utilizar la herramienta jhindexer
. La herramienta jhindexer
es un componente del sistema JavaHelp, que sirve para crear la base de datos de búsqueda, necesaria para establecer el sistema de índices. El fichero de generación de índice, es un fichero en formato XML.