SEIS.1. INTRODUCCIÓN A LOS ARCHIVOS DE AYUDA

Imaginemos que, una vez aprendido todo lo necesario para crear una aplicación vertical para AutoCAD 14, con una base AutoLISP/DCL o VBA y unos archivos de definición de menús, de tipos de línea, letras, formas y demás que la acompañen, necesitamos informar al usuario de cuáles son los entresijos del conjunto que presentamos. Los tipos de comandos creados y su funcionamiento, el manejo de ciertos aspectos complejos etcétera, será necesario incluirlos en un archivo de ayuda para que el usuario de nuestro software sepa cómo manejarse con él.

Todos los programas, todas la aplicaciones, todo el software en general que se precie posee ficheros de ayuda que explican paso a paso unos, o más someramente otros, el funcionamiento del programa en sí. En este MÓDULO SEIS vamos a aprender a realizar archivos de ayuda para AutoCAD que acompañarán a nuestros diseños de aplicaciones o personalizaciones. Comentaremos algún que otro método, aunque a fondo únicamente veremos el propio de AutoCAD para creación de archivos de ayuda específicos del programa.

SEIS.2. LA AYUDA DE AutoCAD 14. FORMATO .AHP

Los archivos de ayuda propios de AutoCAD se escriben en archivos ASCII que deben tener la extensión .AHP. Toda la información contenida en un archivo .AHP ha de ser organizada por temas. Cada tema incluirá una serie de líneas de texto denominadas directrices que, a su vez, poseen un identificador de código y opcionalmente un título y/o una serie de palabras clave. A continuación se exponen todos lo códigos posibles de forma conjunta y, después, iremos comentado cada uno mientras revisamos un ejemplo práctico. Veamos la tabla de códigos:

Código de directriz ------- Función ------------------ Aparece en...

---------------------------------------------------------------------------------------------------

\# ------------------------ Identificador de tema ------ Se utiliza internamente (el
------------------------------------------------------- usuario no puede verlo).

\$ ------------------------ Título --------------------- Lista del historial y búsqueda
------------------------------------------------------- de temas.

\K ------------------------ Palabras clave ------------- Lista de búsqueda.

\E ------------------------ Final de archivo ------------ Final de archivo de ayuda (el
------------------------------------------------------- el usuario no puede verlo).

\espacio_blanco --------- Comentario ---------------- Comentarios internos (se
------------------------------------------------------- ignoran durante la visualiza-
------------------------------------------------------- ción de la ayuda en pantalla).

Vamos a ver un ejemplo para esclarecer el tema. Imaginemos que queremos crear un archivo de ayuda para explicar una serie de comandos nuevos que hemos programado en AutoLISP. Los comandos en cuestión serán HÉLICE, TUERCA y TORNILLO, cada uno dibuja el objeto que describe su nombre, solicitando al usuario los datos necesarios.

Lo primero que haremos es crear un índice en el que se describirán todos los temas incluidos en la ayuda. Para ello, y en un editor ASCII escribiremos las siguientes líneas:

\#index
\$ÍNDICE DE CONTENIDOS
\Kíndice
1. Nuevo comando HÉLICE.\
2. Nuevo comando TUERCA.\
3. Nuevo comando TORNILLO.\
\E

Vamos a explicarlas ahora. Lo primero que nos encontramos es el identificador interno del tema. Tras el código \#, la palabra index (elegida por nosotros) identifica a lo que le sigue hasta encontrar otro identificador similar. Estos identificadores serán utilizados por AutoCAD para encontrar los diferentes temas, así como también los utilizaremos nosotros, como veremos más adelante. Son obligatorios antes de cada tema y han de ser nombres únicos —no se pueden repetir en un mismo archivo de ayuda, evidentemente— y sin espacios.

\$ÍNDICE DE CONTENIDOS será la cadena que aparecerá a la hora de buscar un tema, como explicaremos a continuación. Parecido ocurre con la palabra clave índice, después del código \K.

A continuación escribimos el texto del tema en sí. Un carácter contrabarra (\) especifica la unión de líneas de distintos párrafos. Si al final de cada línea pulsamos simplemente INTRO, en un archivo .AHP esto se interpreta como cambio de párrafo, es decir, se deja una línea en blanco intermedia. Si no queremos que esto suceda habremos de introducir al final de la línea directriz dicho carácter de contrabarra.

El lector de la ayuda de AutoCAD está diseñado para trabajar con texto en formato DOS o UNIX EOL. Es decir, las líneas de texto del archivo fuente de ayuda deben concluir con una secuencia de retorno de carro. No se garantiza un correcto funcionamiento de archivos de ayuda escritos con otros protocolos EOL. El archivo fuente puede escribirse en ASCII de 7 u 8 bits, lo que significa que es fácilmente localizable. El lector de la ayuda de AutoCAD formatea el texto en el espacio disponible dentro del cuadro de lista de desplazamiento e inserta una línea en blanco entre párrafos. La ayuda de AutoCAD utiliza INTRO (secuencia CRLF) como separador de párrafos.

Por último introducimos el código \E de fin de archivo de ayuda. El archivo aún no está terminado, pero si queremos probarlo —que es lo que vamos a hacer— deberemos introducir este código para indicar el final de fichero y no producir un error.

NOTA: Nótese como los identificadores, los títulos y demás han de ir inmediatamente después de los códigos, sin espacios en blanco. Por otro lado, decir que se pueden introducir espacios interlineales para aclarar el archivo en su conjunto, aunque los espaciados reales entre párrafos vendrán definidos por la inclusión o no de los caracteres contrabarra explicados. Al final del archivo (tras \E) no es necesario introducir un INTRO para que funcione correctamente, como ocurría en otros archivos ASCII de definición de AutoCAD 14.

NOTA: Los códigos en archivos .AHP han de escribirse obligatoriamente en mayúsculas.

SEIS.2.1. Visualización del archivo en AutoCAD

Llegados a este punto conviene explicar la manera de cargar nuestro incipiente archivo de ayuda desde AutoCAD. Como hemos visto, estos archivos son simples ficheros de texto ASCII, sin embargo para poder ser utilizados habrán de ser manejados desde una aplicación AutoLISP (o ARX). Por ello, mencionaremos simplemente aquí la función AutoLISP que nos permite visualizar estos archivos de ayuda, dejando su estudio en profundidad para el MÓDULO de programación en AutoLISP.

