Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
 
(18 intermediate revisions by 4 users not shown)
Line 2: Line 2:
<translate>
<translate>


<!--T:14-->
{{Docnav
{{Docnav
|
|
|[[Std_FreeCADWebsite|Std FreeCADWebsite]]
|[[Std_FreeCADWebsite|FreeCADWebsite]]
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=
|IconL=
Line 23: Line 24:


<!--T:7-->
<!--T:7-->
The '''Std OnlineHelp''' command opens the online help documentation. To open the documentation for a predefined 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:20-->
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-->
Line 31: Line 35:
#* 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 online help documentation opens in a new window.
# The help documentation opens.

# Topics can be selected from the {{MenuCommand|Contents}} tab or searched from the {{MenuCommand|Index}} tab.
==Notes== <!--T:15-->


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


* 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-->
{{Docnav
{{Docnav
|
|
|[[Std_FreeCADWebsite|Std FreeCADWebsite]]
|[[Std_FreeCADWebsite|FreeCADWebsite]]
|[[Std_Help_Menu|Std Help Menu]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=
|IconL=
Line 51: Line 56:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

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