Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
No edit summary
mNo edit summary
Line 27: Line 27:


<!--T:18-->
<!--T:18-->
Starting from FreeCAD {{VersionPlus|0.20}} this command and all the help system is managed by a separate module called the [[Help module]]. Versions 0.20 and 0.21 require the [https://github.com/FreeCAD/FreeCAD-Help Help Addon] installed, while starting from 0.22 / 1.0 the Help module is integrated in FreeCAD.
Since FreeCAD {{VersionPlus|0.20}} this command and the Help system are managed by a separate [[Help_module|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. Starting from version 0.22 / 1.0 the Help module is integrated in FreeCAD.


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


<!--T:9-->
<!--T:9-->
# If the Help Addon is not yet available you will be asked to install it via the [[Std AddonMgr|Addon Manager]].
# There are several ways to invoke the command:
# There are several ways to invoke the command:
#* Select the {{MenuCommand|Help → [[Image:Std_OnlineHelp.svg|16px]] Help}} option from the menu.
#* Select the {{MenuCommand|Help → [[Image:Std_OnlineHelp.svg|16px]] Help}} option from the menu.
Line 41: Line 40:


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





Revision as of 17:29, 26 October 2023

Std OnlineHelp

Menu location
Help → Help
Workbenches
All
Default shortcut
F1
Introduced in version
-
See also
Std WhatsThis

Description

The Std OnlineHelp command opens the help documentation. To open the documentation for a specific command, use the Std WhatsThis command.

Since FreeCAD version 0.20 and above 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. Starting from version 0.22 / 1.0 the Help module is integrated in FreeCAD.

Usage

  1. There are several ways to invoke the command:
    • Select the Help → Help option from the menu.
    • Use the keyboard shortcut: F1.
  2. The help documentation opens.

Notes