User hub: Difference between revisions
(Link to Testing, and not debugging.) |
(Updated some links to renamed pages.) |
||
(43 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> |
<languages/> |
||
[[Image:User_hub.png|64px]] |
|||
---- |
|||
__NOTOC__ |
|||
<translate> |
<translate> |
||
<!--T:1--> |
|||
[[Image:Crystal_Clear_app_display.png|right|150]] |
|||
<!--T:2--> |
<!--T:2--> |
||
This |
This is the main help area for newcomers to FreeCAD. |
||
<!--T:3--> |
<!--T:3--> |
||
These pages are in continuous development, so there may be missing or outdated information. If you cannot find the information that you need, don't hesitate to ask in the [http://forum.freecadweb.org FreeCAD forum]. |
|||
Please note that like FreeCAD itself, these pages are in continuous development. FreeCAD already features many interesting tools for the final user, and more are continuously added, which is why at the moment there is still missing or outdated documentation for the end user. |
|||
<!--T:4--> |
|||
But don't feel discouraged, browse the contents of this section, and, if you cannot find the information you need, don't hesitate to ask! Among the developers or in the small but growing FreeCAD users community, there will certainly be someone who can help you. You can leave comments related to this wiki documentation site on the [http://forum.freecadweb.org FreeCAD help forum] and ask your questions there. |
|||
<!--T:21--> |
<!--T:21--> |
||
If you'd like to contribute to FreeCAD, please [[donate|donate]], and see the [[Help_FreeCAD|Help FreeCAD]] page for other ways to contribute. If you'd like to edit this wiki, request a wiki account with editor permissions [https://forum.freecadweb.org/viewtopic.php?f=21&t=6830 in the forum], and read the [[WikiPages|WikiPages]] for the general guidelines that you should follow. |
|||
And if you have some information you would like to appear here, why not contribute and help us make this manual grow. Head to the [[Help FreeCAD]] page, that will help you to get started. |
|||
<!--T:22--> |
<!--T:22--> |
||
If you would like to know how |
If you would like to know how FreeCAD started years ago visit the [[History|History]] page. |
||
__NOTOC__ |
|||
== Using FreeCAD == <!--T:5--> |
== Using FreeCAD == <!--T:5--> |
||
Line 26: | Line 23: | ||
<!--T:7--> |
<!--T:7--> |
||
* [[About FreeCAD|Application Overview]]: A general overview of FreeCAD |
* [[About FreeCAD|Application Overview]]: A general overview of FreeCAD |
||
* |
* Installing: How to install FreeCAD on [[Installing_on_Windows|Windows]], [[Installing_on_Linux|Linux]] and [[Installing_on_Mac|Mac]] |
||
* [[Installing Helpfile|Installing help files]]: how to install the offline documentation which is based on this wiki. |
|||
* [[Getting started]]: A quick overview of the available tools |
|||
* [[Getting started|Getting started]]: A quick overview of the available tools |
|||
* [[FAQ]]: Frequently asked questions |
|||
* [[Frequently_asked_questions|FAQ]]: Frequently asked questions |
|||
* [[Tutorials]] covering different parts of FreeCAD |
|||
* [[Tutorials|Tutorials]] covering different parts of FreeCAD |
|||
<!--T:41--> |
|||
See also: |
|||
* [[Migrating_to_FreeCAD_from_Fusion360|Migrating to FreeCAD from Fusion360]] |
|||
===Basic application=== <!--T:8--> |
|||
<!--T:9--> |
<!--T:9--> |
||
* [[Interface|Interface]]: the FreeCAD interface is composed of various graphical elements on the screen, including the [[3D view|3D view]], the [[tree view|tree view]], the [[property editor|property editor]], the [[task panel|task panel]], and the [[Python console|Python console]]. |
|||
* [[Mouse Model]]: The use of the mouse to navigate in the 3D space |
|||
* [[Mouse Model|Mouse navigation]]: the different types of using the mouse or trackpad to navigate in the 3D view. |
|||
* [[Document structure]]: How a FreeCAD document is organized |
|||
* [[Selection_methods|Selection methods]]: the different methods of selecting objects in the software. |
|||
* [[Preferences Editor|Preferences]] and [[Interface Customization|Customization]]: How you can configure FreeCAD to your needs |
|||
* [[Object_name|Object name]]: all objects have a read-only {{incode|Name}} that uniquely identifies them, and a {{incode|Label}} which is user editable. |
|||
* [[Property editor|Properties]]: How objects properties work in FreeCAD |
|||
* [[Preferences_Editor|Preferences Editor]]: the system that allows you to control many properties of the base system and of the individual workbenches. |
|||
* [[Workbenches|Workbench Concept]]: How the FreeCAD interface is organized |
|||
* [[Import_Export|File formats]]: the different file formats that FreeCAD can read and write. |
|||
* [[Macros]]: How to easily automate often repeated tasks |
|||
* [[Import_Export|File formats]]: The different file formats that FreeCAD can read and write |
|||
===Workbenches=== <!--T:10--> |
===Workbenches=== <!--T:10--> |
||
These are the base workbenches bundled with every installation of FreeCAD: |
|||
<!--T: |
<!--T:33--> |
||
[[Workbenches|Workbenches]] are collections of tools that are used for a relatively specific task. These are the base workbenches bundled with every installation of FreeCAD: |
|||
* [[Image:Workbench_Arch.svg|24px]] Use the [[Arch Module|Arch Workbench]] to work with architectural elements. |
|||
* [[Image:Workbench_Complete.svg|24px]] The [[Complete_Workbench|Complete Workbench]] holds all commands and features from all the modules and workbenches which met certain quality criteria. |
|||
* [[Image:Workbench_Draft.svg|24px]] The [[Draft Module|Draft Workbench]] contains 2D tools and basic 2D and 3D CAD operations. |
|||
* [[Image:Workbench_Drawing.svg|24px]] Use the [[Drawing Module|Drawing Workbench]] to display your 3D work on a 2D sheet. |
|||
* [[Image:Workbench_FEM.svg|24px]] The [[FEM Module|FEM Workbench]] provides a [https://en.wikipedia.org/wiki/Finite_element_method Finite Element Analysis] (FEA) workflow. |
|||
<!--T: |
<!--T:40--> |
||
* [[File:Freecad.svg|32px]] [[Std_Base|Std Base]]. This is not really a workbench, but rather a category of 'standard' commands and tools that can be used in all workbenches. |
|||
* [[Image:Workbench_Image.svg|24px]] Use the [[Image Module|Image Workbench]] to work with bitmap images. |
|||
* [[Image: |
* [[Image:Workbench_Arch.svg|32px]] The [[Arch Module|Arch Workbench]] for working with architectural elements. |
||
* [[Image: |
* [[Image:Workbench_Draft.svg|32px]] The [[Draft Module|Draft Workbench]] contains 2D tools and basic 2D and 3D CAD operations. |
||
* [[Image: |
* [[Image:Workbench_FEM.svg|32px]] The [[FEM Module|FEM Workbench]] provides Finite Element Analysis (FEA) workflow. |
||
* [[Image: |
* [[Image:Workbench_Image.svg|32px]] The [[Image Module|Image Workbench]] for working with bitmap images. |
||
* [[Image:Workbench_Inspection.svg|32px]] The [[Inspection Workbench|Inspection Workbench]] is made to give you specific tools for examination of shapes. It is still in development. |
|||
* [[Image:Workbench_Mesh.svg|32px]] The [[Mesh Workbench|Mesh Workbench]] for working with triangulated meshes. |
|||
* [[Image:Workbench_OpenSCAD.svg|32px]] The [[OpenSCAD Module|OpenSCAD Workbench]] for interoperability with OpenSCAD and repairing [[constructive solid geometry|constructive solid geometry]] (CSG) model history. |
|||
* [[Image:Workbench_Part.svg|32px]] The [[Part Module|Part Workbench]] for working with CAD parts. |
|||
* [[Image:Workbench_PartDesign.svg|32px]] The [[PartDesign Workbench|Part Design Workbench]] for building Part shapes from sketches. |
|||
* [[Image:Workbench_Path.svg|32px]] The [[Path_Workbench|Path Workbench]] is used to produce G-Code instructions. It is still in a stage of development. |
|||
* [[Image:Workbench_Points.svg|32px]] The [[Points_Module|Points Workbench]] for working with point clouds. |
|||
* [[Image:Workbench_Raytracing.svg|32px]] The [[Raytracing Module|Raytracing Workbench]] for working with ray-tracing (rendering) |
|||
* [[Image:Workbench_Reverse_Engineering.svg|32px]] The [[Reverse Engineering Workbench|Reverse Engineering Workbench]] is intended to provide specific tools to convert shapes/solids/meshes into parametric FreeCAD-compatible features. (under development) |
|||
* [[Image:Workbench_Robot.svg|32px]] The [[Robot_Workbench|Robot Workbench]] for studying robot movements. |
|||
* [[Image:Workbench_Sketcher.svg|32px]] The [[Sketcher Workbench|Sketcher Workbench]] for working with geometry-constrained sketches. |
|||
* [[Image:Workbench_Spreadsheet.svg|32px]] The [[Spreadsheet Workbench|Spreadsheet Workbench]] for creating and manipulating spreadsheet data. |
|||
* [[Image:Workbench_Start.svg|32px]] The [[Start_Workbench|Start Center Workbench]] allows you to quickly jump to one of the most common workbenches. |
|||
* [[Image:Workbench_Surface.svg|32px]] The [[Surface_Module|Surface workbench]] provides tools to create and modify surfaces. It is similar as the Part Shape builder Face from edges. |
|||
* [[Image:Workbench_TechDraw.svg|32px]] The [[TechDraw Module|TechDraw Workbench]] is the more advanced and feature-rich successor of [[Drawing Module|Drawing]] |
|||
* [[Image:Workbench_Test.svg|32px]] The [[Testing|Test Framework Workbench]] is for debugging FreeCAD. |
|||
* [[Image:Workbench_Web.svg|32px]] The [[Web Workbench|Web Workbench]] provides you with a browser window instead of the [[3D view|3D view]] within FreeCAD. |
|||
<!--T: |
===Macros=== <!--T:24--> |
||
* [[Image:Workbench_PartDesign.svg|24px]] Use the [[PartDesign Workbench|Part Design Workbench]] to build Part shapes from sketches. |
|||
* [[Image:Workbench_Path.svg|24px]] Use the [[Path_Workbench|Path Workbench]] to produce G-Code instructions. It is still in a stage of development. Only basic functions in 0.16 |
|||
* [[Image:Workbench_Plot.svg|24px]] Use the [[Plot Module|Plot Workbench]] to edit and save output plots created from other modules and tools. |
|||
* [[Image:Workbench_Points.svg|24px]] Use the [[Points_Module|Points Workbench]] to work with point clouds. |
|||
* [[Image:Workbench_Raytracing.svg|24px]] Use the [[Raytracing Module|Raytracing Workbench]] to work with ray-tracing (rendering) |
|||
<!--T: |
<!--T:35--> |
||
[[Macros|Macros]] are relatively small snippets of [[Python|Python]] code that perform a simple or a complex task that is not available in the base FreeCAD system. |
|||
* [[Image:Workbench_Reverse_Engineering.svg|24px]] The [[Reverse Engineering Workbench|Reverse Engineering Workbench]] is intended to give you specific tools to convert shapes/solids/meshes into parametric FreeCAD-compatible features. It is still in development. |
|||
* [[Image:Workbench_Robot.svg|24px]] Use the [[Robot_Workbench|Robot Workbench]] to study robot movements. |
|||
* [[Image:Workbench_Ship.svg|24px]] The [[Ship Workbench|Ship Workbench]] FreeCAD-Ship works over Ship entities, that must be created on top of provided geometry. |
|||
* [[Image:Workbench_Sketcher.svg|24px]] Use the [[Sketcher Module|Sketcher Workbench]] to work with geometry-constrained sketches. |
|||
* [[Image:Workbench_Spreadsheet.svg|24px]] Use the [[Spreadsheet Module|Spreadsheet Workbench]] to create and manipulating spreadsheet data. |
|||
<!--T: |
<!--T:36--> |
||
Power users have written various [[macros|macros]] to enhance FreeCAD with more capabilities. |
|||
* [[Image:Workbench_Start.svg|24px]] The [[Start_Workbench|Start Center Workbench]] allows you to quickly jump to the most common workbenches. |
|||
* [[Image:Workbench_TechDraw.svg|24px]] The [[TechDraw Module|TechDraw Workbench]] is the more advanced and feature-rich successor of [[Drawing Module|Drawing]] |
|||
* [[Image:Workbench_Test.svg|24px]] The [[Testing|Test Framework Workbench]] is for debugging FreeCAD. |
|||
* [[Image:Workbench_Web.svg|24px]] The [[Web Workbench|Web Workbench]] provides you with a browser window instead of the 3D-View within FreeCAD. |
|||
<!--T:32--> |
|||
Since FreeCAD 0.17, many macros can be installed using the [[Std AddonMgr|Addon Manager]]. For a list of the macros refer to the [[macros recipes|macros recipes]] page. For manual installation see [[How to install macros|How to install macros]]. |
|||
Power users have extended FreeCAD with various custom external workbenches, that are not integrated into the FreeCAD source code, but are easy to install on an existing FreeCAD installation. [[External workbenches|See here]] for an overview of the already available workbenches. |
|||
For instructions how to install these workbenches refer to the tutorial [[How to install additional workbenches]]. |
|||
=== |
===External workbenches=== <!--T:23--> |
||
Power users have written various macros to enhance FreeCAD with more capabilities. For a list of the macros refer to the [[macros recipes]] page. |
|||
<!--T:37--> |
|||
For instructions how to install the macros refer to the [[How to install macros]] tutorial. |
|||
When many macros or functions are developed together, and are organized in toolbars and menus, they can become a new workbench. |
|||
<!--T:38--> |
|||
[[External_workbenches|External workbenches]] are collections of functions that are not part of the base FreeCAD system, usually developed by experienced users, and targeting a particular need. |
|||
<!--T:31--> |
|||
Since FreeCAD 0.17, many workbenches can be installed using the [[Std AddonMgr|Addon Manager]]. For manual installation see [[How to install additional workbenches|How to install additional workbenches]]. |
|||
==Reference== <!--T:12--> |
==Reference== <!--T:12--> |
||
Line 95: | Line 102: | ||
<!--T:15--> |
<!--T:15--> |
||
<!-- To download the online help in FreeCAD you need to set the proper Url in the [[Preferences Editor]] of FreeCAD. Currently the right url has to point to this page. That means you need to set it to: |
<!-- To download the online help in FreeCAD you need to set the proper Url in the [[Preferences Editor|Preferences Editor]] of FreeCAD. Currently the right url has to point to this page. That means you need to set it to: |
||
[http://juergen-riegel.net/FreeCAD/Docu/index.php/User_hub http://juergen-riegel.net/FreeCAD/Docu/index.php/User_hub] |
[http://juergen-riegel.net/FreeCAD/Docu/index.php/User_hub http://juergen-riegel.net/FreeCAD/Docu/index.php/User_hub] |
||
--> |
--> |
||
Line 101: | Line 108: | ||
<!--T:16--> |
<!--T:16--> |
||
This is the official FreeCAD online help. Please note that the whole online help system is currently being reworked. It will be used to generate a .CHM file, that will be distributed with the binary packages of FreeCAD. At the moment the online help summarizes some of the most complete sections of this wiki. |
This is the official FreeCAD online help. Please note that the whole online help system is currently being reworked. It will be used to generate a .CHM file, that will be distributed with the binary packages of FreeCAD. At the moment the online help summarizes some of the most complete sections of this wiki. |
||
* [[Online Help Toc| |
* [[Online Help Toc|Online help system - Table of Contents]] |
||
== More == <!--T:17--> |
== More == <!--T:17--> |
||
<!--T:18--> |
<!--T:18--> |
||
* The [[Power users hub]] is the place to go if you would like to see more advanced use of FreeCAD |
* The [[Power users hub|Power users hub]] is the place to go if you would like to see more advanced use of FreeCAD |
||
* The [[FreeCAD Community Portal|FreeCAD Community Portal]] lists projects made by community members around FreeCAD. |
|||
* [http://yorik.uncreated.net/guestblog.php?tag=freecad Architecture workflow] : An example of how FreeCAD can begin to have its preliminary place in an architecture workflow... |
|||
* |
* Don't understand a term or phrase as used in FreeCAD? Try the [[Glossary|Glossary]] page. |
||
* The [[FreeCAD Community Portal]] lists projects made by community members around FreeCAD. |
|||
* Don't understand a term or phrase as used in FreeCAD? Try the [[Glossary]] page. |
|||
<!--T:20--> |
|||
[[Category:Hubs]] |
|||
[[Category:User Documentation]] |
|||
</translate> |
</translate> |
||
{{Userdocnavi{{#translation:}}}} |
|||
[[Category:Hubs{{#translation:}}]] |
Revision as of 15:56, 5 January 2021
This is the main help area for newcomers to FreeCAD.
These pages are in continuous development, so there may be missing or outdated information. If you cannot find the information that you need, don't hesitate to ask in the FreeCAD forum.
If you'd like to contribute to FreeCAD, please donate, and see the Help FreeCAD page for other ways to contribute. If you'd like to edit this wiki, request a wiki account with editor permissions in the forum, and read the WikiPages for the general guidelines that you should follow.
If you would like to know how FreeCAD started years ago visit the History page.
Using FreeCAD
Introduction
- Application Overview: A general overview of FreeCAD
- Installing: How to install FreeCAD on Windows, Linux and Mac
- Installing help files: how to install the offline documentation which is based on this wiki.
- Getting started: A quick overview of the available tools
- FAQ: Frequently asked questions
- Tutorials covering different parts of FreeCAD
See also:
Basic application
- Interface: the FreeCAD interface is composed of various graphical elements on the screen, including the 3D view, the tree view, the property editor, the task panel, and the Python console.
- Mouse navigation: the different types of using the mouse or trackpad to navigate in the 3D view.
- Selection methods: the different methods of selecting objects in the software.
- Object name: all objects have a read-only
Name
that uniquely identifies them, and aLabel
which is user editable. - Preferences Editor: the system that allows you to control many properties of the base system and of the individual workbenches.
- File formats: the different file formats that FreeCAD can read and write.
Workbenches
Workbenches are collections of tools that are used for a relatively specific task. These are the base workbenches bundled with every installation of FreeCAD:
- Std Base. This is not really a workbench, but rather a category of 'standard' commands and tools that can be used in all workbenches.
- The Arch Workbench for working with architectural elements.
- The Draft Workbench contains 2D tools and basic 2D and 3D CAD operations.
- The FEM Workbench provides Finite Element Analysis (FEA) workflow.
- The Image Workbench for working with bitmap images.
- The Inspection Workbench is made to give you specific tools for examination of shapes. It is still in development.
- The Mesh Workbench for working with triangulated meshes.
- The OpenSCAD Workbench for interoperability with OpenSCAD and repairing constructive solid geometry (CSG) model history.
- The Part Workbench for working with CAD parts.
- The Part Design Workbench for building Part shapes from sketches.
- The Path Workbench is used to produce G-Code instructions. It is still in a stage of development.
- The Points Workbench for working with point clouds.
- The Raytracing Workbench for working with ray-tracing (rendering)
- The Reverse Engineering Workbench is intended to provide specific tools to convert shapes/solids/meshes into parametric FreeCAD-compatible features. (under development)
- The Robot Workbench for studying robot movements.
- The Sketcher Workbench for working with geometry-constrained sketches.
- The Spreadsheet Workbench for creating and manipulating spreadsheet data.
- The Start Center Workbench allows you to quickly jump to one of the most common workbenches.
- The Surface workbench provides tools to create and modify surfaces. It is similar as the Part Shape builder Face from edges.
- The TechDraw Workbench is the more advanced and feature-rich successor of Drawing
- The Test Framework Workbench is for debugging FreeCAD.
- The Web Workbench provides you with a browser window instead of the 3D view within FreeCAD.
Macros
Macros are relatively small snippets of Python code that perform a simple or a complex task that is not available in the base FreeCAD system.
Power users have written various macros to enhance FreeCAD with more capabilities.
Since FreeCAD 0.17, many macros can be installed using the Addon Manager. For a list of the macros refer to the macros recipes page. For manual installation see How to install macros.
External workbenches
When many macros or functions are developed together, and are organized in toolbars and menus, they can become a new workbench.
External workbenches are collections of functions that are not part of the base FreeCAD system, usually developed by experienced users, and targeting a particular need.
Since FreeCAD 0.17, many workbenches can be installed using the Addon Manager. For manual installation see How to install additional workbenches.
Reference
- Commands Reference: A complete list of the available FreeCAD commands.
Online Help
This is the official FreeCAD online help. Please note that the whole online help system is currently being reworked. It will be used to generate a .CHM file, that will be distributed with the binary packages of FreeCAD. At the moment the online help summarizes some of the most complete sections of this wiki.
More
- The Power users hub is the place to go if you would like to see more advanced use of FreeCAD
- The FreeCAD Community Portal lists projects made by community members around FreeCAD.
- Don't understand a term or phrase as used in FreeCAD? Try the Glossary page.
- 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, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web
- Hubs: User hub, Power users hub, Developer hub