Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
No edit summary
(Updated for V0.20.)
Line 25: Line 25:
<!--T:7-->
<!--T:7-->
The '''Std OnlineHelp''' command opens the help documentation. To open the documentation for a specified command, use the [[Std_WhatsThis|Std WhatsThis]] command.
The '''Std OnlineHelp''' command opens the help documentation. To open the documentation for a specified command, use the [[Std_WhatsThis|Std WhatsThis]] command.

Since FreeCAD version 0.20 this command requires the [https://github.com/FreeCAD/FreeCAD-Help Help addon].


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


<!--T:9-->
<!--T:9-->
# Make sure the Help addon is available. This addon can be installed 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.
#* Use the keyboard shortcut: {{KEY|F1}}.
#* Use the keyboard shortcut: {{KEY|F1}}.
# The help documentation opens in a new window.
# Topics can be selected from the {{MenuCommand|Contents}} tab or searched from the {{MenuCommand|Index}} tab.

==Notes== <!--T:15-->


<!--T:16-->
* 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]].


<!--T:17-->
<!--T:17-->
Line 54: Line 50:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 20:38, 11 June 2022

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 specified command, use the Std WhatsThis command.

Since FreeCAD version 0.20 this command requires the Help addon.

Usage

  1. Make sure the Help addon is available. This addon can be installed via the Addon Manager.
  2. There are several ways to invoke the command:
    • Select the Help → Help option from the menu.
    • Use the keyboard shortcut: F1.