La función en cuestión es HELP, y habrá de ser introducida en la línea de comandos de AutoCAD 14 en el formato adecuado, es decir entre paréntesis. A esta función hay que proporcionarle como argumento el nombre del archivo .AHP de ayuda entre comillas (por ser una cadena de texto) y, opcionalmente y si fuera necesario, la ruta de acceso. Así, una vez guardado el archivo con la extensión .AHP, lo cargaremos introduciendo lo siguiente en línea de comandos (suponemos que se llama PRUEBA.AHP):

(HELP "prueba.ahp")

La extensión .AHP no es necesaria, aunque el autor de este curso siempre recomienda incluir todas la extensiones aún no siendo obligatorio, y todo ello por claridad.

Pero cuidado, ya que si tenemos que introducir una ruta de acceso o camino, la manera de hacerlo ha de ser en formato AutoLISP, esto es, escribiendo barras normales (/) en lugar de contrabarras (\) para separar directorios o carpetas. Por ejemplo:

(HELP "c:/autocad/ayuda/prueba.ahp")

También pueden ser utilizadas dos contrabarras seguidas (\\); la primera representa el carácter de introducción de códigos de control en AutoLISP y la segunda el propio carácter contrabarra en sí. Por ejemplo:

(HELP "c:\\autocad\\ayuda\\prueba.ahp")

De cualquiera de las formas sería válida la entrada.

NOTA: Como ya hemos de saber, para que un archivo no requiera ruta de acceso ha de encontrarse en uno de los directorios de soporte de AutoCAD 14 definidos bajo Herr>Preferencias....

NOTA: Esta función de AutoLISP para llamar a archivos de ayuda puede ser incluida como macroinstrucción en opciones de menú o en botones de barras de herramientas, por ejemplo. De esta manera el usuario no habrá de escribir la línea explicada para recurrir a la ayuda de un programa nuevo. Como veremos más adelante, puede ser más conveniente en programas pequeños que manejen una interfaz de cuadro de diálogo en DCL o VBA, incluir la función de ayuda en un propio botón del cuadro, por ejemplo.

Tras cargar un archivo .AHP en AutoCAD, en el mismo directorio donde se encuentra dicho archivo se crea otro con el mismo nombre y de extensión .HDX. Este archivo es el denominado de índice de ayuda y es creado para gestionar con mayor rapidez la ayuda. Siempre se recomienda eliminar este archivo al introducir cambios en el .AHP para garantizar su actualización, sin embargo esto no es en absoluto necesario y puede llegar a resultar algo pesado. Aún así, al terminar por completo la edición de un fichero .AHP de ayuda de AutoCAD, se puede borrar y volver a cargar la ayuda para conseguir un .HDX final nuevo y actualizado.

