Tags: El sistema de ayuda de Windows 3.1 (II)
El archivo de proyecto HPJ
Este archivo único, es el que utiliza el compilador Hc31.exe para generar un archivo (HLP). Debe contener como mínimo la sección [FILES] con la lista de archivos RTF. El nombre de este archivo será el que tenga el archivo final (HLP), esto es, un archivo Ayuda.hpj dará como resultado un archivo Ayuda.hlp.
En la sección [MAP] se les puede dar un valor a los identificadores de cada tema. De esta manera la aplicación puede pasar este valor a la ayuda para presentar un tema determinado. Lo mínimo para crear un archivo de ayuda es: un archivo RTF (aunque esté vacío), y un archivo de proyecto HPJ con la sección [FILES].
Enlace con la aplicación
El API de Windows posee una función que permite enlazar la aplicación con el archivo de ayuda. Se trata de la función WinHelp. La sintaxis de esta función es la siguiente:
BOOL WinHelp(hwnd, IpszHelpFile, fuCommand, dwData)
El primer parámetro es el manejador (handle) de la ventana que llama a la ayuda. El segundo parámetro es el nombre del archivo de ayuda. El tercer parámetro define de que manera se abre el archivo de ayuda. Y el cuarto parámetro depende del valor que tenga fuCommand.
Algunos de los valores posibles para fuCommand son los siguientes:
HELP_INDEX presenta el índice del archivo de ayuda, el valor de dwData debe ser 0.
HELP_CONTEXT presenta el tema de la ayuda que se indique en dwData, este valor es el que se ha definido en la sección [MAP] del archivo de proyectos (HPJ).
HELP_QUIT cierra la ayuda, el valor de dwData debe ser 0.
Organización del trabajo
Lo primero que se debería hacer antes de nada, es un esquema con el contenido de la ayuda. El esquema debería consistir en una jerarquía con el índice de contenidos en la punta:
Se debe incluir en la ayuda todo lo que el usuario espera encontrar en ella. Si tiene poca experiencia en Windows échele un vistazo
a la ayuda de otras aplicaciones, y busque los puntos en común. En general el usuario accederá a la ayuda por dos motivos, saber que hace un comando en particular o, saber como se realiza una determinada tarea.
El siguiente paso sería la creación de los texto (archivos RTF) y el archivo de proyectos (HPJ). Para finalizar se compila el archivo de proyecto con la utilidad Hc31.exe.
Consejos para la creación de ayudas
No desviarse de las convenciones para archivos de ayuda. una ayuda, es eso precisamente, y no un sofisticado sistema de complicar la vida al usuario. Resultaría paradójico que el usuario tuviese que invertir más tiempo en aprender a utilizar la ayuda que en aprender el contenido de la misma.
La ventana que muestre la información debe ser clara y ordenada. No abuse de los colores ni de distintos tipos de fuentes. Utilice las fuentes que se incluyen en el paquete original de Windows: Arial, Courier y Times New Román. Si utiliza otras, el usuario final podría no tenerlas instaladas en su sistema.
Cuidado con el tamaño de las fuentes. Si está creando su archivo de ayuda con una configuración de pantalla de 1024x768, tal vez el tamaño de la letra le parezca muy pequeño. Tenga en cuenta que el usuario podría tener configurada su pantalla a 640x480, tal vez a éste último las letras le parezcan muy grandes. Escoja un tamaño de fuentes de compromiso, teniendo en cuenta que la mayoría de los usuarios tienen una configuración de 640x480, aunque cada vez está más extendida la de 800x600.
Notas
Se ha evitado utilizar términos en inglés. En los manuales originales de las SDK de Windows, e incluso en algunos textos en Castellano, podrá encontrar que se hace referencia a temas como topics, identificador como Context-String, hiperenlaces o referencias cruzadas como cross reference.
