LHelp: what changed
Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.
Title: lhelp LHelp
| Old | New | Line | |
|---|---|---|---|
| 1 | - | ||
| 1 | + | ## Overview | |
| 2 | + | ||
| 3 | + | LHelp is the default help viewer for Lazarus. It displays CHM help files. | |
| 4 | + | ||
| 5 | + | The screenshot below shows Lazarus LCL context-sensitive help displayed in LHelp:  | |
| 6 | + | ||
| 7 | + | ## Operation | |
| 8 | + | ||
| 9 | + | LHelp can be run stand-alone and used to open/view CHM files like a regular CHM viewer. | |
| 10 | + | ||
| 11 | + | It can also be invoked and controlled by the Lazarus IDE to display context-sensitive help etc. For that, it uses the [[Help protocol]]. | |
| 12 | + | ||
| 13 | + | ## Internals | |
| 14 | + | ||
| 15 | + | LHelp uses the [[chm]] package provided by FPC to read CHM files, table of contents (TOC), and full text search index. | |
| 16 | + | ||
| 17 | + | ## Limitations | |
| 18 | + | ||
| 19 | + | - LHelp cannot search on words containing the search term. This is similar to the behaviour of the Windows help viewer. Implementing this would require traversing the entire full-text search tree, parsing results and then displaying which would probably take a lot of time. | |
| 20 | + | - Known bugs: See bug reports on the bug tracker with tag LHelp, LHelp in the description etc. | |
| 21 | + | ||
| 22 | + | ## See also | |
| 23 | + | ||
| 24 | + | - [[Add Help to Your Application]] | |
| 25 | + | - [[chmhelp]] | |
| 26 | + | - [[htmlhelp compiler]] | |
| 27 | + | ||
| 28 | + | [[Installing Help in the IDE]] - How to install help for the RTL, FCL and LCL in the Lazarus IDE | |
| 29 | + | ||
| 30 | + | --- | |
| 31 | + | *From the Free Pascal wiki, page "LHelp", as it stood on 2024-03-22 after a change by Dbannon, 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).* | |
| 32 | + | Category: CHM | |
| 33 | + | Category: Help and Docs | |
| 34 | + | Category: Lazarus |