lazarus/components/chmhelp/README.txt
mattias 3a0e7e4224 chmhelp: help for compiler directives
git-svn-id: trunk@31411 -
2011-06-26 21:08:58 +00:00

56 lines
1.6 KiB
Plaintext

lhelp is a program written entirely using FreePascal and the LCL to read .chm help files.
This is a basic HOWTO for integrating lhelp into the Lazarus IDE.
1 ) Start Lazarus
2 ) Install Package:
In the Components Menu choose "Open Package File"
Browse to the lazarus/components/chmhelp/packages/idehelp directory and
open "chmhelppkg.lpk"
3 ) Now click "Install".
4 ) Restart Lazarus(if it didn't automatically)
5 ) Open the lhelp project in lazarus/components/chmhelp/lhelp/lhelp.lpi
Compile lhelp.
6 ) Configure the paths for the lhelp:
From the Tools menu choose "Options"
Change to Help / Help options.
Change to the "Viewers" tab and select "CHM Help Viewer"
HelpEXE:
For the "HelpEXE" entry browse to the lazarus/components/chmhelp/lhelp/ folder
and select the lhelp executable.
HelpFilesPath:
This is the directory that contains the help files in CHM format (lcl.chm, fcl.chm, rtl.chm etc.).
You can download them from http://sourceforge.net/projects/freepascal/files/Documentation/
HelpLabel Name and Tag do not need to be altered.
The HelpLabel is the name of the named pipe that lazarus will use to communicate with lhelp.
7 ) Configure the DataBases
Choose the DataBases tab.
RTLUnits:
this should be "rtl.chm://"
FCLUnits:
this should be "fcl.chm://"
NOTE if you have only a single lcl-fcl-rtl.chm file then paths become:
"lcl-fcl-rtl.chm://rtl/"
"lcl-fcl-rtl.chm://fcl/"
"lcl-fcl-rtl.chm://lcl/"
Now close this window and check out the integrated help :)
Enjoy