Edit context help for the IDE windows

From Lazarus wiki
Jump to navigationJump to search
  • Open an IDE dialog (in the running IDE, not in the designer)
  • Focus a control that should get help. To setup the context help of a groupbox, frame, focus one of its childs.
  • Press Ctrl+⇧ Shift+F1

Example

  • open the options dialog
  • select the frame Editor / Mouse
  • focus the tree on the frame
  • press Ctrl+⇧ Shift+F1 to open the dialog:
EditContextHelpExample1.png

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

The deepest help node wins.

The focused control - in this example the ContextTree is selected on both tree.

  • to create the help for the whole frame, select on the right tree the EditorMouseOptionsFrame as shown in the screen shot above.
  • check Has Help
  • because EditorMouseOptionsFrame has a wiki page of its own, check 'Is a root control'. This will shorten the text in the third field.
  • change the Path to Editor_Mouse_Options as shown in the screen shot above.
  • focus the Name. You will notice that the text field has changed to IDE_Window:_Editor_Mouse_Options
  • Now click on the Test button on the left side.
  • the IDE will open the URL: http://wiki.lazarus.freepascal.org/IDE_Window:_Editor_Mouse_Options
  • click Ok to save the changes. This will alter the file docs/IDEWindowHelpTree.xml.
  • commit your changes
Retrieved from "https://wiki.freepascal.org/index.php?title=Edit_context_help_for_the_IDE_windows&oldid=139396"