chmhelp

From Free Pascal wiki
Revision as of 12:18, 3 August 2012 by BigChimp (talk | contribs) (→‎Chmhelp: Added Programmer's Guide, Reference Guide, User's Guide, FPDOC chms)
Jump to navigationJump to search

Chmhelp

This is a placeholder for the Lazarus chmhelp package (components/chmhelp).

The package is an external help server that communicates with the IDE over a socket; see IDE Development#Builtin CHM help for more details. The CHM support is based on FPC package chm.

Recompiling and configuring the help should do the trick. Read the file components/chmhelp/README.txt.

There are multiple help files you can/should download/use:

  1. the FPC rtl.chm and fcl.chm that document FreePascal components can be downloaded in a zip file from [1].
  2. the Free Pascal Programmer's Guide (prog.chm), Free Pascal: Reference guide (ref.chm), Free Pascal: User’s Guide (user.chm) and FPDoc: Free Pascal code documenter: Reference manual (fpdoc.chm), probably available in the zip file mentioned above
  3. the Lazarus Component Library help file, lcl.chm, can be downloaded from [2].

Also put any .xct (cross-reference) files in the same directory as the chm files

Lazarus IDE help

The problem with the IDE help is that it is in some wiki format, which is not available as an archive, and with a free-form structure (as expected in a wiki).

There is a tool wikihelp in lazarus-ccr that should be able to download and relink the wiki for offline use (which then could be transformed into a meagre quality but working chm), but the Lazarus Wiki was closed for bulk downloads due to attacks in the past.

Wikihelp: