Difference between revisions of "Add Help to Your Application"

From Lazarus wiki
Jump to navigationJump to search
 
Line 5: Line 5:
 
Open the example in examples/helphtml/.
 
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 soem HTML pages as help. Then give all controls of your application, which should have Online Help a HelpKeyword.
+
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 ==
 
== 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.
 
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.

Revision as of 00:08, 20 May 2006

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.