Difference between revisions of "LHelp"
From Free Pascal wiki
Jump to navigationJump to search (casing of 'LHelp') |
|||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
| − | + | LHelp is the default help viewer for Lazarus. It displays CHM help files. | |
The screenshot below shows Lazarus LCL context-sensitive help displayed in LHelp: | The screenshot below shows Lazarus LCL context-sensitive help displayed in LHelp: | ||
| Line 6: | Line 6: | ||
== Operation == | == Operation == | ||
| − | + | LHelp can be run stand-alone and used to open/view CHM files like a regular CHM viewer. | |
It can also be invoked and controlled by the Lazarus IDE to display context-sensitive help etc. | It can also be invoked and controlled by the Lazarus IDE to display context-sensitive help etc. | ||
| Line 12: | Line 12: | ||
== Internals == | == Internals == | ||
| − | + | LHelp uses the [[chm]] package provided by FPC to read CHM files, table of contents (TOC), and full text search index. | |
== Limitations == | == Limitations == | ||
* 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. | * 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. | ||
| − | * Known bugs: See bug reports on the bug tracker with tag | + | * Known bugs: See bug reports on the bug tracker with tag LHelp, LHelp in the description etc. |
== See also == | == See also == | ||
Revision as of 16:22, 3 December 2021
Overview
LHelp is the default help viewer for Lazarus. It displays CHM help files.
The screenshot below shows Lazarus LCL context-sensitive help displayed in LHelp:
Operation
LHelp can be run stand-alone and used to open/view CHM files like a regular CHM viewer.
It can also be invoked and controlled by the Lazarus IDE to display context-sensitive help etc. For that, it uses the Help protocol.
Internals
LHelp uses the chm package provided by FPC to read CHM files, table of contents (TOC), and full text search index.
Limitations
- 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.
- Known bugs: See bug reports on the bug tracker with tag LHelp, LHelp in the description etc.
