Addon/de: Difference between revisions

From FreeCAD Documentation
(Created page with "Es gibt zwei Arten von Addons: * Makros: kurze Schnippsel von Python-Code, die ein neues Werkzeug oder eine Funktionalität hinzufügen * Externa...")
(Created page with "===C++Arbeitsbereiche===")
(33 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}


== Einführung ==
== Einführung ==


In FreeCAD und dieser Dokumentation ist ein [[addon/de|Addon]] eine beliebige Komponente, die nicht Teil der Basis-FreeCAD-Installation ist, die aber dem System durch bestimmte Methoden hinzugefügt werden kann.
In FreeCAD und dieser Dokumentation ist eine [[addon/de|Erweiterung]] eine beliebige Komponente, die nicht Teil der Basisinstallation ist, die aber dem System durch bestimmte Methoden hinzugefügt werden kann.


== Verschiedene Typen ==
Es gibt zwei Arten von Addons:
* [[Macros/de|Makros]]: kurze Schnippsel von [[Python/de|Python]]-Code, die ein neues Werkzeug oder eine Funktionalität hinzufügen
* [[External workbenches/de|Externe Arbeitsbereiche]]: Sammlungen von Werkzeugen in Python oder C++, die FreeCAD in einer wichtigen Weise erweitern


Es gibt drei Arten von Erweiterungen:
Macros usually start as a way to simplify or automate the task of drawing or editing a particular object. If many of these macros are collected inside a directory, the entire directory may be distributed as a new workbench.
* [[Macros/de|Makros]]: Kurzer Abschnitt von [[Python/de|Python]]-Kode, der ein neues Werkzeug oder eine neue Funktionalität in einer einzelnen Datei mit der Endung {{incode|.FCMacro}} bereitstellt.
* [[External workbenches/de|Arbeitsbereiche]]: Sammlungen von Python-Dateien, die zusammengehörige [[Gui_Command/de|GUI-Befehle]] (Werkzeuge) bereitstellen, die sich auf ein bestimmtes Thema beziehen, z.B. Werkzeuge für den Entwurf von Schränken, Werkzeuge für die Arbeit mit Architektur oder Werkzeuge für den Entwurf von Booten usw. Diese Arbeitsbereiche definieren normalerweise neue Werkzeugleisten, in denen [[Gui_Command/de|Befehle]] als Schaltflächen platziert werden.
* [[Preference_Packs|Voreinstellungspakete]]: Verteilbare Sammlung von Benutzervoreinstellungen. {{Version/de|0.20}}


== Installation ==
In other words, macros and workbenches are essentially the same thing, pieces of code that extend the base installation. Macros are usually short utilities focused on a single task, while workbenches are collections of organized tools and graphical interfaces to perform related tasks.


Beginnend mit FreeCAD 0.17 wird zur Installation von Erweiterungen die Verwendung des [[File:Std_AddonMgr.svg|24px]] [[Std_AddonMgr/de|Addon-Managers]] empfohlen.
If a workbench is sufficiently developed and is well documented, it may be included as one of the base [[workbenches]] in FreeCAD.


Aber für Makros und Arbeitsbereiche ist auch eine manuelle Installation möglich:
== Installation ==
* [[How to install macros/de|Wie Makros installiert werden]]
* [[Installing more workbenches/de|Weitere Arbeitsbereiche installieren]]

==Informationen für Entwickler==

If you have developed a macro or workbench, and want to see it included in the Addon manager, read how to do so on the repository pages: ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). If you add your macro to the [[Macros_recipes|Macros recipes]] page, there is nothing else to do, it will automatically be picked up by the Addon manager.

===Python-Arbeitsbereiche===

For Python workbenches, you don't need any specific approval to have your workbench added to the Addon Manager. In addition, because your Addon is outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the Addon Manager's default list (we will not add any new workbench without a request from its authors), either by asking so on the forum or by opening an issue on the [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] repository, your code will stay on your own git repository, we will just add it as a submodule to the [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] repository. Of course, before adding your workbench, we will take a look at it and make sure there is nothing potentially problematic with it. For more details about structuring your Addon, including information about metadata used by the Addon Manager, see [[Workbench_creation|Workbench creation]].

===C++Arbeitsbereiche===


If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have two options, either you provide precompiled versions of your workbench yourself, for the different operating systems, or you should request to have your code merged into the FreeCAD source code. For that, you should use the LGPL license (or a fully compatible license like MIT or BSD), and you must present your new tools to the community in the [https://forum.freecadweb.org FreeCAD forum] for review. Once your code has been tested and approved, you should fork the FreeCAD repository, if not done yet, create a new branch, push your code to it, and open a pull request so that your branch is merged into the main repository.
Starting from FreeCAD 0.17, the recommended way to install addons is with the [[Addon Manager]].


Manual installation is still possible.
* [[How to install macros]]
* [[Installing more workbenches]]


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

Revision as of 18:10, 21 June 2022

Einführung

In FreeCAD und dieser Dokumentation ist eine Erweiterung eine beliebige Komponente, die nicht Teil der Basisinstallation ist, die aber dem System durch bestimmte Methoden hinzugefügt werden kann.

Verschiedene Typen

Es gibt drei Arten von Erweiterungen:

  • Makros: Kurzer Abschnitt von Python-Kode, der ein neues Werkzeug oder eine neue Funktionalität in einer einzelnen Datei mit der Endung .FCMacro bereitstellt.
  • Arbeitsbereiche: Sammlungen von Python-Dateien, die zusammengehörige GUI-Befehle (Werkzeuge) bereitstellen, die sich auf ein bestimmtes Thema beziehen, z.B. Werkzeuge für den Entwurf von Schränken, Werkzeuge für die Arbeit mit Architektur oder Werkzeuge für den Entwurf von Booten usw. Diese Arbeitsbereiche definieren normalerweise neue Werkzeugleisten, in denen Befehle als Schaltflächen platziert werden.
  • Voreinstellungspakete: Verteilbare Sammlung von Benutzervoreinstellungen. eingeführt mit Version 0.20

Installation

Beginnend mit FreeCAD 0.17 wird zur Installation von Erweiterungen die Verwendung des Addon-Managers empfohlen.

Aber für Makros und Arbeitsbereiche ist auch eine manuelle Installation möglich:

Informationen für Entwickler

If you have developed a macro or workbench, and want to see it included in the Addon manager, read how to do so on the repository pages: (FreeCAD-addons and FreeCAD-macros). If you add your macro to the Macros recipes page, there is nothing else to do, it will automatically be picked up by the Addon manager.

Python-Arbeitsbereiche

For Python workbenches, you don't need any specific approval to have your workbench added to the Addon Manager. In addition, because your Addon is outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the Addon Manager's default list (we will not add any new workbench without a request from its authors), either by asking so on the forum or by opening an issue on the FreeCAD-addons repository, your code will stay on your own git repository, we will just add it as a submodule to the FreeCAD-addons repository. Of course, before adding your workbench, we will take a look at it and make sure there is nothing potentially problematic with it. For more details about structuring your Addon, including information about metadata used by the Addon Manager, see Workbench creation.

C++Arbeitsbereiche

If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have two options, either you provide precompiled versions of your workbench yourself, for the different operating systems, or you should request to have your code merged into the FreeCAD source code. For that, you should use the LGPL license (or a fully compatible license like MIT or BSD), and you must present your new tools to the community in the FreeCAD forum for review. Once your code has been tested and approved, you should fork the FreeCAD repository, if not done yet, create a new branch, push your code to it, and open a pull request so that your branch is merged into the main repository.