En este manual veremos como integrar a nuestros programas hechos en Lazarus los archivos de ayuda.
¿Cómo funciona la ayuda en Lazarus?
El sistema de ayuda de la LCL (Lazarus Component Library) se compone principalmente de dos partes:
- Las bases de datos de ayuda que contienen una correspondencia entre las palabras clave y los archivos de ayuda.
- Los visores de ayuda que son invocados por las bases de datos de ayuda para mostrar las páginas al usuario.
Estas partes se encuentran representadas dentro de la LCL a través de los siguientes componentes:
- El componente THelpDatabase administra el contenido que puede ser una colección de páginas web, o archivos xml de fpdoc o un archivo chm.
- EL componente THTMLBrowserHelpViewer muestra el contenido de la ayuda, por ejemplo, un visor para el tipo "mime" text/html puede lanzar un navegador web.
Cuando se hace una petición de ayuda, la LCL hace una consulta sobre cada uno de los THelpDatabase registrados y cada uno de ellos puede devolver una lista de entradas.
La LCL solicita a la base de datos que muestre la ayuda para una entrada, la base de datos extrae la información y entonces pregunta a la LCL por un visor que soporte el tipo mime del contenido. Entonces el visor muestra la ayuda.
Configurando la ayuda para nuestra aplicación.
Para seguir este ejemplo debemos crear una nueva aplicación desde el menú Archivo->Nuevo
En el formulario del Wizard seleccionamos Proyecto->Aplicación
Los componentes THelpDatabase y THTMLBrowserHelpViewer se encuentran en la sección System de la paleta de componentes.
Ahora dentro del formulario principal colocamos un componente THelpDatabase y se establecen las siguientes propiedades:
- AutoRegister := True;
Para que la LCL considere esta base de datos cuando se hace una petición de ayuda.
- KeywordPrefix:= 'HTML/'
Todas las palabras clave deberán comenzar con este prefijo (solamente como ejemplo se eligió el prefijo 'HTML/'
BaseURL:='file://ayuda/'
Contiene la url base en donde se encuentran los archivos de ayuda. En este ejemplo se hace referencia a una carpeta llamada 'ayuda' en la ruta relativa del ejecutable. Se pueden colocar rutas absolutas del tipo 'file:///C:\mi_programa\ayuda' o 'file:///usr/lib/ayuda/'; También es posible colocar una url del tipo: 'http://www.mis_paginas.com/ayuda'
Colocamos un componente THTMLBrowserHelpViewer en el formulario y establecemos las siguientes propiedades:
- AutoRegister := True;
Para indicar que se debe utilizar este visor para mostrar la ayuda en el navegador de internet.
Con esto hemos terminado la primera parte del trabajo.