Std WhatsThis: Difference between revisions

From FreeCAD Documentation
(Marked this version for translation)
(Read this post to understand how the commands must be named in the code to match the help pages in the wiki.)
Line 42: Line 42:
* The documentation is based on Qt compiled HTML pages. For it to launch Qt Assistant must be installed.
* 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]].
* 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]].

Read this post to understand how the commands must be named in the code to match the help pages in the wiki.
* [https://forum.freecadweb.org/viewtopic.php?t=27265 Bunch of TechDraw pages don't have the correct name]


<!--T:18-->
<!--T:18-->

Revision as of 17:39, 23 August 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 help documentation for a specified 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 option.
  3. The help documentation for the selected command opens in a new window.

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.

Read this post to understand how the commands must be named in the code to match the help pages in the wiki.