Std AddonMgr/de: Difference between revisions

From FreeCAD Documentation
(Created page with "== Anwendung ==")
(Updating to match new version of source page)
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<div class="mw-translate-fuzzy">
{{GuiCommand/de
{{GuiCommand/de
|Name/de=Addon manager
|Name/de=Addon manager
Line 8: Line 9:
|Version=0.17
|Version=0.17
}}
}}
</div>


<div class="mw-translate-fuzzy">
<div class="mw-translate-fuzzy">
Der Addon-Manager erlaubt es, [[external workbenches/de|externe Arbeitsbereiche]] und [[macros/de|Makros]] zu installieren, zu aktualisieren und zu löschen. Falls das [https://github.com/gitpython-developers/GitPython git-python]-Paket auf Deinem Computer installiert ist, wird es der Addon-Manager benutzen, um installierte Arbeitsbereiche zu aktualisieren und Downloads zu beschleunigen.
Der '''Addon-Manager''' ist ein Werkzeug zum installieren und verwalten von [[external workbenches/de|externen Arbeitsbereichen]] und [[macros/de|Makros]], die von der FreeCAD-Community bereitgestellt werden. Falls das [https://github.com/gitpython-developers/GitPython git-python]-Paket auf Deinem Computer installiert ist, wird es der Addon-Manager benutzen, um installierte Arbeitsbereiche zu aktualisieren und Downloads zu beschleunigen.
</div>
</div>


<div class="mw-translate-fuzzy">
Eine vollständige Liste der Arbeitsbereiche und Makros finden Sie in zwei Repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] und [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], sowie den [[Macros recipes/de|Macro Rezepten]].
Eine vollständige Liste der Arbeitsbereiche und Makros finden Sie in zwei Repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] und [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], sowie den [[Macros recipes/de|Macro Rezepten]].
</div>


<div class="mw-translate-fuzzy">
[[Image:Addon_Manager_example.png]]
[[Image:Addon_Manager_example.png]]
{{Caption|Schnittstelle des [[AddonManager/de|Addon-Managers]]}}
{{Caption|Schnittstelle des [[AddonManager/de|Addon-Managers]]}}
</div>


== Anwendung ==
== Anwendung ==


<div class="mw-translate-fuzzy">
* Open the tool in the menu {{MenuCommand|Tools → Addon manager}}.
* Öffnen Sie das Werkzeug im Menü {{MenuCommand|Werkzeuge → Extras → Addon-Manager}}.
* To install a workbench: scroll through the list and select the add-on; a short description, as well as its home page, will be displayed below the list. Press the {{Button|Install/update}} button to install the new tool. For macros, click on the {{MenuCommand|Macros}} tab and repeat the steps.
* Um eine Workbench zu installieren: Scrollen Sie durch die Liste und wählen Sie das Add-On. Die Beschreibung des Add-Ons wird unter der Liste sowie der Link zur Add-On-Seite angezeigt. Drücken Sie dann die Schaltfläche {{Button|Install/update}}, um das neue Werkzeug zu installieren. Bei Makros drücken Sie {{MenuCommand|Makros}} und wiederholen Sie die Schritte.
* To remove a workbench or a macro: scroll through the list, select the add-on, and then press the {{Button|Remove}} button.
* So entfernen Sie eine Workbench oder ein Makro: Blättern Sie durch die Liste, wählen Sie das Add-on aus und drücken Sie die Schaltfläche {{Button|Remove}}.
* To update a workbench or a macro: scroll through the list, select the add-on, and then press the {{Button|Install/update}} button.
* Um eine Workbench oder ein Makro zu aktualisieren: Blättern Sie durch die Liste, wählen Sie das Add-on und drücken Sie die Schaltfläche {{Button|Install/update}}.
* To check for updates: press the {{Button|[[File:Std Refresh.png|16px]] Refresh}} button; available updates will be reported below the list. Press the {{Button|[[File:Std Refresh.png|16px]] Refresh}} button again to install all updates at once. {{Emphasis|Note:}} the icon may look different depending on your operating system.
* Nach Updates suchen: Drücken Sie die Schaltfläche {{Button|[[File: Std Refresh.png | 24px]]}}; verfügbare Updates werden unterhalb der Liste angezeigt. Durch erneutes Drücken der Update-Taste werden alle Updates gleichzeitig aktualisiert. {{Emphasis|Note:}} Das Symbol kann je nach Betriebssystem anders aussehen.
* To run a macro: first install the desired macro, then select it again on the list, and then press the {{Button|Execute}} button.
* Um ein Makro auszuführen: Installieren Sie zuerst das gewünschte Makro, wählen Sie es erneut in der Liste und drücken Sie die Schaltfläche {{Button|Execute}}. Das Makro wird automatisch im FreeCAD-Makro-Editor dargestellt, um den Code zu zeigen.
* Press {{Button|Close}} to exit the manager.
* Drücken Sie {{Button|Close}}, um den Manager zu beenden.
</div>


=== Manual installation ===
=== Manuelle Installation ===
If you don't use the Addon Manager, you can install the new tools manually by placing their code in your user's {{incode|FreeCAD/}} directory. See the following links for details:
Wenn Sie den Addon-Manager nicht verwenden, können Sie die neuen Werkzeuge manuell installieren, indem Sie deren Code in Ihrem {{incode|FreeCAD/}}-Benutzerverzeichnis ablegen. Details finden Sie unter:
* [[How to install macros|How to install macros]]
* [[How to install macros/de|Makros installieren]]
* [[How to install additional workbenches|How to install additional workbenches]]
* [[How to install additional workbenches/de|Zusätzliche Arbeitsbereiche installieren]]


==Einschränkungen==
== Limitations ==


* Diese Add-Ons gehören nicht zum offiziellen FreeCAD-Programm und werden vom FreeCAD-Core-Team nicht unterstützt. Sie sollten die Informationen auf jeder der Add-On-Seiten lesen, bevor Sie sie installieren, um sicherzustellen, dass Sie wissen, was Sie installieren.
* These add-ons are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the information provided on each add-on's home page to make sure you know what you are installing.


* Bug reports and feature requests should be made directly to the creator of the add-on by visiting the indicated website. Many add-on authors are regular users of the [https://forum.freecadweb.org FreeCAD forum], and can be contacted there.
* Fehlerberichte und Feature-Anfragen sollten direkt auf jeder Add-On-Seite oder an den Ersteller des Add-ons im [https://forum.freecadweb.org FreeCAD Forum] erfolgen.


<div class="mw-translate-fuzzy">
* The web addresses of the repositories for add-ons and macros are hard coded into the AddonManager. As this application is written in Python, experienced users can change these locations by editing the appropriate fields in
* Die Web-Adressen der Repositories für Addons und Makros sind im AddonManager hartkodiert. Weil diese Applikation in Python geschrieben ist, können erfahrende Benutzer diese Stellen ändern durch Anpassen der entsprechenden Felder in
{{Code|code=
{{Code|code=
$ROOT/Mod/AddonManager/AddonManager.py
$ROOT/Mod/AddonManager/AddonManager.py
}}
}}
</div>


{{Code|code=
where {{incode|$ROOT}} is the installation directory of FreeCAD in your particular system, for example,
$ROOT/Mod/AddonManager/AddonManager.py
}}

wobei {{incode|$ROOT}} das FreeCAD-Installationsverzeichnis auf Ihrem jeweiligen System ist, bspw.
* Linux: {{incode|/usr/lib/freecad/Mod/AddonManager/AddonManager.py}}
* Linux: {{incode|/usr/lib/freecad/Mod/AddonManager/AddonManager.py}}
* Windows: {{Incode|C:\Program Files\FreeCAD version\Mod\AddonManager.py}}
* Windows: {{Incode|C:\Program Files\FreeCAD version\Mod\AddonManager.py}}


== New workbenches and macros ==
== Neue Arbeitsbereiche und Makros ==


<div class="mw-translate-fuzzy">
If you developed a workbench or macro, and want to see it included in the Addon Manager, read how to do that 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]], there is nothing else to do, it will automatically be picked by the Addon Manager.
Wenn Sie einen Arbeitsbereich oder ein Makro entwickelt haben und es im Addon-Manager sehen möchten, lesen Sie auf den Repository-Seiten ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] und [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]), was zu tun ist. Wenn Sie Ihr Makro zu den [[Macros recipes/de|Maco-Rezepten]] hinzufügen, ist nichts weiteres tun, denn es wird automatisch vom Addon-Manager ausgewählt.
</div>


For python workbenches, you don't need any specific approval to have your workbench added to the Addon Manager and, being outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the 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.
Bei Python-Arbeitsbereichen benötigen Sie keine bestimmte Genehmigung, damit Ihr Arbeitsbereich zum Addon-Manager hinzugefügt wird, und da Sie sich außerhalb des FreeCAD-Quellcodes befinden, können Sie die Lizenz wählen, die Sie möchten. Wenn Sie darum bitten, dass Ihr Arbeitsbereich zur Liste hinzugefügt wird (wir werden keine neuen Arbeitsbereiche ohne die Bitte der Autoren hinzufügen), entweder durch Anfrage im Forum oder durch Eröffnen eines Themas im [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]-Repository, bleibt Ihr Code in Ihrem eigenen git-Repository, und wir werden ihn einfach als Submodul zum [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]-Repository hinzufügen. Vor dem Hinzufügen des Arbeitsbereichs werden wir natürlich einen Blick darauf werfen, um sicherzustellen, dass er nichts potenziell Gefährliches enthält.