Una vez realizado esto, y si no hay ningún problema, debería aparecer en pantalla la ventana de ayuda (Ayuda de AutoCAD) con nuestro índice creado. En la parte superior de esta ventana podemos distinguir cuatro botones principales. El botón Índice siempre nos llevará al primer tema definido en el archivo .AHP (bajo el primer identificador \#). Es por ello que suele ser práctica conveniente establecer un primer tema como índice de los demás.

El botón Buscar, por su lado, abre una segunda ventana en la que aparecen varios campos. La utilización de este cuadro es bien sencilla. Deberemos escoger cualquier palabra del cuadro de lista superior y pulsar el botón Mostrar temas. Las palabras que aparecerán en este cuadro de lista serán las indicadas como palabras clave tras los códigos \K en el archivo .AHP de definición. Una vez pulsado el botón aparecerán en el siguiente cuadro de lista (el inferior) todos los temas relacionados con la palabra clave en cuestión. Estos temas son los especificados tras los códigos \$. Para visualizar un tema deberemos escogerlo de este segundo cuadro de lista y pulsar el botón Ir a. También podemos introducir una cadena en la casilla de edición superior.

Por lo que se ha dicho se comprende que es posible introducir la misma palabra clave en diferentes temas de archivo. Este es el típico funcionamiento de un archivo de ayuda Windows: tras introducir una palabra clave (\K) se nos muestran todos los temas (\$) con los que está relacionada, es decir, donde está especificada.

El botón Atrás solamente estará disponible en el caso de que se haya visitado algún tema ya. Si así es, este botón nos llevará al tema anterior visualizado.

Y el botón Historial despliega otro cuadro de diálogo en el que se muestran todos los temas visitados y el orden en que fueron visionados. Así podemos elegir cualquiera de los vistos anteriormente y volver a él pulsado el botón Ir a.

En la parte central de la ventana de ayuda se muestra el texto correspondiente al tema en cuestión en el que nos hallamos. El cuadro general se cierra con el botón Aceptar.

NOTA: Cuando se estudie la función HELP de AutoLISP a fondo en el MÓDULO correspondiente, veremos otras características, como hacer que la ayuda arranque directamente en la ventana de búsqueda, por ejemplo.

SEIS.2.2. Introduciendo más temas

Por ahora sólo hemos escrito un índice en nuestro archivo de ayuda. Vamos ahora pues a introducir los diferentes temas que proporcionarán la ayuda real. El tema para el primer nuevo comando podría ser el siguiente:

\#helice
\$Nuevo comando HÉLICE
\Khélice;comandos nuevos;dibujo;paso;altura;precisión;vueltas;centro;radio
COMANDO HÉLICE\
--------------
Este comando dibuja una curva helicoidal en 3D mediante una\
3DPOL. Para ello se sirve de un cuadro de diálogo que le\
solicitará los siguientes datos:

* Radio inicial\
* Radio final (si es diferente al inicial)\
* Altura o paso\
* Número de vueltas\
* Precisión de cada vuelta en puntos
* Centro de la hélice

Una vez introducidos los datos, pulse el botón "Aceptar"\
y la curva será dibujada.
Si se produce algún error en la introducción de datos,\
el programa presentará un mensaje de error en el propio\
cuadro de diálogo, y no se podrá continuar hasta que\
se subsane.

Aquí podemos apreciar la manera de separar entre sí las diferentes palabras clave, esto es con un carácter punto y coma (;). Las líneas se han sangrado con tabulaciones que, posteriormente serán de cuatro caracteres de longitud en la ventana de ayuda.

Si ahora nos fijamos en la ventana de búsqueda, podremos observar todas las nuevas palabras clave introducidas ordenadas por orden alfabético. Al elegir una de ellas aparecerá en la siguiente lista el tema asociado (al igual que en la lista del historial de temas visitados).

NOTA: El recurso de la contrabarra no se utiliza como se ha indicado aquí. Bajo el siguiente epígrafe de este MÓDULO se explicará su uso real.

Veamos la ayuda al siguiente comando nuevo creado:

\#tuerca
\$Nuevo comando TUERCA
\Ktuerca;comandos nuevos;dibujo;radio;centro
COMANDO TUERCA\
--------------
Este comando dibuja una tuerca en planta.\
Para ello se sirve de un cuadro de diálogo que le\
solicitará los siguientes datos:
\ +++ Ahora se muestran los datos que se preguntarán +++
* Radio interior\
* Radio exterior\
* Centro de la tuerca
Una vez introducidos los datos, pulse el botón "Aceptar"\
y la tuerca será dibujada.
\ +++ Ahora se explica el tratamiento de errores del cuadro +++
Si se produce algún error en la introducción de datos,\
el programa presentará un mensaje de error en el propio\
cuadro de diálogo, y no se podrá continuar hasta que\
se subsane.

Fijémonos ahora en la lista de búsqueda al pulsar Mostrar temas tras elegir, por ejemplo, la clave comando nuevo o la clave radio. Como ambas claves se encuentran definidas en ambos temas escritos hasta ahora, en la lista de estos aparecerán los dos. Tras elegir uno de ellos pulsaremos Ir a para visualizarlo.

Observando el código del archivo podemos ver también que se han introducido dos comentarios aclaratorios. Como hemos dicho estos comentarios hay que precederlos del carácter contrabarra y de un espacio blanco (\ ) como mínimo. Los comentarios en un archivo .AHP pueden colocarse en cualquier punto, a excepción de inmediatamente detrás de la directriz que contenga el código de claves \K, es decir, justo donde habría de comenzar el texto de la ayuda. Si así se hace, el comentario no será ignorado y aparecerá en pantalla.

Como último tema del archivo de ayuda de nuestro ejemplo, introduciremos el correspondiente al nuevo comando TORNILLO. Así, al final, el archivo .AHP completo sería el que se muestra a continuación:

\#index
\$ÍNDICE DE CONTENIDOS
\Kíndice
1. Nuevo comando HÉLICE.\
2. Nuevo comando TUERCA.\
3. Nuevo comando TORNILLO.\

\#helice
\$Nuevo comando HÉLICE
\Khélice;comandos nuevos;dibujo;paso;altura;precisión;vueltas;centro;radio
COMANDO HÉLICE\
--------------
Este comando dibuja una curva helicoidal en 3D mediante una\
3DPOL. Para ello se sirve de un cuadro de diálogo que le\
solicitará los siguientes datos:
* Radio inicial\
* Radio final (si es diferente al inicial)\
* Altura o paso\
* Número de vueltas\
* Precisión de cada vuelta en puntos
* Centro de la hélice
Una vez introducidos los datos, pulse el botón "Aceptar"\
y la curva será dibujada.
Si se produce algún error en la introducción de datos,\
el programa presentará un mensaje de error en el propio\
cuadro de diálogo, y no se podrá continuar hasta que\
se subsane.

\#tuerca
\$Nuevo comando TUERCA
\Ktuerca;comandos nuevos;dibujo;radio;centro
COMANDO TUERCA\
--------------
Este comando dibuja una tuerca en planta.\
Para ello se sirve de un cuadro de diálogo que le\
solicitará los siguientes datos:
\ +++ Ahora se muestran los datos que se preguntan +++
* Radio interior\
* Radio exterior\
* Centro de la tuerca

Una vez introducidos los datos, pulse el botón "Aceptar"\
y la tuerca será dibujada.
\ +++ Ahora se explica el tratamiento de errores del cuadro +++
Si se produce algún error en la introducción de datos,\
el programa presentará un mensaje de error en el propio\
cuadro de diálogo, y no se podrá continuar hasta que\
se subsane.

\#tornillo
\$Nuevo comando TORNILLO
\Ktornillo;comandos nuevos;dibujo;radio;centro;vástago;longitud
COMANDO TORNILLO\
----------------
Este comando dibuja un tornillo en alzado.\

Para ello se sirve de un cuadro de diálogo que le\
solicitará los siguientes datos:
* Métrica\
* Longitud del vástago\
* Tipo
Una vez introducidos los datos, pulse el botón "Aceptar"\
y el tornillo será dibujado.
Si se produce algún error en la introducción de datos,\
el programa presentará un mensaje de error en el propio\
cuadro de diálogo, y no se podrá continuar hasta que\
se subsane.

\ +++ Final del archivo de definición +++

\E

NOTA: Como ya hemos comentado se podían haber introducido diferentes espaciados interlineales para dar una mayor claridad al archivo.

SEIS.2.3. Retornos suaves, tabulaciones y sangrías

El lector de ayuda de AutoCAD 14 reconoce diferentes formatos especiales de escritura que luego interpreta para generar una presentación en pantalla. Dos de estos formatos ya los hemos visto: el retorno suave, que se sirve de la contrabarra (\) para evitar el interlineado blanco entre párrafos, y las tabulaciones, las cuales son convertidas a espaciados de cuatro caracteres en la ventana de ayuda de AutoCAD. El tercer formato dice relación a las sangrías de párrafo y puede ser asaz interesante para formatear nuestro texto.

Con respecto al retorno suave, comentar que, como ya hemos dicho, no se utiliza exactamente como se ha explicado anteriormente. La contrabarra realiza la unión entre dos párrafos diferentes. Si introducimos una contrabarra al final de cada línea estamos indicando que cambiamos de párrafo cada vez, y eso no es real.

La manera de escribir cada párrafo en un archivo .AHP es de forma continua, es decir, sin producir saltos de línea con retorno de carro hasta cambiar de párrafo. Comenzamos a escribir —por ejemplo en un editor como Microsoft Bloc de notas— y continuamos aunque se produzca un desplazamiento horizontal de la pantalla hacia la izquierda y ya no veamos el comienzo de la línea. En el momento en que queramos cambiar de párrafo podemos pulsar INTRO.

NOTA: Como sabemos, si en editores tipo Bloc de notas activamos la opción Ajuste de línea (en Bloc de notas se llama así, en otros puede que reciba otro nombre), la longitud de las líneas se adapta al tamaño de la ventana de texto, sea ésta cual sea. De este modo tenemos una total visualización del texto representado en varias líneas, aunque internamente sólo se encuentre en una (sin saltos de línea con retorno de carro).

Al escribir el texto así, posteriormente AutoCAD se encarga de darle el formato adecuado según las dimensiones de la ventana de ayuda. Aparentemente parece que el resultado es el mismo haciéndolo así o con caracteres contrabarra (\), sin embargo podremos comprobar que si queremos darle al texto algún formato especial como una sangría (que ahora veremos), sólo funcionará si lo hacemos correctamente, es decir, todo en una línea. Esto es evidente ya que si separamos con contrabarra se entiende que es otro párrafo.

Con respecto a las tabulaciones no haremos ningún comentario más que lo explicado, ya que es lo único relevante, es decir, que al introducir una tabulación en nuestro texto, ésta se interpretará y representará como un espaciado de cuatro caracteres.

Y por último, las sangrías de párrafo son interpretadas también de una manera especial por el lector de ayuda de AutoCAD. Para ajustar estos párrafos con sangría, el lector de la ayuda alinea el texto según la última tabulación. Este formato maneja las listas de puntos y las numeradas bastante bien, pero precisa de una técnica especial cuando la etiqueta inicial es más larga de lo habitual. En el siguiente ejemplo vemos cómo conseguir una sangría francesa de un párrafo (los símbolos ® indican la situación de una tabulación del usuario; los símbolos ¶ indican la situación de un INTRO del usuario, donde no haya este símbolo no se produce salto de línea con retorno de carro):

® 1. ® Esto es un ejemplo de una sangría francesa. La manera de utilizar
este método consiste en la introducción de una tabulación al principio de
la línea, una etiqueta significativa y otra tabulación. A continuación se
escribe el texto completo en una línea, es decir, sin saltos de carro.\¶

® 2. ® Ahora podemos comenzar otra línea, y así sucesivamente...

El resultado de este código sería el siguiente:

Con las etiquetas de longitud de caracteres mayor de lo habitual la sangría no queda correcta si se utiliza este método. Es por ello que se recurre a un pequeño truco para amoldarlas a un formato agradable. Veamos un ejemplo (se utiliza la convención de símbolos mencionada anteriormente):

PUNTO PRIMERO ® En este ejemplo se muestra la técnica precisa para\¶
® ® ® realizar una sangría de etiquetas amplias. Esta técnica consiste
en escribir la etiqueta e introducir una tabulación. A continuación se
escribe la longitud aproximada de una línea y se realiza un cambio de
párrafo sin espaciado interlineal, esto es con el carácter contrabarra.
En la siguiente línea se introducen tres tabulaciones y se continúa escribiendo todo en una sola línea (sin INTRO hasta el final del párrafo).¶
PUNTO SEGUNDO ® Ahora podemos continuar con otro párrafo realizando\¶
® ® ® la misma operación...

El resultado sería:

PUNTO PRIMERO En este ejemplo se muestra la técnica precisa para

Con todo lo explicado el principio del archivo de ayuda de nuestro ejemplo que hemos desarrollado anteriormente sería más lógico escribirlo de la siguiente forma (se utiliza la misma convención explicada para los símbolos):

\#index¶

\$ÍNDICE DE CONTENIDOS¶
\Kíndice¶
® 1. ® Nuevo comando HÉLICE.\¶
® 2. ® Nuevo comando TUERCA.\¶
® 3. ® Nuevo comando TORNILLO.\¶
¶
\#helice¶
\$Nuevo comando HÉLICE¶
\Khélice;comandos nuevos;dibujo;paso;altura;precisión;vueltas;centro;
radio¶
COMANDO HÉLICE\¶
--------------¶
Este comando dibuja una curva helicoidal en 3D mediante una
3DPOL. Para ello se sirve de un cuadro de diálogo que le
solicitará los siguientes datos:¶
® * Radio inicial\¶
® * Radio final (si es diferente al inicial)\¶
® * Altura o paso\¶
® * Número de vueltas\¶
® * Precisión de cada vuelta en puntos¶
® * Centro de la hélice
Una vez introducidos los datos, pulse el botón "Aceptar"
y la curva será dibujada.¶
Si se produce algún error en la introducción de datos,
el programa presentará un mensaje de error en el propio
cuadro de diálogo, y no se podrá continuar hasta que
se subsane.¶
¶
\#tuerca¶
\$Nuevo comando TUERCA¶
\Ktuerca;comandos nuevos;dibujo;radio;centro¶

...

SEIS.2.4. Vínculos de hipertexto

Una característica muy interesante de los archivos .AHP de ayuda de AutoCAD 14 es la posibilidad de incluir vínculos de hipertexto en los mismos. Estos vínculos se visualizarán encerrados entre pares de corchetes angulares (<< y >>) y al hacer doble clic sobre ellos mostrarán la pantalla de ayuda que tengan enlazada.

Existen dos tipos de vínculos de hipertexto para archivos .AHP: los denominados de salto de tema y los desplegables. La sintaxis para los primeros es:

<<Texto_del_hipervículo>>Identificador_de tema>

y la sintaxis para los desplegables es:

<<Texto_del_hipervículo>>Identificador_de tema]

