Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
 
(5 intermediate revisions by the same user not shown)
Line 26: Line 26:
The '''Std OnlineHelp''' command opens the help documentation. To open the documentation for a specific command, use the [[Std_WhatsThis|Std WhatsThis]] command.
The '''Std OnlineHelp''' command opens the help documentation. To open the documentation for a specific command, use the [[Std_WhatsThis|Std WhatsThis]] command.


<!--T:18-->
<!--T:20-->
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 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.


==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]].





Latest revision as of 23:44, 27 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 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:
    • Select the Help → Help option from the menu.
    • Use the keyboard shortcut: F1.
  2. The help documentation opens.

Notes