Difference between revisions of "Installing Help in the IDE"
(→Installing INF Help in the IDE: Note that these are additional.) |
|||
Line 23: | Line 23: | ||
=Installing INF Help in the IDE= | =Installing INF Help in the IDE= | ||
− | + | If you want to install additional files in the .inf format, see http://fpgui.sourceforge.net/docview_ide_integration.shtml for an example. | |
=Installing the Kylix Help in the Lazarus IDE= | =Installing the Kylix Help in the Lazarus IDE= |
Revision as of 10:34, 10 July 2012
Installing CHM Help for The RTL, FCL and LCL in the Lazarus IDE
If you are using Lazarus from a package/installer
The installer or package may have already set up help for you. If this is not the case, please follow the instructions under the "installing from subversion" section.
If you are using Lazarus from Subversion
The Lazarus help files can be installed following these easy steps:
- Make sure that the package chmhelppkg is intalled. See the menu Package->Install Packages. This package is installed by default in the "bigide" so most users should already have it installed.
- Open the project lazarus/components/chmhelp/lhelp/lhelp.lpi
- Build this project
- Download the latest stable Lazarus CHM help files from http://sourceforge.net/projects/lazarus/files/Lazarus%20Documentation/
- Copy all CHM files to lazarus/docs/html
- Go to the Environment Options, tab "Help Options' and select the "CHM Help Viewer". Check its properties:
- "HelpExe" should be the lhelp you just built
- "HelpFilesPath" should be, where you put the CHM files
Now context sensitive help using F1 should work.
Installing INF Help in the IDE
If you want to install additional files in the .inf format, see http://fpgui.sourceforge.net/docview_ide_integration.shtml for an example.
Installing the Kylix Help in the Lazarus IDE
This section will show you how to use the Kylix 3 context sensitive help system with a Linux installation of Lazarus.
The files needed from Kylix3
Since many of you have been coding in Kylix, you probably already have these files lying around some place. I suspect that the help system from the free version of Kylix may work as well. These are the files and directories needed from the ${HOME}/kylix/help directory:
bin/ k3clx.hlp k3dbd.cnt k3.hlp
foo k3.cnt k3dbd.fts k3indy.cnt
foo~ k3copts.cnt k3dbd.hlp k3indy.fts
hhintro.txt k3copts.fts k3dbx.cnt k3indy.hlp
hoh.cnt k3copts.hlp k3dbx.fts k3iota.cnt
hoh.fts k3crtl.cnt k3dbx.hlp k3iota.fts
hoh.hlp k3crtl.fts k3derrs.cnt k3iota.hlp
hyperhelp.sh* k3crtl.hlp k3derrs.fts k3new.cnt
k3.als k3ctools.cnt k3derrs.hlp k3new.fts
k3cerrs.cnt k3ctools.fts k3dlr.cnt k3new.hlp
k3cerrs.fts k3ctools.hlp k3dlr.fts k3prog.cnt
k3cerrs.hlp k3cw.cnt k3dlr.hlp k3prog.fts
k3clr.cnt k3cw.fts k3dopts.cnt k3prog.hlp
k3clr.fts k3cw.hlp k3dopts.fts lib/
k3clr.hlp k3dap.cnt k3dopts.hlp
k3clx.cnt k3dap.fts k3.ftg
k3clx.fts k3dap.hlp k3.fts
Most of the above files may not pertain to Lazarus, such as the k3c* files which relate to C++, but they are harmless to keep around.
The bare minimum files needed for the context help are these:
bin/ k3.als k3clx.fts k3.cnt k3.fts lib/
hyperhelp.sh* k3clx.cnt k3clx.hlp k3.ftg k3.hlp
The hyperhelp.sh script
We do need to dress up the default help script provided with Kylix so that it will work as a standalone app under X. Note that the last line of the script sets some missing rendering parameters. Also note the -geometry which positions the window and sets its size.
#!/bin/bash
HHHOME="${HOME}/Lazarus/DelphiHelp"
XPPATH="${HHHOME}/xprinter"
LANG=en_US
LC_ALL=en_US
locale=${LC_ALL:-${LC_CTYPE:-${LANG:-"C"}}}
LD_LIBRARY_PATH+="lib/locale/"${locale}":lib:"
XAPPLRESDIR="app-defaults"
NLSPATH="lib/locale/%L/%N.cat"
export XPPATH HHHOME LANG LC_ALL LD_LIBRARY_PATH XAPPLRESDIR NLSPATH
cd $HHHOME
bin/hyperhelp k3clx.hlp -m AL\($1,3,,main\)\
-s 0 -d 32159 -display :0.0 -geometry 600x500+100+100 -w
My directory tree
This is where I have placed the Kylix Help file directory. It is under my installation of Lazarus in the user home directory. The hyperhelp.sh script refers to these locations.
/home/tom/Lazarus/DelphiHelp/ |-- bin `-- lib `-- locale |-- de_DE |-- fr_FR |-- ja_JP.SJIS |-- ja_JP.eucJP `-- ja_JP.eucjp
Custom Tool setup in IDE
Finally, set up the new custom tool within Lazarus from the menu 'Tools|Configure custom tools|Add'. Replace '/home/tom/' with your user home directory path. This has to be an absolute path to the hyperhelp.sh script.
In summary
Just place your cursor in the edit window on the word you want to find help for and press Ctrl+F1. The Kylix help will then open up the context sensitive help page for that keyword.
fpdoc entries of RTL and FCL
The fpdoc entries for the FPC sources can be downloaded from svn:
cd /home/username/yourchoice/
svn co http://svn.freepascal.org/svn/fpcdocs/trunk fpcdocs
Add the path /home/username/yourchoice/fpcdocs to Tools / Options / Environment / FPDoc Editor
The source editor hints should now show help for TComponent.Name.