Form
0
0
504
549
Help
-
Source
-
false
Fetches the documentation from pages rendered on GitHub.
This is currently not available.
GitHub (online)
optionGithub
Mod/Help
-
Set this to a custom URL or the folder where the help files are located.
You can easily download the documentation for offline use by using the Addon
Manager and installing the "offline-documentation" addon. If this
field is left blank, FreeCAD will automatically search for the help files at
the default location ($USERAPPDATADIR/Mod/offline-documentation).
Custom location
optionCustom
Mod/Help
-
100
16777215
A translation suffix to use, for example "fr"
to get French translation of the documentation.
Suffix
Mod/Help
-
Set this to a custom URL or the folder where the help files are located.
Documentation can be downloaded for offline use via the Addon Manager and installing the
"offline-documentation" addon. If this field is left blank, FreeCAD will
automatically search for the help files at the default location
($USERAPPDATADIR/Mod/offline-documentation).
Gui::FileChooser::Directory
Location
Mod/Help
-
Qt::LeftToRight
Translation suffix
-
The documentation pages will be fetched from the official
FreeCADwiki at https://wiki.freecad.org
FreeCAD Wiki (online)
true
optionWiki
Mod/Help
-
The documentation pages will be fetched from an automatic Markdown conversion
of the FreeCAD wiki,hosted on FreeCAD's GitHub account. This can be styled with a
custom stylesheet below and can look nicer than the wiki option. The 'Markdown' or
'Pandoc' Python module should be installed for optimal results.
Markdown version (online)
false
optionMarkdown
Mod/Help
-
Display
-
Note: if PySide Web components are not found on the system, help pages will open in the default web browser regardless of the options below.
true
-
The documentation will open in the default web browser
In the default web browser
true
optionBrowser
Mod/Help
-
The documentation will open in a new tab inside the FreeCAD interface. This requires the PySide QtWebengineWidgets component.
In a FreeCAD tab
false
optionTab
Mod/Help
-
true
Documentation opens in a dockable dialog within FreeCAD, allowing simultaneous work in the 3D view.
Requires the PySide QtWebengineWidgets component.
In a separate, embeddable dialog
optionDialog
Mod/Help
-
Options
-
-
Custom stylesheet
-
Specify the path to an alternative CSS file for styling Markdown pages.
This only applies if Markdown is selected above.
StyleSheet
Mod/Help
-
Qt::Vertical
20
40
Gui::FileChooser
QWidget
Gui::PrefFileChooser
Gui::FileChooser
Gui::PrefRadioButton
QRadioButton
Gui::PrefLineEdit
QLineEdit