el Guille, la Web del Visual Basic, C#, .NET y más...

Crear el contenido de la ayuda

 

Publicado: 01/Jul/2007
Actualizado: 01/Jul/2007
Autor: Guillermo 'guille' Som

Parte 4 del tutorial HHW (para dnm.inicio): Crear el contenido de la ayuda.

 
 

 

Crear el contenido de la ayuda

 

Una de las cosas que debemos hacer es crear el fichero de contenido, es decir, la lista de tópicos que se mostrarán en el panel de navegación.

Para crear un fichero de contenido, tendremos que pulsar en la ficha Contents de la ventana principal de HTML Help Workshop, al hacerlo, nos preguntará si queremos crear un fichero de contenido o usar uno existente (figura 1).

Figura 1. Crear o usar un fichero de contenido
Figura 1. Crear o usar un fichero de contenido

Si pulsamos en Create a new contents file, nos mostrará un cuadro de diálogo para que indiquemos dónde lo queremos guardar, y si ya hemos estado trabajando con otros proyectos de ayuda, se usará el último directorio usado. En cualquier caso, lo mejor es seleccionar el mismo directorio en el que tenemos el fichero del proyecto de ayuda HTML.

Si ya tuviéramos un fichero creado, simplemente le decimos dónde está y se usará ese fichero de contenido.

Pero como estamos creando un nuevo proyecto de ayuda HTML, creamos uno nuevo. Al crear un nuevo fichero de contenido, tendremos en blanco esa parte y así se mostrará, tal como vemos en la figura 2, ahora lo que tenemos que hacer es llenar esa ficha de contenido.

Figura 2. La ficha del contenido de la ayuda
Figura 2. La ficha del contenido de la ayuda

 

Cuando se muestra el contenido de la ayuda HTML, normalmente lo tendremos dividido en varios apartados o secciones, cada uno de esos apartados a su vez pueden contener más apartados, y todos los apartados tendrán "tópicos" o entradas que representarán a los ficheros (o marcadores en los ficheros) que queremos mostrar cuando se pulse en ellos.

Para crear una sección o apartado, pulsaremos en el segundo icono de la barra de herramientas de la izquierda de la ventana (la que tiene el icono de una carpeta amarilla), que tal como vemos en la figura 3, nos muestra el texto Insert a heading.

Figura 3. Crear un nuevo encabezado
Figura 3. Crear un nuevo encabezado

Al pulsar en el botón Insert a heading nos mostrará un cuadro de diálogo (figura 4) en el que indicaremos el texto a mostrar y si queremos mostrar una página al pulsar en él.

Figura 4. Opciones de nuevo elemento de contenido
Figura 4. Opciones de nuevo elemento de contenido

Si decidimos usar una página a mostrar al pulsar en este "encabezado", lo podemos indicar pulsando en el botón Add, aunque por ahora no agregaremos ficheros de contenido a los apartados, esto lo haremos con los elementos que se mostrarán en cada sección.

Pulsando en la ficha Advanced podemos indicar la ventana que usaremos para mostrar ese contenido, si no indicamos nada, se usará la ventana principal (la que hemos definido como Main). Por ahora lo dejamos así, después veremos las opciones de esa ficha "avanzada".

Nota:
En las entradas de encabezados no se suele "ligar" con ninguna página en concreto, pero podemos hacerlo sin problemas, de esa forma, cuando el usuario pulse sobre el encabezado se mostrará una página de contenido. Por ejemplo, es útil cuando un tópico se subdivide en otros tópicos que están relacionados.

 

Para agregar elementos de contenido, tenemos que pulsar en el tercer botón de la barra de herramientas (Insert a page), que es el icono con una hoja que está debajo de la carpeta que usamos en el paso anterior.

Cuando pulsamos en ese icono y tenemos el primer elemento seleccionado, nos muestra un aviso de si queremos agregarlo al principio o no (figura 5). En este caso, pulsamos que no, para que el contenido se muestre debajo del apartado que creamos antes.

 

Figura 5. Aviso si queremos agregarlo al principio
Figura 5. Aviso si queremos agregarlo al principio

