freecad / freecad-help Goto Github PK

View Code? Open in Web Editor NEW

9.0 9.0 5.0 85 KB

A new Help system for FreeCAD

License: GNU Lesser General Public License v2.1

Python 97.44% CSS 2.56%

freecad-help's Introduction

Your own 3D parametric modeler

Website • Documentation • Forum • Bug tracker • Git repository • Blog

Overview

Freedom to build what you want FreeCAD is an open-source parametric 3D modeler made primarily to design real-life objects of any size. Parametric modeling allows you to easily modify your design by going back into your model history to change its parameters.
Create 3D from 2D and back FreeCAD lets you to sketch geometry constrained 2D shapes and use them as a base to build other objects. It contains many components to adjust dimensions or extract design details from 3D models to create high quality production-ready drawings.
Designed for your needs FreeCAD is designed to fit a wide range of uses including product design, mechanical engineering and architecture, whether you are a hobbyist, programmer, experienced CAD user, student or teacher.
Cross platform FreeCAD runs on Windows, macOS and Linux operating systems.
Underlying technology
- OpenCASCADE A powerful geometry kernel, the most important component of FreeCAD
- Coin3D library Open Inventor-compliant 3D scene representation model
- Python FreeCAD offers a broad Python API
- Qt Graphical user interface built with Qt

Installing

Precompiled packages for stable releases are available for Windows, macOS and Linux on the Releases page.

On most Linux distributions, FreeCAD is also directly installable from the software center application.

For development releases check the weekly-builds page.

Other options are described at the wiki Download page.

Compiling

Compiling FreeCAD requires installation of several libraries and their development files such as OCCT (Open Cascade), Coin and Qt, listed in the pages below. Once this is done, FreeCAD can be compiled with CMake. On Windows, these libraries are bundled and offered by the FreeCAD team in a convenient package. On Linux, they are usually found in your distribution's repositories, and on macOS and other platforms, you will usually have to compile them yourself.

The pages below contain up-to-date build instructions:

Reporting Issues

To report an issue please:

First post to forum to verify the issue;
Link forum thread to bug tracker ticket and vice-a-versa;
Use the most updated stable or development versions of FreeCAD;
Post version info from eg. Help > About FreeCAD > Copy to clipboard;
Post a Step-By-Step explanation on how to recreate the issue;
Upload an example file to demonstrate problem.

For more detail see:

The FPA offers developers the opportunity to apply for a grant to work on projects of their choosing. Check jobs and funding to know more.

Usage & Getting help

The FreeCAD wiki contains documentation on general FreeCAD usage, Python scripting, and development. These pages might help you get started:

The FreeCAD forum is also a great place to find help and solve specific problems you might encounter when learning to use FreeCAD.

This project receives generous infrastructure support from and KiCad Services Corp.

freecad-help's People

Contributors

Stargazers

Watchers

Forkers

ebrahimraeyat chennes roy-043 donovaly gebrehiwot1

freecad-help's Issues

Help Documentation

This is all a little confusing.

The Help>Help menu gives popup:
FreeCAD help files not found (/usr/share/doc/freecad-doc/freecad.qhc). You might need to install the FreeCAD documentation package.

I installed the Help in addon manager, where it said that it is old and outdated. Then it says it is already added in version .22, but that is not currently available.

I restarted and nothing happened. Later, the addon manager listing changed to say something else.

In all this, there is still no Help in the program.

addon-manager link does nothing

under the option From disk location: there is a link to the Addon manager.
Clicking on it does not open the Addon manager to download the documentation for offline usage.

using Quarto

Hello @yorikvanhavre . This is not really an issue, but I can't find a suitable place for discuss.

It is very interesting:

Quarto

WebGui.openBrowserHTML take at most 3 args (4 given)

Thanks @yorikvanhavre

[New Help system]: NameError: name 's' is not defined

thanks for this great system help.

I cloned the repository, restarted FreeCAD, then typed this commands, gives me this error:

>>> import Help
>>> Help.show("Draft Line")
Traceback (most recent call last):
  File "<input>", line 1, in <module>
  File "C:\Users\ebi\AppData\Roaming\FreeCAD\Mod\FreeCAD-Help\Help.py", line 86, in show
    html = convert(md)
  File "C:\Users\ebi\AppData\Roaming\FreeCAD\Mod\FreeCAD-Help\Help.py", line 225, in convert
    html = convert_raw(content)
  File "C:\Users\ebi\AppData\Roaming\FreeCAD\Mod\FreeCAD-Help\Help.py", line 201, in convert_raw
    m = re.sub(r"\*\*(.*?)\*\*", r"<b>\1</b>",s) # bold
NameError: name 's' is not defined
>>>

Thanks

using mkdocs

Hello. This is not an issue, only because there is no discussion page.

I want to know if it is possible or you prefer to use mkdocs.

It can produce document with reference to source code using markdown files and docstring in python code:

tutorial.

did not show images in FreeCAD mdi area in local html or *.md files

Hi @yorikvanhavre .

I want to show my .md file in FreeCAD mdi area, but it did not show linked images. also did not show linked images in html.

browser works perfectly, I can open it via my chrome browser in windows.

also, when I embed images in html, it shows images in mdi, but this way the volume of html file increases.

Thanks.

French locale triggers 'Contents of this page can not be retrieved' when seeking Help page

Is there an existing issue for this?

I have searched the existing issues

Forums discussion

https://forum.freecadweb.org/viewtopic.php?f=12&t=70295

Version

0.20 (Release)

Full version info

[code]
OS: Windows 10 Version 2009
Word size of FreeCAD: 64-bit
Version: 0.20.29177 (Git)
Build type: Release
Branch: releases/FreeCAD-0-20
Hash: 68e337670e227889217652ddac593c93b5e8dc94
Python 3.8.10, Qt 5.15.2, Coin 4.0.1, Vtk 8.2.0, OCC 7.6.2
Locale: French/France (fr_FR)
Installed mods: 
  * Curves 0.5.2
  * fasteners 0.3.50
  * Help 1.0.3
  * sheetmetal 0.2.51
[/code]

Subproject(s) affected?

No response

Issue description

Erreur quand l'option Freecad tab est coché

Anything else?

No response

Code of Conduct

I agree to follow this project's Code of Conduct

Addon settings are not restored on reinstallation

Assume the user has e.g. set this:

He notices that the What's This? feature does not work and decides to uninstall the Help Addon using the Addon Manager
then he restarts FC and installs the help addon again hoping to get it fixed

result: he ends up with the same broken settings he has before.

I am not sure this is a bug in either the help Addon, the AddonManager or somewhere in FreeCAD. @chennes , could you please have a look?

Add translation support

Add this module to crowdin

https://forum.freecadweb.org/viewtopic.php?p=641031#p641031

Help in Features

See https://forum.freecad.org/viewtopic.php?p=684011#p684011

Please add a Question mark to the top right corner on all open features and link it into the Wiki.