Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
No edit summary
(Marked this version for translation)
 
(35 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:14-->
{{Docnav
|
|[[Std_FreeCADWebsite|FreeCADWebsite]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=
|IconR=Std_FreeCADWebsite.svg
|IconC=Freecad.svg
}}


<!--T:2-->
<!--T:2-->
{{GuiCommand
{{GuiCommand
|Name=Std OnlineHelp
|Name=Std OnlineHelp
|MenuLocation=[[Std Help Menu|Help]] → Help
|MenuLocation=Help → Help
|Workbenches=All
|Workbenches=All
|Shortcut=F1
|Shortcut={{KEY|F1}}
|SeeAlso=[[Std_FreeCADUserHub|Users documentation]]
|SeeAlso=[[Std_WhatsThis|Std WhatsThis]]
}}
}}


==Description== <!--T:3-->


<!--T:7-->
The '''Std OnlineHelp''' command opens the help documentation. To open the documentation for a specific command, use the [[Std_WhatsThis|Std WhatsThis]] command.


==Description== <!--T:3-->
<!--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.
Opens the online help documentation in a new window.


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


==How to use== <!--T:4-->
<!--T:9-->
# There are several ways to invoke the command:
* Open the '''Help → Help''' menu or press {{KEY|F1}}.
#* Select the {{MenuCommand|Help → [[Image:Std_OnlineHelp.svg|16px]] Help}} option from the menu.
* Topics can be selected from the Contents tab or searched from the Index tab.
#* Use the keyboard shortcut: {{KEY|F1}}.
# The help documentation opens.


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

'''Note:''' on Debian/Ubuntu and possibly other Linux systems, the FreeCAD documentation is not included in the FreeCAD package and needs to be installed separately. The package may be named freecad-doc or freecad-daily-doc (for the freecad-daily PPA).
<!--T:19-->
* The Help system has a number of preferences. See [[Preferences_Editor#Help|Preferences Editor]].


<!--T:17-->
{{Docnav
|
|[[Std_FreeCADWebsite|FreeCADWebsite]]
|[[Std_Help_Menu|Std Help Menu]]
|IconL=
|IconR=Std_FreeCADWebsite.svg
|IconC=Freecad.svg
}}


</translate>
</translate>
{{Std Base navi{{#translation:}}}}
{{clear}}
{{Userdocnavi{{#translation:}}}}

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