El cuadro de diálogo que nos muestra al pulsar en Insert a page es el mismo que vimos en la figura 4. Si pulsamos en el botón Add nos muestra un nuevo cuadro de diálogo con las páginas HTML que tenemos en el proyecto de ayuda y debemos seleccionar la que nos interese mostrar al pulsar en esa página, y como vemos en la figura 6, podemos indicar un marcador dentro de la posición.

Figura 6. Indicar la página a la que irá el tópico agregado
Figura 6. Indicar la página a la que irá el tópico agregado

Cuando pulsamos en aceptar (OK) se mostrará nuevamente el cuadro de diálogo en el que podemos seguir añadiendo más páginas o marcadores en esa misma u otra página. También podemos modificar esa entrada o algunas de las que hayamos añadido o quitarlas. Aunque, tal como vemos en la figura 7, lo habitual será que cada "hoja" solo tenga una dirección a la que navegar.

Figura 7. Editar una entrada en el contenido
Figura 7. Editar una entrada en el contenido

 

Nota:
Tal como acabo de comentar, podemos agregar varios links a una misma entrada, para saber cómo hacerlo, ver Agregar varios tópicos a una entrada en el siguiente capítulo.
Aunque esa "característica" es más habitual usarla en las entradas del índice que en la de contenido.

 

Nota:
Si el contenido de la ayuda lo creamos después de definir la ventana principal de la ayuda, debemos modificar dicha ventana de forma que indiquemos cual es el fichero de contenido.

 

La ficha Advanced la usaremos para indicar aspectos peculiares de cómo y dónde debe mostrarse el elemento que hemos indicado.

Tal como vemos en la figura 8, en la ficha avanzada podemos indicar en que ventana se mostrará, si no indicamos ninguna, se usará la ventana principal que hayamos definido o la que el propio HTML Help Workshop define.
En caso de que queramos usar una ventana especial, lo indicaremos en el campo Window. De la misma forma, si la ventana tiene definido algún "frame" (marco), lo indicaremos en el campo Frame.
Si queremos resaltar la entrada como un nuevo elemento (se mostrará un asterisco rojo junto a la entrada), marcaremos la casilla Mark as new entry (ver la figura 9).
Que nos interesa que en vez de ser un elemento normal sea una entrada de cabecera (mostrada con un libro o una carpeta, según el tipo de icono elegido en la configuración general), marcaremos la opción Change entry to heading.
Por último, podemos elegir el icono a mostrar, eso lo haremos seleccionando el índice de la imagen (Image index), que por defecto está en auto con idea de que se utilice el icono correspondiente al tipo de entrada. En total hay 42 iconos entre los que elegir.

Figura 8. Ficha avanzada de configuración de tópicos
Figura 8. Ficha avanzada de configuración de tópicos

Nota:
Cuando la entrada del contenido es una "cabecera", los valores mostrados en la ficha Advanced cambiarán, por ejemplo, en lugar de mostrar la opción Change entry to heading, se mostrará el texto Change entry to page, y el icono mostrado junto a Image index será el de una carpeta o un libro, (ver la figura 9), según hayamos configurado el estilo de los iconos en la configuración general de la ayuda.

Figura 9. Configuración avanzada de una cabecera
Figura 9. Configuración avanzada de una cabecera

 

Nota:
Al agregar una nueva entrada, podemos definir la ventana en la que se mostrará, pero "justo" al añadir esa entrada no podremos indicar el icono a mostrar, para poder especificar el icono, debemos agregar la entrada y después modificarla, para modificar una entrada, debemos seleccionar el tópico a modificar y pulsar en el botón con el icono del lápiz, tal como vemos en la figura 10.

Figura 10. Editar una entrada (tópico)
Figura 10. Editar una entrada (tópico)

 

 

Links a las otras entregas del curso:

 


Haz tu donativo a este sitio con PayPal
 

Busca en este sitio con Google
 
Google

La fecha/hora en el servidor es: 29/03/2024 6:21:47

La fecha actual GMT (UTC) es: 

©Guillermo 'guille' Som, 1996-2024