Edit context help for the IDE windows: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | - Open an IDE dialog (in the running IDE, not in the designer) | |
| 2 | 2 | - Focus a control that should get help. To setup the context help of a groupbox, frame, focus one of its childs. | |
| 3 | - | ||
| 3 | + | - Press `Ctrl`+`Shift`+`F1` | |
| 4 | 4 | ||
| 5 | 5 | ## Example | |
| 6 | 6 | ||
| 7 | 7 | - open the options dialog | |
| 8 | 8 | - select the frame Editor / Mouse | |
| 9 | 9 | - focus the tree on the frame | |
| 10 | - | ||
| 11 | - | ||
| 12 | - | ||
| 13 | - | ||
| 14 | - | ||
| 15 | - | ||
| 16 | - | ||
| 17 | - | ||
| 10 | + | - press `Ctrl`+`Shift`+`F1` to open the dialog: | |
| 18 | 11 | ||
| 19 | - | ||
| 12 | + |  | |
| 20 | 13 | ||
| 21 | 14 | The left tree shows all components of the current dialog. They are just for orientation. The right tree shows all existing help nodes. You will notice that they have the same names as the dialog or some controls on a dialog | |
| 22 | 15 | ||
| 23 | 16 | The deepest help node wins. | |
| 24 | 17 | ||
| 25 | 18 | The focused control - in this example the ContextTree is selected on both tree. | |
| 26 | 19 | ||
| 27 | 20 | - to create the help for the whole frame, select on the **right** tree the **EditorMouseOptionsFrame** as shown in the screen shot above. | |
| 28 | 21 | - check *Has Help* | |
| 29 | 22 | - because EditorMouseOptionsFrame has a wiki page of its own, check 'Is a root control'. This will shorten the text in the third field. | |
| 30 | 23 | - change the **Path** to *Editor_Mouse_Options* as shown in the screen shot above. | |
| 31 | 24 | - focus the *Name*. You will notice that the text field has changed to *IDE_Window:_Editor_Mouse_Options* | |
| 32 | 25 | - Now click on the **Test** button on the left side. | |
| 33 | 26 | - the IDE will open the URL: *<http://wiki.lazarus.freepascal.org/IDE_Window:_Editor_Mouse_Options>* | |
| 34 | 27 | - click Ok to save the changes. This will alter the file *docs/IDEWindowHelpTree.xml*. | |
| 35 | 28 | - commit your changes | |
| 36 | 29 | ||
| 37 | 30 | --- | |
| 38 | 31 | *From the Free Pascal wiki, page "Edit context help for the IDE windows", as it stood on 2020-08-22 after a change by Trev, 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).* | |
| 39 | 32 | Category: Help and Docs | |
| 40 | 33 | Category: IDE | |
| 41 | 34 | Category: Lazarus |