chmhelp: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: chmhelp
| Old | New | Line | |
|---|---|---|---|
| 1 | + | Lazarus has a **chmhelp** package (components/chmhelp). | |
| 2 | + | ||
| 3 | + | The package is an external help viewer ([[lhelp]]) that communicates with the IDE using SimpleIPC; see [[Installing Help in the IDE]] and [[Help protocol]] for more details. The CHM support is based on FPC package [[chm]]. | |
| 4 | + | ||
| 5 | + | Troubleshooting: recompiling and configuring the package and lhelp.exe often do the trick. Read the file components/chmhelp/README.txt. | |
| 6 | + | ||
| 7 | + | There are multiple help files you can/should download/use: | |
| 8 | + | ||
| 9 | + | 1. the FPC rtl.chm and fcl.chm that document FreePascal components can be downloaded in a zip file from [1](https://www.freepascal.org/down/docs/docs.var). | |
| 10 | + | 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 | |
| 11 | + | 3. the Lazarus Component Library help file, lcl.chm, can be downloaded from [2](http://sourceforge.net/projects/lazarus/files/Lazarus%20Documentation/). | |
| 12 | + | ||
| 13 | + | If you want to edit/generate your own chm help files, also put any .xct (cross-reference) files in the same directory as the chm files. If you are just using help, there's no need for that. | |
| 14 | + | ||
| 15 | + | ## Lazarus IDE help | |
| 16 | + | ||
| 17 | + | Most help for the Lazarus IDE is kept on the Lazarus wiki. A drawback is that it is not available as an (regularly updated) archive, and with a free-form structure (as expected in a wiki), which is less suitable for automated transformation. | |
| 18 | + | ||
| 19 | + | There is a wikihelp tool 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. | |
| 20 | + | ||
| 21 | + | Wikihelp: | |
| 22 | + | ||
| 23 | + | - original home: <http://wiki.ullihome.de/index.php/WikiHelp-Download/de> | |
| 24 | + | - lazarus-ccr location : applications/wikihelp (requires synapse) | |
| 25 | + | ||
| 26 | + | ## See also | |
| 27 | + | ||
| 28 | + | - [[Add Help to Your Application]] | |
| 29 | + | - [[htmlhelp compiler]] | |
| 30 | + | - [[lhelp]] | |
| 31 | + | ||
| 32 | + | --- | |
| 33 | + | *From the Free Pascal wiki, page "chmhelp", as it stood on 2023-03-26 after a change by JuhaManninen, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 34 | + | Category: Help and Docs | |
| 35 | + | Category: Lazarus IDE plugins |