Std WhatsThis: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Marked this version for translation)
 
(37 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:15-->
{{Docnav
|[[Std_About|About]]
|
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_About.svg
|IconR=
|IconC=Freecad.svg
}}


<!--T:2-->
<!--T:2-->
{{GuiCommand
{{GuiCommand
|Name=Std WhatsThis
|Name=Std WhatsThis
|MenuLocation=[[Std Help Menu|Help]] → What's This?
|MenuLocation=Help → What's This?
|Workbenches=All
|Workbenches=All
|Shortcut=Shift + F1|
|Shortcut={{KEY|Shift}}+{{KEY|F1}}
|SeeAlso=[[Std_OnlineHelp|Std OnlineHelp]]
}}
}}


Line 13: Line 24:


<!--T:6-->
<!--T:6-->
This tool provides information on a selected command by opening the offline [[Std Help|Help documentation]] to the appropriate page.
The '''Std WhatsThis''' command opens the help documentation for a specific command.


==How to use== <!--T:7-->
<!--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-->


<!--T:8-->
<!--T:8-->
# There are several ways to invoke the command:
# Press the {{KEY|[[File:Std WhatsThis.png|24px]] '''What's This?'''}} button.
#* Press the {{Button|[[Image:Std_WhatsThis.svg|16px]] [[Std_WhatsThis|Std WhatsThis]]}} button.
# Click on a toolbar icon or on a menu entry.
#* Select the {{MenuCommand|Help → [[Image:Std_WhatsThis.svg|16px]] What's This?}} option from the menu.
#* Use the keyboard shortcut: {{KEY|Shift}}+{{KEY|F1}}.
# Click a toolbar button or a menu option.
# The help documentation for the selected command opens.


<!--T:9-->
==Notes== <!--T:16-->
'''Note:''' on Debian/Ubuntu and possibly other Linux systems, the FreeCAD documentation is not included in the FreeCAD package and needs to be installed separately. The package may be named freecad-doc or freecad-daily-doc (for the freecad-daily PPA).


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



<!--T:11-->
<!--T:18-->
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.
{{Docnav
|[[Std_About|About]]
|
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_About.svg
|IconR=
|IconC=Freecad.svg
}}


</translate>
</translate>
{{Std Base navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

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