La diferencia entre ambos es que los de salto de tema muestran la ayuda en la misma ventana del visor de ayuda de AutoCAD, mientras que los desplegables abren otra ventana para realizar la misma operación.

Así por ejemplo, nos habremos percatado al visualizar nuestro ejemplo de este MÓDULO, que resulta engorroso tener el índice delante y no poder acceder a los diferentes temas desde ahí mismo. Lo que hacíamos era dirigirnos a la ventana de búsqueda para visualizar los diferentes temas según palabras clave. De esta forma, si escribiéramos el índice así:

\#index
\$ÍNDICE DE CONTENIDOS
\Kíndice
<<1. Nuevo comando HÉLICE.>>helice>\
<<2. Nuevo comando TUERCA.>>tuerca>\
<<3. Nuevo comando TORNILLO.>>tornillo>\

en la pantalla se mostrarían las líneas encerradas entre los pares de corchetes angulares significando la presencia de un hiperenlace. Para acceder al tema enlazado según su identificador (la cadena tras \#) sólo hemos de hacer doble clic en la misma línea. Veremos como aparece en la misma ventana de ayuda. Otra forma de acceder es haciendo un solo clic en la línea —veremos que se activa el texto debajo de la zona de texto de ayuda que dice Escoger el tema:— y pulsar el botón Ir a de la derecha inferior del cuadro (que hasta ahora no habíamos comentado).

Si, por el contrario, hubiéramos escrito el índice con enlaces desplegables así:

\#index
\$ÍNDICE DE CONTENIDOS
\Kíndice
<<1. Nuevo comando HÉLICE.>>helice]\
<<2. Nuevo comando TUERCA.>>tuerca]\
<<3. Nuevo comando TORNILLO.>>tornillo]\

