Std WhatsThis: Difference between revisions

From FreeCAD Documentation
No edit summary
Line 8: Line 8:
|Workbenches=All
|Workbenches=All
|Shortcut=Shift + F1
|Shortcut=Shift + F1
|SeeAlso=[[Std OnlineHelp|Std Online Help]]
|SeeAlso=[[Std OnlineHelp|Online help]], [[Std FreeCADUserHub|User hub]], [[Std_Help_Menu|Help menu]]
}}
}}


Line 14: Line 14:


<!--T:6-->
<!--T:6-->
This tool provides information on a selected command by running the [[Std OnlineHelp|Std Online Help]] 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.


==How to use== <!--T:7-->
==How to use== <!--T:7-->
Line 25: Line 25:
{{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.
{{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.


==Limitations== <!--T:10-->
==Documentation files== <!--T:10-->


<!--T:11-->
<!--T:11-->
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).
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.


<!--T:12-->
<!--T:12-->

Revision as of 03:27, 18 December 2019

Std WhatsThis

Menu location
Help → What's This?
Workbenches
All
Default shortcut
Shift + F1
Introduced in version
-
See also
Online help, User hub, Help menu

Description

This Std WhatsThis tool provides information on a command by running the Std Online Help command, and opening its corresponding documentation page.

How to use

  1. Press the What's This button.
  2. Click on a toolbar icon or on a menu entry.

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.

Documentation files

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 freecad-doc or freecad-daily-doc for the freecad-daily PPA.