User hub/tr: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>
[[Image:Crystal_Clear_app_display.png|right|150]]
[[Image:User_hub.png|64px]]
----
__NOTOC__


This is the main help area for newcomers to FreeCAD.
This is the main help area for newcomers to FreeCAD.


Like FreeCAD itself, these pages are in continuous development, and so there may be missing or outdated information.
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].


If you'd like to contribute to FreeCAD, see the [[Help FreeCAD|Help FreeCAD]] page. 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.
But don't feel discouraged, if you cannot find the information you need, don't hesitate to ask. You can leave comments about FreeCAD, ask questions, and discuss about this wiki in the [http://forum.freecadweb.org FreeCAD forum].


If you would like to know how FreeCAD started years ago visit the [[History|History]] page.
If you'd like to contribute to FreeCAD, see the [[Help FreeCAD]] page. 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]] for the general rules that you should follow.


If you would like to know how FreeCAD started years ago visit the [[History]] page.

__NOTOC__
== Using FreeCAD ==
== Using FreeCAD ==


Line 18: Line 17:


* [[About FreeCAD|Application Overview]]: A general overview of FreeCAD
* [[About FreeCAD|Application Overview]]: A general overview of FreeCAD
* [[Installing]]: How to install FreeCAD on [[Install on Windows|Windows]], [[Install on Unix|Unix/Linux]] and [[Install on Mac|Mac]]
* [[Installing|Installing]]: How to install FreeCAD on [[Install on Windows|Windows]], [[Install_on_Linux|Linux]] and [[Install 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
* [[FAQ|FAQ]]: Frequently asked questions
* [[Tutorials]] covering different parts of FreeCAD
* [[Tutorials|Tutorials]] covering different parts of FreeCAD


===Basic Application===
===Basic application===


* [[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===
===Workbenches===

[[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:
These are the base workbenches bundled with every installation of FreeCAD:

* [[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_Arch.svg|24px]] Use the [[Arch Module|Arch Workbench]] to work with architectural elements.
* [[Image:Workbench_Arch.svg|24px]] Use the [[Arch Module|Arch Workbench]] to work with architectural elements.
Line 45: Line 49:
* [[Image:Workbench_Inspection.svg|24px]] The [[Inspection Workbench|Inspection Workbench]] provides specific tools for examination of shapes. It is still in development.
* [[Image:Workbench_Inspection.svg|24px]] The [[Inspection Workbench|Inspection Workbench]] provides specific tools for examination of shapes. It is still in development.
* [[Image:Workbench_Mesh.svg|24px]] Use the [[Mesh Module|Mesh Workbench]] to work with triangulated meshes.
* [[Image:Workbench_Mesh.svg|24px]] Use the [[Mesh Module|Mesh Workbench]] to work with triangulated meshes.
* [[Image:Workbench_OpenSCAD.svg|24px]] The [[OpenSCAD Module|OpenSCAD Workbench]] for interoperability with OpenSCAD and repairing Constructive Solid Geometry (CSG) model history.
* [[Image:Workbench_OpenSCAD.svg|24px]] The [[OpenSCAD Module|OpenSCAD Workbench]] for interoperability with OpenSCAD and repairing [[constructive solid geometry|constructive solid geometry]] (CSG) model history.
* [[Image:Workbench_Part.svg|24px]] Use the [[Part Module|Part Workbench]] to work with CAD parts.
* [[Image:Workbench_Part.svg|24px]] Use the [[Part Module|Part Workbench]] to design solids with [[constructive solid geometry|constructive solid geometry]] (CSG) workflow.


* [[Image:Workbench_PartDesign.svg|24px]] Use the [[PartDesign Workbench|Part Design Workbench]] to build Part shapes from sketches.
* [[Image:Workbench_PartDesign.svg|24px]] Use the [[PartDesign Workbench|PartDesign Workbench]] to build solids from sketches and parametric operations in what is called [[feature editing|feature editing]] workflow.
* [[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_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_Plot.svg|24px]] Use the [[Plot Module|Plot Workbench]] to edit and save output plots created from other workbenches and tools.
* [[Image:Workbench_Points.svg|24px]] Use the [[Points_Module|Points Workbench]] to work with point clouds.
* [[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)
* [[Image:Workbench_Raytracing.svg|24px]] Use the [[Raytracing Module|Raytracing Workbench]] to work with rendering and ray-tracing.


* [[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_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.
Line 61: Line 65:


* [[Image:Workbench_Start.svg|24px]] The [[Start_Workbench|Start Center Workbench]] allows you to quickly jump to the most common workbenches.
* [[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_Surface.svg|24px]] The [[Surface_Module|Surface Module]] the Surface workbench provides tools to create and modify surfaces.
* [[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_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.
* [[Image:Workbench_Web.svg|24px]] The [[Web Workbench|Web Workbench]] provides you with a browser window instead of the 3D-View within FreeCAD.

===External Workbenches===
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]].


===Macros===
===Macros===

Power users have written various macros to enhance FreeCAD with more capabilities. For a list of the macros refer to the [[macros recipes]] page.
[[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.
For instructions how to install the macros refer to the [[How to install macros]] tutorial.

Power users have written various [[macros|macros]] to enhance FreeCAD with more capabilities.

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]].

===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|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 [[Std AddonMgr|Addon Manager]]. For manual installation see [[How to install additional workbenches|How to install additional workbenches]].


==Reference==
==Reference==
Line 79: Line 92:
== Online Help ==
== Online Help ==


<!-- 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]
-->
-->


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 system - Table of Contents]]
* [[Online Help Toc|Online help system - Table of Contents]]


== More ==
== More ==


* 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]] lists projects made by community members around FreeCAD.
* The [[FreeCAD Community Portal|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.
* Don't understand a term or phrase as used in FreeCAD? Try the [[Glossary|Glossary]] page.


{{Userdocnavi{{#translation:}}}}
[[Category:Hubs]]
[[Category:User Documentation]]
[[Category:Hubs{{#translation:}}]]

Revision as of 20:42, 23 June 2020



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, see the Help FreeCAD page. 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

Basic application

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.

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

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.