los temas implícitos no aparecerían en la misma ventana de ayuda, sino en otra que se abre sobre la anterior llamada Más ayuda sobre AutoCAD. Para cerrar esta ventana habremos de pulsar el botón Cerrar inferior. De esta forma se cierra esta última ventana dejando al descubierto la anterior con el tema que tuviera en pantalla (en este caso el índice).

Como ya hemos podido dilucidar, los vínculos de salto de tema se utilizan para acceder a diferentes secciones desde un índice, por ejemplo, mientras que los vínculos desplegables se usan a la hora de mostrar aclaraciones o ayuda complementaria sobre un tema.

Si un hipervínculo o hiperenlace ocupa varias líneas, podemos hacer doble clic en cualquiera de la líneas (o un solo clic y pulsando el botón Ir a) para acceder a su tema enlazado. Por ejemplo:

<<Este vínculo al Tema tercero\
ocupa varias líneas en el archivo\
de definición de ayuda>>tema3>

Y si existen varios vínculos en una sola línea, habremos de elegir cuál queremos visitar rotando entre temas con el botón Siguiente de la parte inferior del cuadro de ayuda (tampoco comentado hasta ahora), y pulsando al final Ir a. Mientras pulsemos Siguiente, a la izquierda irán apareciendo los diferentes enlaces incluidos en la línea de definición (a la derecha de la etiqueta Escoger tema:); cuando hayamos elegido, como decimos, pulsaremos Ir a. Evidentemente, en estos casos un doble clic en una línea con varios enlaces implícitos no tendrá ningún efecto.

NOTA: No se pueden incluir vínculos en pantallas nacidas desplegables de otros vínculos, es decir, en una ventana Más ayuda sobre AutoCAD no se pueden escribir hiperenlaces; ojo, sí se puede, pero no funcionarán. Por lo tanto no interesa.

Como ya sabemos, por defecto AutoCAD crea el archivo de índice (.HDX) en el mismo directorio que el archivo de ayuda. No obstante, si se está utilizando un archivo de ayuda que se encuentra en un directorio de sólo lectura (como en una unidad de red restringida o en un CD-ROM), no se puede crear el archivo de índice. Para solucionar este problema habremos de crear un archivo de índice ficticio en otro directorio (con escritura permitida) del camino de soporte, así AutoCAD creará el archivo de índice real en ese otro directorio. Por ejemplo, si se introducen los siguientes comandos tras el prompt de MS-DOS, se crea un archivo de índice ficticio para el archivo MIAYUDA.AHP en el directorio \SUPPORT\ del programa:

echo dummy > \autoca~1\support\miayuda.hdx

A continuación se describe cómo AutoCAD 14 ubica el archivo .HDX. Se puede determinar que AutoCAD sitúe dicho archivo en cualquier sitio de la ruta de soporte, colocando un .HDX ficticio en dicho directorio. Veamos la descripción:

Primero se busca el archivo de ayuda de AutoCAD. Si se puede escribir un archivo de índice en ese directorio se hace, de lo contrario, se continúa con lo siguiente. Se busca un archivo de índice con ese nombre en el camino de soporte. Si se encuentra un archivo de índice existente y se puede abrir para modificar se hace, de lo contrario, continúa buscando en el camino de soporte. Si no encuentra un archivo de índice que se pueda escribir, se continúa con lo siguiente. Se busca el archivo ACAD14.CFG en el camino de soporte. Si se encuentra y puede escribirse el archivo de índice en dicho directorio se hace, en caso contrario AutoCAD no podrá escribir un archivo de índice y no se mostrará el archivo de ayuda. Todas las veces que se intente cargar el archivo de ayuda se producirá el mismo proceso.

De todo ello se desprende que, al crear un archivo ficticio en un directorio de soporte, AutoCAD 14 no tendrá problema alguno para crear en dicho directorio el archivo .HDX real.

NOTA: El mensaje Help index in: XXXXXX, siendo XXXXXX el camino donde se encuentra el archivo de índice, aparece en la línea de comandos para indicar dónde se ha escrito el archivo.

SEIS.3. FORMATO WINDOWS. ARCHIVOS .HLP

Los denominados archivos de ayuda WinHelp son los originales archivos .HLP de Microsoft Windows 95/98 y Windows NT. Estos archivos de ayuda podemos encontrárnoslos casi en el 100% de la aplicaciones que corren bajo entorno Windows y resultan muy cómodos de crear y visualizar.

NOTA: La norma sobre el formato de presentación de los textos de ayuda en Windows 98 ha variado con respecto a Windows 95, si embargo el fundamento sigue siendo el mismo.

Los archivos .HLP pueden contener texto, imágenes y objetos multimedia, por lo que la ayuda se transforma en un sistema eficaz de aprendizaje. Además, se puede potenciar su funcionalidad mediante macros WinHelp y funciones API, convirtiéndolos en una poderosa herramienta de documentación. Estos archivos suponen el formato ideal para documentación que no se actualiza con frecuencia.

NOTA: Las llamadas al API de Windows son llamadas a bibliotecas DLL. Cualquiera que entienda algo de programación visual para Windows sabrá a qué nos estamos refiriendo. Aunque tampoco nos importa demasiado.

Para crear archivos .HLP necesitamos una aplicación denominada Microsoft Help Workshop. Ésta es capaz de compilar archivos en formato RTF (texto enriquecido) para convertirlos en archivos WinHelp .HLP. Para conseguir esta aplicación nos podemos dirigir directamente a Microsoft; además también se proporciona en entornos de desarrollo como Microsoft Visual Basic 5.0.

