Std OnlineHelp: Difference between revisions

From FreeCAD Documentation
m (moved templates out of translation tags)
(Revised. Added Docnav.)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

{{Docnav
|
|[[Std_FreeCADWebsite|Std 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 23:


<!--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 online help documentation. To open the documentation for a predefined command, use the [[Std_WhatsThis|Std WhatsThis]] command.

<!--T:8-->
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|Windows → [[Image:Std_OnlineHelp.svg|16px]] Help}} option from the menu.
** Press the {{KEY|F1}} keyboard shortcut
#* Use the keyboard shortcut: {{KEY|F1}}.
# The online help documentation opens in a new window.
* Topics can be selected from the {{MenuCommand|Contents}} tab or searched from the {{MenuCommand|Index}} tab.
# Topics can be selected from the {{MenuCommand|Contents}} tab or searched from the {{MenuCommand|Index}} tab.


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


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


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

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


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

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

{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 17:00, 17 June 2020

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 online help documentation. To open the documentation for a predefined command, use the Std WhatsThis command.

Usage

  1. There are several ways to invoke the command:
    • Select the Windows → Help option from the menu.
    • Use the keyboard shortcut: F1.
  2. The online help documentation opens in a new window.
  3. Topics can be selected from the Contents tab or searched from the Index tab.

Notes

  • 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 freecad-doc, or freecad-daily-doc (for the freecad-daily PPA). See Installing Helpfile.