Add Help to Your Application/es

La LCL tiene un sistema de ayuda.

Inicio rápido

Abra el ejemplo que se encuentra en examples/helphtml/.

Este proyecto muestra cómo utilizar los componentes de ayuda HTML. No tiene más que depositarlos en un formulario de su proyecto. Establezca las rutas y cree algunas páginas HTML. Después asigne a cada control de su aplicación una HelpKeyword (palabra clave de ayuda).

Lo esencial de la ayuda

La ayuda LCL se compone principalmente de dos partes: Bases de Datos de Ayuda y Visores de Ayuda. Una Base de Datos de Ayuda contiene una correspondencia entre las palabras clave (ID, node, message, pascal, ...) y la página de ayuda (o cualquiera). La Base de Datos de Ayuda llama al Visor de Ayuda para mostrar la ayuda al usuario.

HTML

La LCL proporciona dos componentes para usar ficheros html de ayuda: THTMLHelpDatabase y THTMLBrowserHelpViewer. Para ver la ayuda html vea el ejemplo en ../examples/helphtml/htmlhelp.lpi

Configurando la ayuda HTML para su aplicación

• Ponga un componente THTMLHelpDatabase en su formulario.
• Establezca AutoRegister a true.
• Establezca KeywordPrefix a HTML/. Significa que todas las palabras clave debe comenzar con la cadena HTML/.
• Establezca BaseURL a file://html/. Esto buscará los archivos HTML en la subcarpeta html. Puede especificar rutas completas como file:////usr/lib/suayuda/ o una dirección web como http://www.supaginaweb.com/.
• Coloque un THTMLBrowserHelpViewer en el formulario. Este componente iniciará el navegador predeterminado del usuario.
• Establezca AutoRegister a true.

Creación de una entrada de ayuda

• Cree ahora la subcarpeta HTML y dentro de ella el fichero html/edit1.html.
• Coloque un componente TEdit en su formulario.
• Establezca la propiedad HelpType en htKeyword.
• Establezca la propiedad HelpKeyword a HTML/edit1.html.

Cuando se ejecuta el programa sitúese sobre el campo de edición y pulse F1 para invocar la ayuda. Esto no funciona bajo OS X :-(

---

From the Free Pascal wiki, page "Add Help to Your Application/es", as it stood on 2010-02-16 after a change by Arturom, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's Licensing page. If you have concerns about this material, message the admin.