Definir los tópicos para usar desde nuestra aplicación
Para crear los tópicos debemos hacer lo siguiente en la utilidad HTML
Help Workshop:
En la barra de botones de la derecha de la utilidad debemos pulsar en el
cuarto botón (HmlHelp API Information), tal como se muestra en
la figura 1.
Figura 1. Configurar los alias de la ayuda
Esto nos mostrará un cuadro de diálogo con varias fichas tal como se muestra
en la figura 2, seleccionamos la segunda (Alias) y pulsamos en
el botón
Add.
Figura 2. Opciones de HtmlHel API Information
Nos pedirá que indiquemos una constante o un número el cual se usará para
hacer referencia a una página HTML de las que tenemos agregadas al proyecto (ver
figura 3).
Figura 3. Añadir un alias a una página de contenido
Además de una página, podemos indicar un marcador dentro de una página, lo
cual nos permite tener varias asociaciones dentro de una misma página HTML tal
como vemos en la figura 4.
Figura 4. Las referencias pueden contener marcadores
Una vez que hemos agregado las palabras y las hemos asociado con ficheros
HTML, tenemos que crear un fichero include, (sí, al estilo de
los ficheros include de C/C++, de hecho ese fichero debería tener la
extensión .h, que es la que la utilidad usará para buscarlo
cuando lo queramos agregar), en ese fichero definiremos constantes numéricas que
estarán asociadas a las constantes o palabras que hemos definido en el paso
anterior.
El contenido de ese fichero estará formado por líneas que usan el formato:
#define <constante> <valor numérico>
Siendo <constante> la constante que hemos agregado en la ficha
Alias y <valor numérico> un valor que usaremos
en la propiedad correspondiente del control con el que queremos asociar ese
tópico, por ejemplo, en las aplicaciones para .NET Framework lo asignaríamos a
la propiedad HelpKeyword del componente HelpProvider o bien lo usaremos como
valor a pasar a la clase Help en el último parámetro cuando usamos
el método ShowHelp con la constante
HelpNavigator.TopicId, tal como vemos en el siguiente código de
Visual Basic:
Help.ShowHelp(Me, hlp, HelpNavigator.TopicId, "1001")
Una vez hemos creado ese fichero include, tenemos que agregarlo al proyecto
de ayuda HTML por medio de la ficha Map del cuadro de diálogo mostrado por la
opción HtmlHelp API Information, tal como vemos en la figura 5.
Figura 5. Agregar el fichero include
Si en la ficha Alias agregamos los valores mostrados en la figura 6, el
contenido del fichero "include" podría ser el mostrado a continuación.
Figura 6. Los Alias a usar desde el fichero include
#define Principal 100
#define Descripcion 101
#define Proyecto 1000
#define Ficheros 2000
#define Ventanas 3000
#define Contenido 4000
#define Indice 5000
#define Configurar 6000
#define Topicos 7000
#define AcercaDe 8000
La idea es que en la ficha Alias (ver figura 6) agreguemos
los nombres que después asociaremos a valores numéricos que serán los que usemos
desde nuestros programas.
Esos "alias" deben estar asociados con la página HTML (o el marcador dentro de
una página) que se mostrará cuando el valor numérico de ese alias se use desde
nuestro programa.