Difference between revisions of "Creating IDE Help"
From Free Pascal wiki
Jump to navigationJump to search| Line 13: | Line 13: | ||
This is invoked when the cursor in the source editor is above a keyword and the user pressed F1. | This is invoked when the cursor in the source editor is above a keyword and the user pressed F1. | ||
To add a wiki help page for a message, do the following: | To add a wiki help page for a message, do the following: | ||
| − | * Create a wiki page under the root [[ | + | * Create a wiki page under the root [[Build messages]] |
* Open ide/helpfpcmessages.pas and add a ''AddFPCMessageHelpItem'' line like: | * Open ide/helpfpcmessages.pas and add a ''AddFPCMessageHelpItem'' line like: | ||
<pre> | <pre> | ||
Revision as of 00:58, 30 April 2006
Help for LCL units
Help for IDE windows
The help for the IDE windows (i.e. 'Object Inspector' or the 'Compiler Options') are documented in this wiki. The IDE has a mapping file docs/IDEWindowHelpTree.xml, which contains the paths from the various IDE forms/controls to wiki pages. This mapping file editor is shown at any place in the IDE via Ctrl+Shift+F1. You can set the short cut in the editor options -> key mapping.
The root page of the IDE window docs is Lazarus IDE.
Help for FPC keywords
This is invoked when the cursor in the source editor is above a keyword and the user pressed F1. To add a wiki help page for a message, do the following:
- Create a wiki page under the root Build messages
- Open ide/helpfpcmessages.pas and add a AddFPCMessageHelpItem line like:
AddFPCMessageHelpItem('Can''t find unit',
'FPC_message:_Can_not_find_unit',': Can''t find unit ');