NOTA: En esta sección no se pretende proporcionar un manual completo sobre el funcionamiento de Microsoft Help Workshop, sino sentar unas bases o directrices para la utilización de archivos de ayuda WinHelp propios con AutoCAD 14. La política que ha seguido el autor de este curso con respecto a la personalización y la programación de AutoCAD, consiste en explicar profundamente todo aquello que podemos tener a nuestro alcance, es decir, que se proporciona junto con AutoCAD 14. El resto —excepto honrosas excepciones—escapa a los objetivos del curso en sí y siempre será comentado, evidentemente está ahí, pero con menor alcance.

SEIS.3.1. Microsoft Help Workshop

Microsoft Help Workshop, como hemos dicho, compila archivos .HLP a partir de archivos de texto de formato enriquecido .RTF (con códigos específicos). Este formato en uno de los estándares de salida de Microsoft Word, por lo que esta aplicación se ha convertido en abanderado de desarrolladores de ayuda en formato WinHelp. No obstante es posible codificar estos archivos manualmente o con otras aplicaciones.

Justo antes de compilar un archivo de ayuda se crea un llamado archivo de proyecto .HPJ que contiene las definiciones la todos los archivos .RTF que se incluirán en el .HLP final, además de otros parámetros como ubicaciones de archivos gráficos, definiciones de macros, colores de la ventana de ayuda, etcétera.

Los archivos WinHelp .HLP, y aunque parezca lo contrario, no son ejecutables, es decir, no pueden ejecutarse por sí solos. Necesitan de una aplicación llamada Ayuda de Windows, cuyo ejecutable es WINHLP32.EXE, para poder ser corridos. Lo que ocurre es que podemos hacer doble clic en ellos porque su extensión (.HLP) está asociada con dicha aplicación. Esto ocurre con casi todos los archivos de las diferentes aplicaciones (y se puede personalizar en Windows), al igual que con los .DWG de AutoCAD.

Estos archivos .HLP utilizan el cuadro de diálogo Temas de ayuda de la aplicación Ayuda de Windows para mostrar en un principio las pestañas Contenido, Índice y Buscar. La pestaña contenido proporciona una interfaz con los diferentes temas de ayuda contenidos en uno o varios archivos .HLP. Las entradas y presentación de la pestaña Contenido están definidas en un archivo .CNT de contenido. La potencia de personalización de estos archivos nos permitirá añadir nuevos temas a esta pestaña de contenidos, que no serán otra cosa que nuestros propios archivos .HLP.

SEIS.3.2. Añadiendo temas a la pestaña Contenido

Para añadir nuevos temas (archivos .HLP) a la pestaña Contenido del cuadro de ayuda propio de AutoCAD 14, lo que debemos hacer el crear un archivo de contenido llamado INCLUDE.CNT en el subdirectorio \HELP\ de AutoCAD 14. Este archivo contendrá únicamente secuencias :INCLUDE para llamar a otros archivos .CNT contenedores de los temas en cuestión; de la siguiente manera:

:INCLUDE nombre_archivo.CNT

Así, las siguientes líneas de un archivo INCLUDE.CNT incluirían los temas definidos en los diferentes archivos .CNT en la pestaña Contenido de la ayuda de AutoCAD:

:Include miayuda.cnt
:Include help123.cnt
:Include NCHélice.cnt
:TuercaHelp.cnt

NOTA: Después de modificar el archivo INCLUDE.CNT o cualquier otro archivo .CNT al que se haga referencia, es necesario eliminar el archivo ACAD.GID para que los cambios surtan efecto. Más adelante se comentará la misión de cada tipo de archivo.

SEIS.3.3. Añadiendo temas a Índice y Buscar

Evidentemente también disponemos de la posibilidad de añadir nuestros archivos adicionales a las listas de búsqueda por palabras clave y de índice. Para ello utilizaremos la secuencia :INDEX en la forma expuesta en el siguiente ejemplo:

:Index Estándares=estándar.hlp
1 Estándares de oficina
2 Arquitectura
3 Vista general=arq_presen@estándar.hlp
3 Diseño=arq_diseño@estándar.hlp
3 Dibujo=arq_dibujo@estándar.hlp
3 Informes=arq_infor@estándar.hlp
2 Ingeniería
3 Vista general=ing_presen@estándar.hlp
3 Diseño=ing_diseño@estándar.hlp
3 Dibujo=ing_dibujo@estándar.hlp
3 Informes=ing_infor@estándar.hlp
2 Asesoría del personal
3 Vista general=pers_presen@estándar.hlp

Así se facilita el acceso al archivo ESTÁNDAR.HLP. No deberemos olvidar incluir una línea como la que sigue en el archivo INCLUDE.CNT dentro de la carpeta \HELP\ del directorio de AutoCAD 14:

:Include estándar.cnt

NOTA: Los números del ejemplo representan niveles de anidación: 1 es un tema de contiene otros tres temas —los tres números 2—, y los números 3 son los documentos de la ayuda.

Tampoco olvidaremos suprimir el archivo ACAD.GID.

A continuación se muestra una tabla con los tipos de archivos que utiliza el sistema de ayuda de Windows 95/98:

Tipo de archivo (extensión) ---- Descripción

-----------------------------------------------------------------------------------------------------

.RFT ---------------------------- Archivo fuente para Microsoft Help Workshop.

.HPJ ---------------------------- Archivo de proyecto de Microsoft Help Workshop.

.HLP ---------------------------- Archivo objeto compilado de ayuda WinHelp.

.CNT ---------------------------- Archivo de contenido de Microsoft Help Workshop.

.GID ---------------------------- Archivo de configuración WinHelp. Archivo binario
--------------------------------- creado por el ejecutable WINHLP32.EXE. Contiene
--------------------------------- información sobre el archivo de ayuda que incluye
--------------------------------- vínculos de los archivos de contenido, nombres de
--------------------------------- todos los archivos de ayuda incluidos, palabras clave
--------------------------------- y ubicación de los archivos.

.FTS ---------------------------- Archivo de búsqueda de texto en la pestaña Índice.
--------------------------------- Archivo binario creado por el ejecutable
--------------------------------- WINHLP32.EXE la primera vez que ejecuta una
--------------------------------- búsqueda de texto en el índice.

.FTG ---------------------------- Archivo de grupos de búsqueda de texto. Archivo
--------------------------------- binario creado por el ejecutable WINHLP32.EXE.

Y a continuación se proporciona otra tabla que muestra los diferentes archivos de ayuda básicos que proporciona AutoCAD 14 en su paquete de software:

Archivo ------------ Contenido

--------------------------------------------------------------------

