Std WhatsThis: Difference between revisions

From FreeCAD Documentation
m (Add {{KEY}} templates + move templates out of translation tags)
(Revised. Added Docnav.)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

{{Docnav
|[[Std_About|Std 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={{StdMenu|[[Std Help Menu|Help]]}} → What's This?
|MenuLocation=Help → What's This?
|Workbenches=All
|Workbenches=All
|Shortcut={{KEY|Shift}} + {{KEY|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]]
}}
}}


Line 14: Line 23:


<!--T:6-->
<!--T:6-->
The '''Std WhatsThis''' command opens the online help documentation for a predefined command.
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.


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


<!--T:8-->
<!--T:8-->
# There are several ways to invoke the command:
# Press the {{Button|[[File:Std_WhatsThis.svg|16px]] [[Std_WhatsThis|What's This]]}} button or the {{KEY|Shift}} + {{KEY|F1}} keyboard shortcut.
#* 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 on a toolbar button or on a menu entry.


==Notes==
<!--T:9-->
{{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.


* 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.
==Documentation files== <!--T:10-->
* 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]].


{{Docnav
<!--T:11-->
|[[Std_About|Std About]]
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.
|

|[[Std_Help_Menu|Std Help Menu]]
<!--T:13-->
|IconL=Std_About.svg
The package may be named {{incode|freecad-doc}} or {{incode|freecad-daily-doc}} for the {{incode|freecad-daily}} PPA.
|IconR=

|IconC=Freecad.svg
<!--T:14-->
}}
See [[Installing_Helpfile|Installing Helpfile]].


</translate>
</translate>
{{clear}}

{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}

{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 19:11, 17 June 2020

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 online help documentation for a predefined 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 entry.

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.