Std WhatsThis: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
 
(21 intermediate revisions by 5 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:15-->
{{Docnav
{{Docnav
|[[Std_About|Std About]]
|[[Std_About|About]]
|
|
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu|Std Help Menu]]
Line 23: Line 24:


<!--T:6-->
<!--T:6-->
The '''Std WhatsThis''' command opens the online help documentation for a predefined command.
The '''Std WhatsThis''' command opens the help documentation for a specific command.

<!--T:22-->
Since FreeCAD version 0.20 this command and the Help system are managed by a separate Help Module. For versions 0.20 and 0.21 this module is an [https://github.com/FreeCAD/FreeCAD-Help addon] that must be [[Std_AddonMgr|installed]] separately. In later versions the Help Module is integrated in FreeCAD.


==Usage== <!--T:7-->
==Usage== <!--T:7-->
Line 32: Line 36:
#* 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 entry.
# Click a toolbar button or a menu option.
# The online help documentation for the selected command opens in a new window.
# The help documentation for the selected command opens.

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


<!--T:21-->
==Notes==
* The Help system has a number of preferences. See [[Preferences_Editor#Help|Preferences Editor]].


* 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:18-->
{{Docnav
{{Docnav
|[[Std_About|Std About]]
|[[Std_About|About]]
|
|
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu|Std Help Menu]]
Line 53: Line 58:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 23:43, 27 October 2023

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 specific command.

Since FreeCAD version 0.20 this command and the Help system are managed by a separate Help Module. For versions 0.20 and 0.21 this module is an addon that must be installed separately. In later versions the Help Module is integrated in FreeCAD.

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 a toolbar button or a menu option.
  3. The help documentation for the selected command opens.

Notes