Difference between revisions of "chmhelp"

From Free Pascal wiki
Jump to navigationJump to search
(→‎Chmhelp: Add info on lcl help file as the section below gives the erroneous impressino there is no Lazarus chm help at all.)
Line 7: Line 7:
 
Recompiling and configuring the help should do the trick. Read the file components/chmhelp/README.txt.
 
Recompiling and configuring the help should do the trick. Read the file components/chmhelp/README.txt.
  
The documentation files rtl.chm and fcl.chm can be downloaded in a chm.zip file from [http://www.freepascal.org/download.var].
+
There are multiple help files you can/should download/use:
 +
# the FPC rtl.chm and fcl.chm that document FreePascal components can be downloaded in a zip file from [http://www.freepascal.org/download.var].
 +
# the Lazarus Component Library help file, lcl.chm, can be downloaded from [http://sourceforge.net/projects/lazarus/files/Lazarus%20Documentation/].
  
 
== Lazarus IDE help ==
 
== Lazarus IDE help ==

Revision as of 07:21, 10 May 2012

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. 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 Lazarus Component Library help file, lcl.chm, can be downloaded from [2].

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 structure that is only semi enforced by the users.

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: