Eliminado:

C
CO
WIIN
OM
MO
ND
OC
DO
OW
CR
WSS
RE
EA
AR
RA
AR
RC
CH
HIIV
VO
OSS D
DE
EA
AY
YU
UD
DA
A PPA
AR
RA
AW

JANH

NDICE
Introduccin
1. Crear un archivo de ayuda
1.1. Crear el texto de nuestro archivo de ayuda
1.2. Caracteres especiales para el archivo *.rtf
1.3. Crear los enlaces en nuestro archivo de ayuda
1.4. Generar el archivo HPJ y HLP
1.5. Opciones para el archivo de ayuda
1.6. Insertar imgenes
1.7. Crear los contenidos del men
1.8. Modificar el aspecto del archivo de ayuda
1.9. Diferentes aspectos para el archivo de ayuda
2. Comentarios y Trucos
2.1. Dejar una parte de la ayuda inmvil
2.2. Abrir un archivo de otra aplicacin desde la ayuda
2.3. Eliminar el subrayado en los enlaces
2.4. Enlazar con otro archivo de ayuda

JANH

Introduccin

Para realizar nuestro archivo de ayuda, necesitaremos dos herramientas:

1) Un Editor de Textos que nos permita guardar archivos con la extensin *.RTF
(Ritch Text Format), como por ejemplo: Word y WordPad de Microsoft.
2) El programa Microsoft Help Workshop, el cual podremos encontrar en el CD del
Visual Basic 5.0, en el directorio E:\Tools\Hcw.

Los pasos para crear un archivo de ayuda son:

Creacin del archivo de texto *.rtf .

Creacin del archivo de ayuda *.hlp .

Configuracin de la visualizacin del archivo de ayuda (opcional).

Todos los textos en cursiva hacen referencia a opciones de men de los programas que se
utilizan. El editor de texto utilizado es Microsoft Word.

1. Crear un archivo de ayuda

JANH

1.1. Crear el texto de nuestro archivo de ayuda

Para empezar vamos a abrir en este caso el Microsoft Word con una hoja en blanco. En esta
hoja, ser donde escribiremos todos los textos de nuestro archivo de ayuda.
Se debe crear la primera pgina del archivo de ayuda, la cual ser de momento, la primera
que se visualizar cuando se ejecute el archivo de ayuda. Mas adelante veremos como
cambiar la pgina de inicio en Opciones para el archivo de ayuda. Por ejemplo, para
empezar podemos colocar un ttulo y unas opciones:

TITULO
Opcin1
Opcin2
Opcin 3
Comentarios...
Textos... Etc.
NOTA: El formato del texto, ya sea el color, tamao, fuente, etc., se definen en el Word.

Al final de la misma, vamos a insertar un salto de pgina. Para ello podemos pulsar las
teclas Ctrl+Enter, o a travs del men Insertar>> Salto..., Salto de pgina.
Seguido del salto de pgina, se introduce la informacin referente a la segunda pgina, que
en este ejemplo ser la Opcin 1. Cada salto de pgina indica una nueva pgina en el
archivo de ayuda (*.hlp).

Opcin 1
Comentarios...
Textos... Etc.

Para las dos opciones siguientes (Opcin 2, Opcin 3), se siguen los mismos pasos que para
la Opcin 1. De esta manera, crearemos todas las pginas que necesita nuestro archivo de

JANH

ayuda. Todos los comentarios que se deseen como mensaje emergente (Figura 1) tambin
se deben crear como una nueva pgina.

Figura 1.- Mensaje emergente en un archivo de ayuda.

Ahora, se guarda el archivo de texto pulsando en el botn Archivo, Guardar como... y

seleccionamos en Guardar como tipo la opcin Formato RTF (*.rtf). Para nuestro ejemplo
se tiene ayuda_1.rtf. Es recomendable crear un directorio para guardar los diferentes
archivos que se vayan generando a medida que se avance en el tutorial.

1.2. Caracteres especiales para el archivo *.rtf

Una vez que se haya creado el texto con sus pginas, vamos a colocar los caracteres
especiales que servirn para identificar dichas pginas. Nos colocamos en el principio de la
primera pgina, en el margen superior izquierdo de la misma y seleccionamos la opcin del
men Insertar>> Nota al pie... , donde aparece una ventana en la cual debemos elegir Nota
al Pie y Marca Personal. En la casilla deberemos poner # y pulsar en Aceptar. La pantalla
del Word se nos dividir en dos, estando nuestros textos en la parte superior.
En la parte inferior se encuentra Notas al Pie con el smbolo # que hemos introducido y el
cursor al lado del mismo. Ah debemos poner el nombre de la pgina (omita acentos,
espacios en blanco y cualquier otro carcter extrao), el cual servir como enlace para

JANH

llamarla desde otras pginas. Para la segunda pgina (Opcin 1) de nuestro ejemplo, podra
ser: #Pgina1 .
Una vez introducido el nombre de la pgina, nos volveremos a colocar en la pgina inicial,
en la parte superior izquierda de la misma, al lado del carcter # que hemos introducido e
insertaremos otra Nota al Pie de pgina siguiendo los pasos anteriores, pero con la
diferencia de que ahora en vez de introducir # introduciremos $. El $ es para indicar el
ttulo de la pgina. Volvemos a introducir otra Nota al Pie, pero ahora colocaremos la letra
k, la cual har referencia a las palabras claves de la pgina. Estas palabras, sern las que
aparecern en el ndice del archivo de ayuda. Podemos introducir tantas palabras como
deseemos separndolas por un punto y coma (;).
Hay que hacer esta operacin con todas las pginas que se hayan creado, menos con las que
se vayan a utilizar como mensajes emergentes, los cuales solo hay que colocarle el nombre
de la pgina (#).
Podemos utilizar otra Nota al Pie que nos servir para movernos por las pginas, la cual es
el smbolo de suma + con un nmero o letra nica para cada pgina. Por ejemplo, en la
pgina principal colocaremos un 1 una A, en la siguiente un 2 una B y as
sucesivamente en todas las pginas. Al pulsar sobre los botones siguiente >> o anterior <<,
el programa buscar la siguiente o anterior pgina. Si utilizamos nmeros, hay que tener en
cuenta que el nmero 10 est despus del nmero 1 y antes que el 2. Para solucionar este
problema, vasta con introducir un 0 delate del 1 (01) .

Resumen de caracteres para las Notas al Pie:

# - Nombre de la pgina
$ - Ttulo de la pgina
k - Palabras clave para el ndice del archivo de ayuda
+ - Numeracin de las pginas

1.3. Crear los enlaces en nuestro archivo de ayuda

JANH

Conociendo el nombre (#) que hemos colocado a cada una de las pginas, se procede como
en el siguiente ejemplo:
Si se desea que al pulsar sobre la Opcin 1 de la primera pgina, el usuario de la ayuda
vaya a la pgina que hemos nombrado como Pagina1 en la Nota al Pie (#). Para ello,
introducimos seguido de Opcin 1 el nombre de la pgina a la que hace referencia, sin dejar
ningn espacio en blanco. Trabajando de manera anloga con las dems pginas, queda de
la manera siguiente:

TITULO
Opcin1Pagina1
Opcin2Pagina2
Opcin 3Pagina3
Comentarios...
Textos... Etc.

Seleccionamos Opcin 1Pagina1 y le damos doble subrayado (Formato>>Fuente... casilla

Estilo de subrayado). Ahora seleccionamos Pagina1 y le indicamos que sea texto oculto,
por medio del men Formato>>Fuente... opcin Oculto. Eso es todo, ya tenemos el primer
enlace realizado. Para generar la ventana emergente, se sigue el mismo procedimiento, con
la diferencia de que en vez de doble subrayado se coloca subrayado simple. Realice esta
operacin con todos los enlaces.
Es recomendable, indicar al Word que nos muestre los textos ocultos. Para ello, selecciona
el men Herramientas>>Opciones... y en la patilla Ver, selecciona Texto oculto y pulsa
Aceptar. Ahora visualizars los textos ocultos en la pantalla.

1.4. Generar el archivo *.hpj y *.hlp

JANH

Un archivo de extensin .hpj contiene toda la informacin de configuracin de un archivo

de ayuda. El archivo de extensin .hlp es propiamente el archivo de ayuda. stos archivos
son creados con el programa Microsoft Help Workshop, a partir del archivo de texto .rtf .

Figura 2.- Ventana principal del programa Microsoft Help Workshop.

Seleccione File>>New, para generar un nuevo archivo .hpj. Aparece una ventana en la cual
debe elegir Help Project y pulsar en Ok, luego debe introducir el nombre del nuevo archivo
.hpj y seleccionar el directorio donde se va ha ubicar en el disco duro (se recomienda que
sea en el directorio creado con anterioridad). Siguiendo con el ejemplo, nuestro archivo se
llamar AYUDA 1 .

JANH

Figura 3.- Ventana principal del archivo

Especifique el archivo RTF que corresponde al archivo de ayuda que se desea crear.
Pulse el botn Files y luego en Add para agregar el archivo. Seleccione el archivo
ayuda_1.rtf y pulse Ok. Observe que en la pantalla principal aparece el nuevo archivo.
Ahora slo le queda pulsar Save and Compile para guardar el archivo HPJ y generar
finalmente el archivo HLP. Una vez finalizada la operacin, se genera un reporte del
archivo compilado, indicando si ha habido algn error, nmero de enlaces, imgenes, etc.

JANH

1.5. Opciones para el archivo de ayuda

Pulsando sobre el botn Options..., se pueden modificar algunas caractersticas del archivo
de ayuda. En la patilla General se tienen las siguientes opciones:
Default Topic: Permite indicar la primera pgina que mostrar el archivo HLP al ser
abierto. Esta cadena, tiene que coincidir con alguno de los nombres (#) de las pginas del
archivo RTF.
Help Title: Indica el ttulo que aparecer en el archivo de ayuda. Este ttulo servir mientras
no se genere un archivo de contenido (*.cnt) del archivo de ayuda.
Display this text in de Version dialog box: Permite indicar el texto que aparecer en el
momento que el usuario pulse en el men Versin del archivo de ayuda.
If users paste or print Help text display: Se puede indicar el texto que aparecer en el
momento en que un usuario copie o imprima parte del archivo de ayuda, es decir, el texto
se imprimir y se podr copiar, pero al final de todo aparecer el texto que indiquemos en
esta casilla.

1.6. Insertar imgenes

Imgenes simples: Para insertar una imagen en un archivo de ayuda, se debe colocar
en el archivo RTF, en la parte donde vaya la imagen, el siguiente cdigo:
{bmX C:\nombreimagen.bmp}
donde X puede: izquierda ( l ), derecha ( r ) y centro ( c ).

Imgenes con enlaces: Una herramienta del programa Help Workshop, es el programa
Hotspot Editor, el cual permite generar enlaces hacia diferentes pginas del archivo de
ayuda, sobre una imagen dada.
Ejecute el programa Hotspot Editor y seleccione File>>Open para abrir una imagen
(esta debe ser de tipo BMP, DIB, WMF SHG, ste ltimo es el que genera el mismo
programa). Una vez tenga la imagen que desea, seleccione con el ratn la parte o partes
de la imagen que servirn de enlace con el archivo de ayuda.
Una vez que tenga seleccionada el rea de la imagen que vaya a utilizar como enlace,
pulse dos veces encima de la misma; aparece una ventana como la mostrada en la
Figura 4.

JANH

Figura 4.- Pantalla de atributos de enlaces del Hotspot Editor.

Estos son los atributos del rea seleccionada. Desde aqu, podr modificar el tamao del
rea seleccionada modificando los atributos left, top, width y height en pixeles. En Context
String debe colocar el nombre (#) de la pgina a la cual hace referencia el enlace. En Type
puede elegir entre Pop-up, para mostrar un mensaje emergente, Jump, para saltar a otra
pgina de la ayuda. Los archivos de imagen tienen que estar en el mismo directorio que el
archivo HPJ para su compilacin.

1.7. Crear los Contenidos del men

El sistema de ayuda para un tema dado puede estar compuesto por varios archivos de
ayuda. Para interrelacionar estos archivos entre s y obtener una forma ms organizada de

JANH

acceder a los diferentes tpicos la ayuda, se puede elaborar un archivo de contenido (*.cnt),
como el mostrado en la Figura 5.

Figura 5.- Contenido de un archivo de ayuda.

Con el programa Microsoft Help Workshop abierto, pulsamos en el men File>>New, y

seleccionamos Help Contents. Aparecer una ventana (Figura 6), en la cual introducir el
nombre del archivo en Default Filename, y en Default Title introducir el ttulo. El ttulo
que introduzcamos aqu, reemplazar el ttulo que hayamos colocado en Options...del
archivo de ayuda.

JANH

Figura 6.- Pantalla principal del Help Workshop en modo Help Contents.

Pulse en Add Above, aparecer una pantalla, en la cual debe elegir Heading para crear un
libro. Introduzca el nombre del libro en Title y pulse OK. Observe que se ha creado un libro
con el ttulo especificado. Puede crear tantos libros como sean necesarios.
Para crear las hojas que contendr un libro, marque el libro y pulse en Add Below y
selecciona Topic. Add Above inserta encima de parte seleccionada y Add Below en la parte
inferior. En la casilla Title selecciona el ttulo de la hoja y en Topic ID introducir el nombre
de la hoja (#) a la cual hace referencia.
Una vez que ha terminado de colocar los libros y hojas necesarias, cierre el Help Contents
y guarde el archivo en el mismo directorio donde se encuentra el archivo HPJ del proyecto.
Abra el archivo HPJ y pulse el botn Options... y seleccione la patilla Files. En la casilla
Contents Files, seleccione el archivo de contenido (.cnt) que ha creado. Pulse Aceptar y
compila el archivo. Ahora observe que al abrir el archivo de ayuda, aparece el contenido
que ha creado.

JANH

1.8 Modificar el aspecto del archivo de ayuda

Teniendo el archivo HPJ abierto, pulse sobre el botn Windows; aparece una pantalla en la
cual introducir main en create a windows named y pulse OK. En Base on this standard
windows coloque Procedure. Se abrir una nueva ventana denominada Window Properties,
en la cual podremos seleccionar todas las opciones que hacen referencia a la apariencia de
la ayuda. Segn las patillas de la parte superior, tenemos:
General: Si selecciona la propiedad Keep Help Window on Top, indica que el archivo de
ayuda siempre ser visible. La propiedad Maximize Window, mostrar la ventana de la
ayuda a pantalla completa.
Position: Determina la posicin de la ayuda en la pantalla. Por defecto aparecer en la parte
derecha de la pantalla. Para modificarla pulse sobre le botn Auto-Sizer, el cual abrir un
archivo de ayuda vaco para colocarlo en la parte exacta de la pantalla donde desee que
aparezca la ayuda, incluyendo su tamao. Si pulsa en el botn Default Position, la ventana
de la ayuda tendr el tamao por defecto, que es centrada en la pantalla y con toda su
altura. Si selecciona Adjust for users screen resolution, la ayuda se ajustar segn el
tamao del monitor donde se ejecute. Esta opcin es fundamental cuando se utiliza el AutoSizer.
Buttons: Determina qu botones aparecern en el cuadro de la ayuda. Estos pueden ser:

Contents: Se dirige a la primera pgina de la ayuda al archivo de contenido, si existe.

Index: Botn ndice de la ayuda.

Find: Botn Buscar en la ayuda.

Help Topics: Muestra los libros creados para la ayuda.

Print: Botn Imprimir.

Back: Botn para ir a la pgina anterior.

Options: Botn para modificar las opciones del programa de ayuda.

Browser: Btones Adelante y Atrs, cuando se utiliza el carcter especial + en nuestro

archivo de ayuda.

Color: Permite especificar el color del fondo, tanto del rea que no se desplaza, como del
rea que se desplaza por la pantalla.

JANH

1.9 Diferentes aspectos para el archivo de ayuda

Por defecto, cada vez que se abra la ayuda, utilizar el formato que hemos definido con el
nombre main en Modificar el aspecto de nuestro archivo de ayuda. Si se quiere, por
ejemplo, que una de las pginas de ayuda se muestre diferente que las dems, ya sea en
tamao, color del fondo, botones, etc, deberemos crear otro tipo de configuracin, lo cual
se puede indicar a travs del Contenido del archivo de ayuda al crear los enlaces en el
archivo RTF respectivo.

Crear un nuevo estilo de ventana para la ayuda.

Teniendo el archivo HPJ abierto, pulse sobre el botn Windows... Se abre la ventana
Windows Properties. En la patilla General, pulse sobre el botn Add..., el cual permitir
crear otras propiedades de ventana. En create a window named introduzca el nombre que
desee para el nuevo tipo de ventana (por ejemplo main2). En Based on this standard
windows, coloque Procedure. Pulse Ok. Observe que ahora en la casilla Windows Type
quedar el nombre que ha colocado (main2). Las propiedades de todas las ventanas que
creemos pueden ser totalmente diferentes y sern independientes entre s.

Indicar el nuevo estilo de ventana a travs del archivo de contenido.

Una vez establecidos los nuevos estilos de ventana, vamos a asignar a cada tpico el tipo de
visualizacin que queramos, lo cual haremos desde el archivo de contenido respectivo.
Seleccione el tpico, pulse el botn Edit... aparecer la ventana en la cual hemos indicado
el ttulo y el nombre de la pgina a la que hace referencia. En Window Type introduzca la
ventana que desea para ese tpico (por ejemplo main2). Pulse Ok y guarde los cambios.
Genere nuevamente el archivo de ayuda y ejectelo.

Visualizar el nuevo estilo a travs del archivo RTF.

Para indicar el tipo de ventana que desea para una pgina en el archivo RTF, al final del
texto de enlace (por ejemplo Opcin 1Pagina1) que hace referencia hacia la referida pgina,
y en formato de texto oculto, introduciremos el carcter > y el nombre de la pgina que
queremos mostrar. Siguiendo el ejemplo anterior, quedara algo as:
Opcin 1Pagina1>main2

JANH

2. Comentarios y Trucos
2.1. Dejar una parte de la ayuda inmvil
Dejar una parte de la pantalla inmvil quiere decir que una parte de la pantalla (la superior)
se quedar fija mientras que la otra puede desplazarse hacia arriba y hacia abajo a travs de
la ventana de la ayuda por medio de sus respectivas barras de desplazamiento.

Figura 7.- Pantalla de un archivo de ayuda con una parte inmvil.

Seleccione en el archivo RTF desde el principio de la pgina respectiva el texto que desea
fijo en la ventana de ayuda, y mrquelo como ttulo (men Formato>>Estilo... seleccione
Titulo 1). Nuevamente recuerda volver a compilar el archivo HLP.

2.2. Abrir un archivo de otra aplicacin desde la ayuda

Desde un archivo HLP CNT se puede abrir un archivo de otra aplicacin, como por
ejemplo: abrir una pgina web, abrir un correo electrnico, un documento de Word, etc.
Para ello, se utiliza la instruccin ExecFile.
Ejemplo 1.- Abrir una pgina web: En la pgina respectiva del archivo RTF introducimos
el siguiente texto, donde la parte tachada es el hipervnculo que se mostrar en el archivo
de ayuda y, lo dems, va en formato de texto oculto.
JANH

Lapuerta1.com*!ExecFile("http://www.lapuerta1.com")

Ejemplo 2.- Abrir una pgina web: En la pgina respectiva del archivo RTF introducimos
el siguiente texto:
enriquedavis*!ExecFile("mailto:enriquedavis@hotmail.com")

Ejemplo 3.- Abrir un documento de Word: En la pgina respectiva del archivo RTF
introducimos el siguiente texto:
Documento de Word*!ExecFile(C:\e_davis\tesis_edavis.doc)

Obviamente que en el PC donde se ejecuten stos hipervnculos deben estar instaladas las
aplicaciones que manejan los archivos respectivos.

2.3. Cambiar el color de los enlaces en nuestro archivo de ayuda

Se puede cambiar el color de los enlaces que hay entre los archivos de ayuda. Para ello,
desde el archivo RTF cambiamos el color del texto del enlace por el que deseamos y, entre
el texto del enlace y el nombre de la pgina, colocamos un asterisco *.
Opcin 1*Pagina1
2.4. Eliminar el subrayado en los enlaces
Para eliminar el subrayado en un enlace del archivo de ayuda, desde el archivo RTF hay
que introducir un % entre el texto del enlace y el nombre de la pgina.
Opcin 1%Pagina1
2.5. Enlazar con otro archivo de ayuda
Para vincular un archivo de ayuda HLP con otro, tenemos que colocar el nombre del enlace
y, a continuacin sin espacios y en formato de texto oculto, el nombre de la pgina del otro
archivo de ayuda, una @ y seguido el nombre del archivo de ayuda con la extensin
incluida; por ejemplo: Opcin 1Pagina1@ArchivoAyuda.hlp

JANH