ACAD.CNT ---------- Contenido de temas de ayuda
ACAD.HLP ---------- Referencia de comandos
ACAD_CG.HLP ------ Manual de personalización
ACAD_IG.HLP ------ Manual de instalación
ACAD_UG.HLP ------ Manual del usuario
ACAD_AG.HLP ------ Manual de ActiveX Automation
ACADAUTO.HLP ----- Referencia de ActiveX Automation
README.HLP ------- Documento Readme
DOCCHECK.HLP ----- Publicaciones técnicas de AutoCAD

SEIS.3.4. Utilizar los archivos .HLP desde AutoCAD

Existen varias formas de llamar a un .HLP desde una macro de un botón, una opción de menú, un programa de AutoLISP o un programa VBA, entre otros. A lo largo de este curso se verán diferentes funciones y comandos que nos ayudarán a hacerlo. Por ahora digamos únicamente que con los archivos .HLP se puede utilizar la función HELP de AutoLISP al igual que con los .AHP.

También veremos que incluso podemos crear una orden externa de AutoCAD 14 que ejecute la ayuda.

Por último, decir que en el CD-ROM de instalación de AutoCAD 14, en el directorio \BONUS\UTILS\ existe un pequeño programa que corre bajo MS-DOS llamado AHP2HLP.EXE. Este programa convierte archivos .AHP de ayuda de AutoCAD a archivos WinHelp .HLP. Evidentemente, el compilador HCW.EXE (Help Compiler Workshop) de Microsoft Help Workshop ha de estar presente, o en su defecto el HCP.EXE. Es muy fácil de utilizar.

SEIS.4. AYUDA EN FORMATO HTML

Este es el último tipo de formato de ayuda para AutoCAD 14 que vamos a estudiar. Parece ser que últimamente se está produciendo un furor —no muy generalizado aún— por la presentación de la documentación en línea de las aplicaciones en formato HTML, esto es, en el mismo lenguaje que se definen los diferentes elementos de una página Web. Categóricamente HTML no puede ser considerado como un lenguaje de programación, ya que no posee las características propias de estos (posibilidad de definir y declarar variables y/o constantes, escritura de estructuras alternativas, de estructuras repetitivas, de estructuras condicionales y un largo etcétera). Sin embargo, el Lenguaje de Marcas de Hipertexto es una herramienta potente y versátil para la presentación de documentos en pantalla; con la posibilidad de introducción de textos e imágenes, así como de elementos multimedia.

La única desventaja —que no lo es— de HTML es la imperiosa necesidad de poseer instalado en nuestro equipo un navegador WWW o browser del tipo Microsoft Internet Explorer o Netscape Navigator (ambos gratuitos, por lo que por lo menos desembolso económico no nos supondrá).

Amén de todo esto, los archivos HTML son fácilmente actualizables sin necesidad de reinstalar o actualizar aspecto alguno en el sistema local. Además de la propia actualización on-line vía Internet.

SEIS.4.1. Añadiendo temas HTML a Contenido

Podemos añadir archivos HTML propios o vínculos a páginas Web de Internet a la pestaña Contenido del sistema de ayuda de AutoCAD, de forma similar a como lo hacíamos con los ficheros .HLP. Por ejemplo, para poder acceder con facilidad a la documentación HTML TEMA1.HTM, TEMA2.HTM y TEMA3.HTM, además de a varias páginas Web de la Red de Redes, crearemos el archivo MASAYUDA.CNT, por ejemplo, con el contenido siguiente:

