Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
m (moved templates out of translation tags)
(Marked this version for translation)
 
(22 intermediate revisions by 4 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={{StdMenu|[[Std Help Menu|Help]]}} → Help
|MenuLocation=Help → Help
|Workbenches=All
|Workbenches=All
|Shortcut={{KEY|F1}}
|Shortcut={{KEY|F1}}
|SeeAlso=[[Std_WhatsThis|What's This?]], [[Std_FreeCADUserHub|User hub]], [[Std_Help_Menu|Help menu]]
|SeeAlso=[[Std_WhatsThis|Std WhatsThis]]
}}
}}


Line 14: Line 24:


<!--T:7-->
<!--T:7-->
[[Std_OnlineHelp|Std OnlineHelp]] opens the online help documentation in a new window. To open the documentation with a predefined command help page, use the [[Std_WhatsThis|Std WhatsThis]] tool.
The '''Std OnlineHelp''' command opens the help documentation. To open the documentation for a specific command, use the [[Std_WhatsThis|Std WhatsThis]] command.


<!--T:8-->
<!--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.
The documentation is based on Qt compiled HTML pages. For it to launch Qt Assistant must be installed.


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


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


==Documentation files== <!--T:10-->
==Notes== <!--T:15-->


<!--T:5-->
<!--T:19-->
* The Help system has a number of preferences. See [[Preferences_Editor#Help|Preferences Editor]].
On Debian/Ubuntu and possibly other Linux systems, the offline documentation may not be included with the main FreeCAD package, and may need to be installed separately.


<!--T:11-->
The package may be named {{incode|freecad-doc}} or {{incode|freecad-daily-doc}} for the {{incode|freecad-daily}} PPA.


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


</translate>
</translate>
{{clear}}

{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}

{{Userdocnavi{{#translation:}}}}
{{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