Std WhatsThis/hr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Docnav
|[[Std_About|About]]
|
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_About.svg
|IconR=
|IconC=Freecad.svg
}}


{{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|Online help]], [[Std FreeCADUserHub|User hub]], [[Std_Help_Menu|Help menu]]
|SeeAlso=[[Std_OnlineHelp|Std OnlineHelp]]
}}
}}


==Description==
==Description==


This [[Std_WhatsThis|Std WhatsThis]] tool provides information on a command by running the [[Std OnlineHelp|Std Online Help]] command, and opening its corresponding documentation page.
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 [https://github.com/FreeCAD/FreeCAD-Help addon] that must be [[Std_AddonMgr|installed]] separately. In later versions the Help Module is integrated in FreeCAD.
==How to use==


==Usage==
# Press the {{Button|[[File:Std_WhatsThis.svg|16px]] [[Std_WhatsThis|What's This]]}} button.
# Click on a toolbar icon or on a menu entry.


# There are several ways to invoke the command:
{{Emphasis|Note:}} 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.
#* 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.
#* Use the keyboard shortcut: {{KEY|Shift}}+{{KEY|F1}}.
# Click a toolbar button or a menu option.
# The help documentation for the selected command opens.


==Notes==
<div class="mw-translate-fuzzy">
==Ograničenja==
</div>


* The Help system has a number of preferences. See [[Preferences_Editor#Help|Preferences Editor]].
On Debian/Ubuntu and possibly other Linux systems, the offline documentation may not be included with the main FreeCAD package, and may need to be installed separately.


The package may be named {{incode|freecad-doc}} or {{incode|freecad-daily-doc}} for the {{incode|freecad-daily}} PPA.


{{Docnav
{{Std Base}}
|[[Std_About|About]]
{{Userdocnavi}}
|
{{clear}}
|[[Std_Help_Menu|Std Help Menu]]
|IconL=Std_About.svg
|IconR=
|IconC=Freecad.svg
}}

{{Std Base navi{{#translation:}}}}
{{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