Difference between revisions of "Installing Help in the IDE"

From Lazarus wiki
Jump to navigationJump to search
 
Line 1: Line 1:
 
==The files needed from Kylix3==
 
==The files needed from Kylix3==
  
Since most of us have been coding in either Delphi or Kylix, you probably already have these files "lying around someplace".  These are the files and directorys needed from the ${HOME}/Kylix/help:<br>
+
Since most of us have been coding in either Delphi or Kylix, you probably already have these files "lying around someplace".  This section is to show how to implement context sensitive help (CTRL-F1) on a linux installation.  These are the files and directorys needed from the ${HOME}/Kylix/help:<br>
 
<tt><code><br>
 
<tt><code><br>
 
  bin/          k3clx.hlp    k3dbd.cnt    k3.hlp
 
  bin/          k3clx.hlp    k3dbd.cnt    k3.hlp

Revision as of 22:29, 1 March 2007

The files needed from Kylix3

Since most of us have been coding in either Delphi or Kylix, you probably already have these files "lying around someplace". This section is to show how to implement context sensitive help (CTRL-F1) on a linux installation. These are the files and directorys needed from the ${HOME}/Kylix/help:

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


The hyperhelp.sh script


#!/bin/bash
XPPATH="/home/tom/Lazarus/DelphiHelp/xprinter"
HHHOME="/home/tom/Lazarus/DelphiHelp"
LANG=en_US
LC_ALL=en_US
locale=${LC_ALL:-${LC_CTYPE:-${LANG:-"C"}}}
LD_LIBRARY_PATH="/home/tom/Lazarus/DelphiHelp/lib/locale/"${locale}":/home/tom/Lazarus/DelphiHelp/lib"${LD_LIBRARY_PATH:+":"}${LD_LIBRARY_PATH}
XAPPLRESDIR="/home/tom/Lazarus/DelphiHelp/app-defaults"
NLSPATH="/home/tom/Lazarus/DelphiHelp/lib/locale/%L/%N.cat"
export XPPATH HHHOME LANG LC_ALL LD_LIBRARY_PATH XAPPLRESDIR NLSPATH
cd $HHHOME
/home/tom/Lazarus/DelphiHelp/bin/hyperhelp /home/tom/Lazarus/DelphiHelp/k3clx.hlp -m AL\($1,3,,main\) -s 0 -d 32159 -display :0.0 -w


my Directory tree

/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

edittool.png


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.