Wenn Sie einen Arbeitsbereich in C++ entwickeln, kann er nicht direkt durch Benutzer ausgeführt, sondern muss zuerst kompiliert werden. Sie haben zwei Optionen, entweder stellen Sie vorkompilierte Versionen Ihres Arbeitsbereichs für die verschiedenen Betriebssysteme zur Verfügung oder Sie sollten darum bitten, dass Ihr Code in den FreeCAD-Quellcode integriert wird. Dafür sollten Sie die LGPL-Lizenz (oder vollkompatible wie MIT oder BSD) verwenden, und Sie müssen Ihre Werkzeuge der Community im [https://forum.freecadweb.org FreeCAD Forum] für ein Review vorstellen. Sobald Ihr Code getestet und freigegeben ist, sollten Sie das FreeCAD-Repository forken (sofern noch nicht geschehen), einen neuen Branch anlegen, den Code dorthin pushen, und einen Pull-Request öffnen, damit Ihr Branch zum Main-Repository hinzugefügt wird.
If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have 2 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 fully compatible 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.


== Testing the Addon Manager ==
{{Userdocnavi}}
{{VeryImportantMessage|This section is for developers}}
The Addon Manager is coded in Python so it's possible to change the source code without compiling it. More specifically, testing requires modifying the code in <tt>FreeCAD/src/Mod/AddonManager</tt> and simply re-running FreeCAD.


To test downloading capability of the Addon Manager you can simulate a need to download say, a previous version of a workbench via the CLI. In the following example we'll use the Assembly2+ workbench (or [[A2plus_Workbench|A2plus]] for short):
[[Category:Addons]]

{{Code|code=
cd ~/FreeCAD/Mod/A2plus/
git reset --hard "v0.4.21"
}}

CLI output should show '''HEAD is now at b2c53a4 Merge pull request #281 from kbwbe/devel'''

<div class="mw-translate-fuzzy">
{{Userdocnavi/de}}
</div>

{{Userdocnavi}}


[[Category:Addons/de]]


{{clear}}
{{clear}}

Revision as of 11:50, 8 September 2019

Addon manager

Menüeintrag
Werkzeuge → Addon manager
Arbeitsbereich
Alle
Standardtastenkürzel
Keiner
Eingeführt in Version
0.17
Siehe auch
Makros,Externe Arbeitsbereiche

Der Addon-Manager ist ein Werkzeug zum installieren und verwalten von externen Arbeitsbereichen und Makros, die von der FreeCAD-Community bereitgestellt werden. Falls das git-python-Paket auf Deinem Computer installiert ist, wird es der Addon-Manager benutzen, um installierte Arbeitsbereiche zu aktualisieren und Downloads zu beschleunigen.

Eine vollständige Liste der Arbeitsbereiche und Makros finden Sie in zwei Repositories, FreeCAD-addons und FreeCAD-macros, sowie den Macro Rezepten.

Schnittstelle des Addon-Managers

Anwendung

  • Öffnen Sie das Werkzeug im Menü Werkzeuge → Extras → Addon-Manager.
  • Um eine Workbench zu installieren: Scrollen Sie durch die Liste und wählen Sie das Add-On. Die Beschreibung des Add-Ons wird unter der Liste sowie der Link zur Add-On-Seite angezeigt. Drücken Sie dann die Schaltfläche Install/update, um das neue Werkzeug zu installieren. Bei Makros drücken Sie Makros und wiederholen Sie die Schritte.
  • So entfernen Sie eine Workbench oder ein Makro: Blättern Sie durch die Liste, wählen Sie das Add-on aus und drücken Sie die Schaltfläche Remove.
  • Um eine Workbench oder ein Makro zu aktualisieren: Blättern Sie durch die Liste, wählen Sie das Add-on und drücken Sie die Schaltfläche Install/update.
  • Nach Updates suchen: Drücken Sie die Schaltfläche ; verfügbare Updates werden unterhalb der Liste angezeigt. Durch erneutes Drücken der Update-Taste werden alle Updates gleichzeitig aktualisiert. Note: Das Symbol kann je nach Betriebssystem anders aussehen.
  • Um ein Makro auszuführen: Installieren Sie zuerst das gewünschte Makro, wählen Sie es erneut in der Liste und drücken Sie die Schaltfläche Execute. Das Makro wird automatisch im FreeCAD-Makro-Editor dargestellt, um den Code zu zeigen.
  • Drücken Sie Close, um den Manager zu beenden.

Manuelle Installation

Wenn Sie den Addon-Manager nicht verwenden, können Sie die neuen Werkzeuge manuell installieren, indem Sie deren Code in Ihrem FreeCAD/-Benutzerverzeichnis ablegen. Details finden Sie unter:

Einschränkungen

  • Diese Add-Ons gehören nicht zum offiziellen FreeCAD-Programm und werden vom FreeCAD-Core-Team nicht unterstützt. Sie sollten die Informationen auf jeder der Add-On-Seiten lesen, bevor Sie sie installieren, um sicherzustellen, dass Sie wissen, was Sie installieren.
  • Fehlerberichte und Feature-Anfragen sollten direkt auf jeder Add-On-Seite oder an den Ersteller des Add-ons im FreeCAD Forum erfolgen.
  • Die Web-Adressen der Repositories für Addons und Makros sind im AddonManager hartkodiert. Weil diese Applikation in Python geschrieben ist, können erfahrende Benutzer diese Stellen ändern durch Anpassen der entsprechenden Felder in
$ROOT/Mod/AddonManager/AddonManager.py
$ROOT/Mod/AddonManager/AddonManager.py

wobei $ROOT das FreeCAD-Installationsverzeichnis auf Ihrem jeweiligen System ist, bspw.

  • Linux: /usr/lib/freecad/Mod/AddonManager/AddonManager.py
  • Windows: C:\Program Files\FreeCAD version\Mod\AddonManager.py

Neue Arbeitsbereiche und Makros

Wenn Sie einen Arbeitsbereich oder ein Makro entwickelt haben und es im Addon-Manager sehen möchten, lesen Sie auf den Repository-Seiten (FreeCAD-addons und FreeCAD-macros), was zu tun ist. Wenn Sie Ihr Makro zu den Maco-Rezepten hinzufügen, ist nichts weiteres tun, denn es wird automatisch vom Addon-Manager ausgewählt.

Bei Python-Arbeitsbereichen benötigen Sie keine bestimmte Genehmigung, damit Ihr Arbeitsbereich zum Addon-Manager hinzugefügt wird, und da Sie sich außerhalb des FreeCAD-Quellcodes befinden, können Sie die Lizenz wählen, die Sie möchten. Wenn Sie darum bitten, dass Ihr Arbeitsbereich zur Liste hinzugefügt wird (wir werden keine neuen Arbeitsbereiche ohne die Bitte der Autoren hinzufügen), entweder durch Anfrage im Forum oder durch Eröffnen eines Themas im FreeCAD-addons-Repository, bleibt Ihr Code in Ihrem eigenen git-Repository, und wir werden ihn einfach als Submodul zum FreeCAD-addons-Repository hinzufügen. Vor dem Hinzufügen des Arbeitsbereichs werden wir natürlich einen Blick darauf werfen, um sicherzustellen, dass er nichts potenziell Gefährliches enthält.

Wenn Sie einen Arbeitsbereich in C++ entwickeln, kann er nicht direkt durch Benutzer ausgeführt, sondern muss zuerst kompiliert werden. Sie haben zwei Optionen, entweder stellen Sie vorkompilierte Versionen Ihres Arbeitsbereichs für die verschiedenen Betriebssysteme zur Verfügung oder Sie sollten darum bitten, dass Ihr Code in den FreeCAD-Quellcode integriert wird. Dafür sollten Sie die LGPL-Lizenz (oder vollkompatible wie MIT oder BSD) verwenden, und Sie müssen Ihre Werkzeuge der Community im FreeCAD Forum für ein Review vorstellen. Sobald Ihr Code getestet und freigegeben ist, sollten Sie das FreeCAD-Repository forken (sofern noch nicht geschehen), einen neuen Branch anlegen, den Code dorthin pushen, und einen Pull-Request öffnen, damit Ihr Branch zum Main-Repository hinzugefügt wird.

Testing the Addon Manager

This section is for developers

The Addon Manager is coded in Python so it's possible to change the source code without compiling it. More specifically, testing requires modifying the code in FreeCAD/src/Mod/AddonManager and simply re-running FreeCAD.

To test downloading capability of the Addon Manager you can simulate a need to download say, a previous version of a workbench via the CLI. In the following example we'll use the Assembly2+ workbench (or A2plus for short):

cd ~/FreeCAD/Mod/A2plus/
git reset --hard "v0.4.21"

CLI output should show HEAD is now at b2c53a4 Merge pull request #281 from kbwbe/devel