Std WhatsThis

From FreeCAD Documentation
Revision as of 22:15, 21 December 2020 by David69 (talk | contribs)

Std WhatsThis

Menu location
Help → What's This?
Workbenches
All
Default shortcut
Shift+F1
Introduced in version
-
See also
Std OnlineHelp

Description

The Std WhatsThis command opens the help documentation for a specified command.

Usage

  1. There are several ways to invoke the command:
    • Press the Std WhatsThis button.
    • Select the Help → What's This? option from the menu.
    • Use the keyboard shortcut: Shift+F1.
  2. Click on a toolbar button or on a menu option.
  3. The help documentation for the selected command opens in a new window.

Notes

  • Some commands are not documented, in that case the offline help will open on a blank page and report that the page could not be found.
  • The documentation is based on Qt compiled HTML pages. For it to launch Qt Assistant must be installed.
  • On Debian/Ubuntu and possibly other Linux systems, the offline documentation may need to be installed separately. The package is named freecad-doc, or freecad-daily-doc (for the freecad-daily PPA). See Installing Helpfile.

Read this post to understand how the commands must be named in the code to match the help pages in the wiki.