1 Ayuda adicional
2 Nuestra información
3 Tema 1=!EF("tema1.htm","",4)
3 Tema 2=!EF("tema2.htm","",4)
3 Tema 3=!EF("tema3.htm","",4)
2 Sitios relacionados con la WWW
3 CodifInfo=!EF("http://www.CodifInfo.com","",4)
3 VigasRUs=!EF("http://www.VigasRUs.com","",4)
3 LosOtrosColaboradores=!EF("http://www.otros.es"",4)

A continuación añadiremos lo siguiente al archivo INCLUDE.CNT, en el directorio \HELP\ de AutoCAD 14:

:Include masayuda.cnt

Ahora, suprimiremos el archivo ACAD.GID. La próxima vez que se ejecute el archivo ACAD.HLP, seleccionando por ejemplo Temas de Ayuda de AutoCAD desde el menú ?, aparecerán las nuevas entradas a continuación de las existentes.

La forma de utilizar estos archivos es la misma que la anteriormente expuesta.

Y por último, recordar que en la sección ***HELPSTRINGS de los archivos de definición de menús se pueden introducir diferentes textos (pequeñas cadenas) de ayuda contextual. No es lo mismo que definir un archivo completo de ayuda en línea, pero sí habrá de servir como complemento.

SEIS.5. EJEMPLOS PRÁCTICOS DE ARCHIVOS DE
AYUDA

NOTA: Se utilizan las mismas convenciones de sintaxis explicadas: ® para las tabulaciones y ¶ para los INTRO; en el final de línea sin este último símbolo no se da un salto de línea con retorno de carro.

SEIS.5.1. Ayuda a nuevos comandos creados

\#indic¶
\$Índice¶
\KÍndice¶
<<Nuevo comando ESPIRAL.>>espiral>\¶
<<Nuevo comando CIRCCON.>>circcon>\¶
<<Nuevo comando ESTRELLA.>>estrella>\¶
<<Nuevo comando HÉLICE3D.>>helic3d>\¶
¶
\#espiral¶
\$Nuevo comando ESPIRAL¶
\Kespiral;semicírculos;paso;radio;espiral, comandos nuevos:¶
COMANDO ESPIRAL\¶
---------------¶
® ESPIRAL dibuja una falsa espiral formada por semicírculos. Se genera
siempre en sentido horario, a partir de un centro, con un radio inicial y
un paso.¶
® Abreviatura del comando: ESP\¶
® Comando relacionado: <<HÉLICE3D>>helic3d>¶
¶
\#circcon¶
\$Nuevo comando CIRCCON¶
\Kcirccon;círculos;concéntricos;radio;circcon, comandos nuevos:¶

COMANDO CIRCCON\¶
---------------¶
® CIRCCON dibuja círculos concéntricos respecto a un punto central.
El programa solicita el número de círculos concéntricos que serán
generados. Se señala luego el punto central y después los radios interior
y exterior. El programa distribuye los círculos concéntricos de forma
equidistante.¶
® Abreviatura del comando: CC¶
¶
\#estrella¶
\$Nuevo comando ESTRELLA¶
\Kestrella;puntas;estrella, centro de;radio;estrella, comandos nuevos:¶
COMANDO ESTRELLA\¶
----------------¶
® ESTRELLA dibuja una estrella a base de líneas, indicando el centro, los
dos radios entre los que se distribuyen las puntas y el número de éstas.
Según ambos radios tengan el mismo signo o se indique uno de ellos
negativo, el aspecto de la estrella resultante cambia.¶
® Abreviatura del comando: ET
¶
\#helic3d¶
\$Nuevo comando HÉLICE3D¶
\Khélice3d;cable;paso;sección;hélice3d, comandos nuevos:¶
COMANDO HÉLICE3D\¶
----------------¶
® HÉLICE3D dibuja una hélice o arrollamiento de cable en 3 dimensiones
mediante SUPREGLA. Presenta opciones para indicar un paso de hélice
constante, un paso proporcional al aumento o disminución de la sección, o

un apilamiento del cable. ¶
® Abreviatura del comando: 3DH\¶
® Comando relacionado: <<ESPIRAL>>espiral>¶
¶
\ *** //\\ Final del fichero //\\ ***¶
¶
\E

SEIS.5.2. Documentación sobre un comando nuevo

...

¶
\#cu¶
\$CU¶
\KCU; Conversión de unidades¶
® (CU) ® Esta rutina ofrece un menú de conversión de unidades,
ofreciendo las que se encuentran definidas en el archivo
<<ACAD.UNT>>unt]. Se puede utilizar en mitad de un comando cuando éste
solicita un valor numérico, llamando a (cu). La función (cu) no es un
nuevo comando de AutoCAD sino una <<función de usuario>>funusr]
que puede ser llamada desde mitad de un comando.¶
® La función examina si existe el archivo <<ACAD.UNT>>unt] y en caso
afirmativo llama a la función de búsqueda de grupos de unidades y, después
solicita seleccionar la opción. Llama a continuación a la función de
listado de unidades disponibles en el grupo seleccionado y por último a la función
que solicita las unidades de origen y destino. La última expresión realiza la conversión mediante <<CVUNIT>>cvunit] y el valor obtenido es el devuelto por (cu).¶
¶
\#unt¶
\$ACAD.UNT¶
\KACAD.UNT; Conversión de unidades¶
® ACAD.UNT ® Este archivo guarda las definiciones de conversión de
unidades para la función CVUNIT de AutoLISP. El archivo es ASCII y, por
lo tanto totalmente editable y personalizable. La manera de crear nuevos
grupos de conversión de unidades se explica en el mismo archivo.¶
¶
\#funusr¶
\$Función de usuario¶
\KFunción de usuario; Conversión de unidades¶
® Función de usuario ® Es una función con un determinado cometido,
definida por el programador en una aplicación AutoLISP mediante la
función inherente o "subr" DEFUN.¶
¶
\#cvunit¶
\$CVUNIT¶
\KCVUNIT; Conversión de unidades¶
® CVUNIT ® Es una función inherente o subr de AutoLISP que convierte un
valor de un tipo de unidades a otras. Su sintaxis es la siguiente:¶
(CVUNIT valor unidad_1 unidad_2)¶
siendo unidad_1 las unidades actuales de valor y unidad_2 las unidades alas cuales se desea convertir dicho valor.¶

...

\E

SEIS.FIN. EJERCICIOS PROPUESTOS

1. Crear un archivo de ayuda de AutoCAD sencillo; cualquiera.
2. Crear un archivo de ayuda con tabulaciones y sangrados.
3. Diseñar un documento de ayuda con tabulaciones, sangrados y retornos suaves.
4. Diseñar un archivo .AHP con hipervínculos de las dos clases existentes.
5. Diseñar una serie de documentos completos de ayuda para AutoCAD 14 que expliquen el diseño de los patrones de sombreado creados para el mundo de la construcción en el último ejercicio propuesto del MÓDULO CUATRO.

EJERCICIO I

*1,17,ARCFLE
12,(0,4,127),02C,05,02C,06,05,028,06,040,05,016,06,01A,0

EJERCICIO II

*2,6,MECA
05,015,06,013,020,0

EJERCICIO III

*3,4,JAL
034,01F,019,0

EJERCICIO IV

*4,20,HELI
054,010,02C,020,024,010,05C,018,024,028,02C,018,02,01A,01,074,060,07C,068,0

EJERCICIO V

*5,34,GEO
05,018,06,05,014,06,05,010,06,01C,02,01C,01,05,12,(0,4,127),06,05,12,
(0,4,-127),06,02,01C,01,038,064,060,06C,038,0 

EJERCICIO VI

*6,15,RESIS
03,2,010,04,2,013,02D,023,02D,023,01D,03,2,010,0

EJERCICIO VII

*00066,22,fminus
2,14,8,(-2,-6),034,1,030,2,023,1,016,018,01A,05C,2,050,14,8,(-4,-3),0

EJERCICIO VIII

*00051,25,qmayus
2,14,8,(-2,-6),022,1,01E,01A,018,016,044,012,020,01E,03C,01A,01E,2,020,
14,8,(-4,-3),0

EJERCICIO IX

*0004B,83,kmayit
2,14,3,2,14,8,(-25,-42),14,4,2,8,(9,21),1,8,(-6,-21),2,8,(7,21),
1,8,(-6,-21),2,8,(19,21),1,8,(-17,-13),2,8,(7,4),1,8,(4,-12),2,
8,(-5,12),1,8,(4,-12),2,8,(-10,21),1,070,2,060,1,060,2,
8,(-25,-21),1,070,2,060,1,060,2,040,14,3,2,14,8,(-21,-21),14,4,2,
0

EJERCICIO X

*97,93,alfmin
2,14,3,2,14,8,-23,-28,14,4,2,14,5,8,10,14,1,8,-3,-1,42,43,8,-1,-3,60,45,
8,3,-1,32,33,50,8,2,3,67,8,1,3,2,152,1,41,42,43,8,-1,-3,60,45,47,2,8,3,
14,1,32,47,45,8,2,-8,45,30,2,229,1,30,45,8,2,-8,45,47,16,2,8,3,0,14,6,14,
3,2,14,8,23,-18,14,4,2,0

(Ejercicio completo para resolver por técnicos y/o especialistas).