Is it recommended to use the Content Management System CMSUse the Content Management System. to add, edit and delete content, such as pages, translations, and resources, as it provides a user-friendly interface, adequate settings and pre-configured forms that facilitate the contributing workflow.

Nevertheless, please read the few following guidelines to ensure contributions are in line with the project’s standards and help make the process easier and efficient for everyone involved.

Text

• Texts use a clear, concise, straightforward and inclusive language that welcomes readers from diverse backgrounds and communities (e.g. non-tech, skills, cultures).
• A friendly and supportive tone is used reflecting the free and open-source community collaborative spirit.
• Texts should be easy to translate. If in doubt, ask a translator.
• Texts focus on user benefits in practical and relatable terms that highlight how FreeCAD contribute to solving real-world challenges (e.g. design, engineering, community, free and open-source development).
• Prefer using the active voice when possible (e.g. subject is the agent: “subject does action”, instead of passive voice where subject is recipient: “action is done by subject”) and break complex ideas into simpler and digestible explanations.
• Sometimes an illustration is worth a thousand words.

Translations

To improve translations and add locales, see the dedicated locales page Translations and LanguagesTranslate content and configure locales for the website..

Illustrations

• Images in hero cover and page content are used to illustrate the page message and purpose, and additionally highlight related and successful projects.
• Texts in illustrations are avoided if possible for translation reasons. Attribution and license are respected at all times. If photos depict human beings, a consent agreement is submitted accordingly.
• It is highly recommended to add illustrations files along the page Markdown file in the same directory, using the page bundle approach, so they can be processed by the static site generator templates. For internal resources, relative links are used instead of absolute links.
• Caption and alternate text are provided when adequate:

![alternative text for image](img.webp “image caption”)

Please avoid adding links to images (e.g. [![alt](img.webp)](link)) as the Markdown parser and render hooks mix HTML block-level with inline elements, which is invalid. Use the figure shortcode instead, or add links to nearby heading, text or caption.

A minimum width of about 2000 pixels is recommended. A square or landscape format ratio of 2:1 maximum are recommended. The WebP graphics file format is recommended, with a compression quality of about 80%. Animated GIF and WEBP files are supported, the latter being recommended. AVIF is currently not supported. Media metadata can be stripped, as they are currently not used.

The theme templates resize and crop images at build time depending on their use. The Content Management System also resizes uploaded images at the correct resolution. In most cases, content contributors only need to add one WebP file about 2000px wide.

Several theme shortcodes ShortcodesBundled Trigo Theme and Hugo shortcodes to augment your content. are available to enhance the layout and arrangement of multiple illustrations.

Theme and configuration

To tweak or enhance the Trigo theme and the FreeCAD website configuration, see the dedicated theme page Theme, Project Setup, and ConfigurationEnhance the website project and the Trigo Theme. and the theme ReadMe.

Licensing

The whole FreeCAD website repository is licensed under the GNU Lesser General Public License Version 2.1.

Content

Content of the website is licensed under Creative Commons Attribution ShareAlike 4.0 International. By default, it is copyrighted by and attributed to “FreeCAD”. If they wish so, authors can specify the respective attribution for the content they produce. For Markdown files, the attribution is specified in the author field of the Front Matter.

By submitting Pull Requests to this repository, make sure who is the author of the content. Make sure rights to share under the CC-BY-SA 4.0 license and original author mention are respected. Also note that sharing images with people is subject to obtaining appropriate consent.

FreeCAD branded resources

The trademark of FreeCAD branded resources (e.g. FreeCAD logo) is registered and owned by the FreeCAD Project Association.

Trigo Theme for Hugo

The Trigo Theme is licensed under the MIT License.