Help Module
Description
The Help module is responsible for handling all requests for documentation, and displaying it in an appropriate manner. Up to FreeCAD version 0.21, the Help module is available as an Addon, after that it is included in FreeCAD itself. There is no problem in leaving the Addon installed after version 0.21.
The Help module provides a preferences page under menu Edit → Preferences → General → Help, which allows to specify:
- The source of the documentation: The documentation can be fetched from online locations such as the official FreeCAD wiki (default) or the Markdown conversion, or from an offline location, such as a folder where the documentation can be downloaded with the Addon manager.
- The way the documentation must be displayed: in your desktop browser, in a separate, dockable dialog, that allows you for ex. to keep the documentation displayed while you are working (this is useful for tutorials), or a new FreeCAD tab. Note that in version 1.0 the 2nd and 3rd option require PySide Web components. If these are missing the 1st option will be used instead.
- An alternative css file: This is used only when using the Markdown or offline sources above, and allows you to customize the styling of the documentation.
Scripting
The Help module basically consists of a single Python module. Its main usage is using the show function. It can retrieve an URL, a local file (Markdown or html), or find a page automatically from the settings set under Preferences → General → Help.
It doesn't matter what you provide, the system will recognize if the contents are HTML or Markdown and render it appropriately.
Basic usage:
import Help
Help.show("Draft Line")
Help.show("Draft_Line") # works with spaces or underscores
Help.show("https://wiki.freecadweb.org/Draft_Line")
Help.show("https://gitlab.com/freecad/FreeCAD-documentation/-/raw/main/wiki/Draft_Line.md")
Help.show("/home/myUser/.FreeCAD/Documentation/Draft_Line.md")
Help.show("http://myserver.com/myfolder/Draft_Line.html")
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Assembly, BIM, CAM, Draft, FEM, Inspection, Material, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub