Donation Sponsor

$5 $10 $25 $100 $200 Other

If you are not sure or not able to commit to a regular donation, but still want to help the project, you can do a one-time donation, of any amount.

Choose freely the amount you wish to donate one time only.

We call sponsoring the act of donating money recurrently to the FreeCAD project. You can do that as an individual or as a company or institution, through different channels or platforms, depending on your preferences.

Sponsoring FreeCAD allows its developers to count on a steady flow of income, so it allows the FPA to plan things ahead, and the FreeCAD developers to invest themselves more seriously into FreeCAD.

To encourage persons and companies to sponsor the FreeCAD project, we have created different sponsoring tiers. When donating regularly to the project, unless you prefer to stay anonymous, your name, company name and/or logo will be featured on this website, depending on the tier you fit into:

♥ Normal sponsor : from 1 USD / 1 EUR per month. You will not have your name displayed here, but you will have helped the project a lot anyway. Together, normal sponsors maintain the project on its feet as much as the bigger sponsors.
🥉 Bronze sponsor : from 25 USD / 25 EUR per month. Your name or company name is displayed on this page.
🥈 Silver sponsor : from 100 USD / 100 EUR per month. Your name or company name is displayed on this page, with a link to your website, and a one-line description text.
🥇 Gold sponsor : from 200 USD / 200 EUR per month. Your name or company name and logo displayed on this page, with a link to your website and a custom description text. Companies that have helped FreeCAD early on also appear under Gold sponsors.

Instead of donating each month, you might find it more comfortable to make a one-time donation that, when divided by twelve, would give you right to enter a sponsoring tier. Don't hesitate to do so!

Choose freely the amount you wish to donate each month.

Please inform your forum name or twitter handle as a notein your transfer, or reach to us, so we can give you proper credits!

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 {{Incode|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")

⏵ documentation index > Addons > External Workbenches > Help > Help Module

This page is retrieved from https://github.com/FreeCAD/FreeCAD-documentation/blob/main/wiki/Help_Module.md

Donate

Help Module

Description

Scripting