Add Help to Your Application

From Lazarus wiki
Revision as of 10:53, 12 February 2010 by Skalogryz (talk | contribs)

Deutsch (de) English (en) español (es) français (fr) русский (ru) 中文(中国大陆)‎ (zh_CN)

The LCL comes with a help system.

Quick Start

Open the example in examples/helphtml/.

This project demonstrates how to use the HTML help components. Just drop them on a form of your project. Setup the paths and create some HTML pages. Then give each control of your application a HelpKeyword.

Help Basics

The LCL help mainly consists of two parts: Help databases and help viewers. A Help Database contains the mapping from the keywords (ID, node, message, pascal, ...) to the help page (or whatever). The Help Viewer is invoked by the Help Database to show the help to the user.

A THelpDatabase manages content. It can be a collection of html pages or fpdoc xml files or a chm file or a database or whatever. A THelpViewer is a component to show help content. For example a viewer for the mime type text/html can start a webbrowser.

When help is requested the LCL queries each registered THelpDatabase and each database can return a list of entries. If several entries are returned the LCL asked the user to select one entry. Then the LCL asks the database to show the help for the entry. The database then extracts the help content and asks the LCL for an viewer that supports the mime type of the content. The viewer then shows the help content.

HTML

The LCL provides two components to use html files for help: THTMLHelpDatabase and THTMLBrowserHelpViewer. To see the html help see the lazarus example examples/helphtml/htmlhelp1.lpi.

Setup html help for your application

Adding html help to your application is easy:

  • Put a THTMLHelpDatabase on a form.
  • Set AutoRegister to true.
  • Set KeywordPrefix to HTML/. It means all keywords must start with the string HTML/.
  • Set BaseURL to file://html/. This will search the html files in the sub folder html. You can specify full paths like file:///usr/lib/yourhelp/ or an URL like http://www.yoursite.com/.
  • Put a THTMLBrowserHelpViewer on the form. This component can start the default browser of the user.
  • Set AutoRegister to true.

Creating a help entry

  • Now create the sub folder html and create a html page html/edit1.html.
  • Put a TEdit on a form.
  • Set HelpType to htKeyword
  • Set HelpKeyword to HTML/edit1.html

When running the program you can focus the edit and press F1 to invoke the help. This does not work under OS X :-(