Std WhatsThis: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updated for V0.20.)
Line 25: Line 25:
<!--T:6-->
<!--T:6-->
The '''Std WhatsThis''' command opens the help documentation for a specified command.
The '''Std WhatsThis''' command opens the help documentation for a specified command.

Since FreeCAD version 0.20 this command requires the [https://github.com/FreeCAD/FreeCAD-Help Help addon].


==Usage== <!--T:7-->
==Usage== <!--T:7-->


<!--T:8-->
<!--T:8-->
# Make sure the Help addon is available. This addon can be installed via the [[Std AddonMgr|Addon Manager]].
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Press the {{Button|[[Image:Std_WhatsThis.svg|16px]] [[Std_WhatsThis|Std WhatsThis]]}} button.
#* Press the {{Button|[[Image:Std_WhatsThis.svg|16px]] [[Std_WhatsThis|Std WhatsThis]]}} button.
#* Select the {{MenuCommand|Help → [[Image:Std_WhatsThis.svg|16px]] What's This?}} option from the menu.
#* Select the {{MenuCommand|Help → [[Image:Std_WhatsThis.svg|16px]] What's This?}} option from the menu.
#* Use the keyboard shortcut: {{KEY|Shift}}+{{KEY|F1}}.
#* Use the keyboard shortcut: {{KEY|Shift}}+{{KEY|F1}}.
# Click on a toolbar button or on a menu option.
# Click a toolbar button or a menu option.
# The help documentation for the selected command opens in a new window.
# The help documentation for the selected command opens.

==Notes== <!--T:16-->

<!--T:17-->
* 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 {{FileName|freecad-doc}}, or {{FileName|freecad-daily-doc}} (for the freecad-daily PPA). See [[Installing_Helpfile|Installing Helpfile]].


<!--T:19-->
Read this post to understand how the commands must be named in the code to match the help pages in the wiki.
* [https://forum.freecadweb.org/viewtopic.php?t=27265 Bunch of TechDraw pages don't have the correct name]


<!--T:18-->
<!--T:18-->
Line 60: Line 53:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 20:41, 11 June 2022

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.

Since FreeCAD version 0.20 this command requires the Help addon.

Usage

  1. Make sure the Help addon is available. This addon can be installed via the Addon Manager.
  2. 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.
  3. Click a toolbar button or a menu option.
  4. The help documentation for the selected command opens.