Std AddonMgr: Difference between revisions

From FreeCAD Documentation
m (image size)
(Update to cover the 0.20 Addon Manager)
Line 24: Line 24:


<!--T:2-->
<!--T:2-->
The '''Std AddonMgr''' command opens the Addon manager. With the Addon manager you can install and manage [[external_workbenches|external workbenches]] and [[macros|macros]] provided by the FreeCAD community. The available workbenches and macros are taken from two repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], and from the [[Macros_recipes|Macros recipes]] page.
The '''Std AddonMgr''' command opens the Addon manager. With the Addon manager you can install and manage [[external_workbenches|external workbenches]], [[macros|macros]], and [[Preference_Packs|preference packs]] provided by the FreeCAD community. By default the available addons are taken from two repositories, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and from the [[Macros_recipes|Macros recipes]] page. If GitPython and git are installed on the system, additional macros will be loaded from [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]. Custom repositories can be added in the Addon Manager's preference page.


<!--T:42-->
<!--T:42-->
Due to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] or a recent [https://github.com/FreeCAD/FreeCAD/releases/tag/0.19_pre 0.19] version. Alternatively you can install addons manually, see [[#Notes|Notes]] below.
Due to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] or later. Alternatively you can install addons manually, see [[#Notes|Notes]] below.


</translate>
</translate>
Line 39: Line 39:
<!--T:6-->
<!--T:6-->
# Select the {{MenuCommand|Tools → [[Image:Std_AddonMgr.svg|16px]] Addon manager}} option from the menu.
# Select the {{MenuCommand|Tools → [[Image:Std_AddonMgr.svg|16px]] Addon manager}} option from the menu.
# If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. Press the {{Button|OK}} button to confirm and continue.
# If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. It also presents several options related to the Addon manager's data usage. Adjust those options to your liking and press the {{Button|OK}} button to confirm and continue.
# The Addon manager dialog box opens. For more information see [[#Options|Options]].
# The Addon manager dialog box opens. For more information see [[#Options|Options]].
# The {{Button|[[Image:Button_valid.svg|16px]] Update all}} button does not work at this time.
# Press the {{Button|[[Image:Process-stop.svg|16px]] Close}} button to close the dialog box.
# If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.
# If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.


==Options== <!--T:27-->
==Options== <!--T:27-->


[[File:AddonManager relnotes 0.20.png]]
<!--T:28-->
The Addon manager dialog box has two tabs on the left, one listing the available workbenches and the other listing the available macros. The information panel on the right will display the homepage of the selected addon.


# The Addon manager provides two view layouts: "Condensed" and "Expanded". In "Condensed" view, each addon takes a single line, and its description is truncated to fit the available space. "Expanded" shows additional details, including more of the description text as well as maintainer information, more installation details, etc.
===Uninstall=== <!--T:29-->
# Three different types of addons are supported: [[external_workbenches|workbenches]], [[macros|macros]], and [[Preference_Packs|preference packs]]. You can choose to show just one type, or all of them in a single list.
# The list can be limited to show just installed packages, just packages with available updates, or just packages that are not yet installed.
# The list can be filtered, searching for a keyword in the title, description, and tags (description and tags must be specified by the addon developer in their addon's metadata). The filter can even be a regular expression, for fine-grained control of the exact search term.
# The expanded view shows available version information, description, maintainer information, and installation version information, for packages that provide a [[Package_Metadata|package metadata]] file (or for macros with embedded metadata).
# Addon data is cached locally, with a variable cache update frequency set in the user preferences. At any time you can choose to manually update your local cache to see the latest updates available for each addon.
# Update checks may be set up to be automatic, or done manually via a button click (configured in user preferences). If GitPython and git are installed on your system then update information is fetched using git. If not, then update information is obtained from any present metadata file.


Clicking on an Addon in this view brings up the Addon's Details page:
<!--T:30-->
# Select an installed addon on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
# Press the {{Button|[[Image:Delete.svg|16px]] Uninstall selected}} button.


[[File:AddonDetails 0.20.png]]
===Install/update=== <!--T:31-->


The details page shows the buttons allowing installing, uninstalling, updating, and temporarily disabling an Addon. For installed Addons it lists the currently installed version and the installation date, and whether that is the most recent version available. Below is an embedded web browser window showing the Addon's README page (for workbenches and preference packs), or Wiki page (for macros).
<!--T:32-->
# Select an addon on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
# Press the {{Button|[[Image:Edit_OK.svg|16px]] Install/update selected}} button.
# If you want to add a macro to a custom toolbar then don't forget to manually download the icon image file, if available, by clicking on the link on the homepage in the information panel. See [[Interface_Customization#Toolbars|Interface Customization]].
# To change the position of an addon workbench in the [[Std_Workbench|Workbench selector]] list see [[Interface_Customization#Workbenches|Interface Customization]].


==Preferences==
===Configuration=== <!--T:33-->


Preferences for the FreeCAD 0.20 Addon Manager can be found in its [[Addon Manager Preferences|preference page]].
<!--T:34-->
# Press the {{Button|[[Image:Preferences-general.svg|16px]] Configure...}} button.
# The Addon manager options dialog box opens.
# Optionally check the {{CheckBox|TRUE|Automatically check for updates at start (requires GitPython)}} checkbox.
# Optionally add repositories to the '''Custom repositories''' list. Addons from these repositories will be added on the [[Image:Folder.svg|16px]] '''Workbenches''' tab or the [[Image:Applications-python.svg|16px]] '''Macros''' tab.
# Optionally choose proxy settings.
# Press the {{Button|OK}} button or the {{Button|Cancel}} button to close the dialog box.


==Notes== <!--T:35-->
==Notes== <!--T:35-->
Line 86: Line 77:


See [[Addon#Information_for_developers|Addon]].
See [[Addon#Information_for_developers|Addon]].

==Changes coming in FreeCAD 0.20==

The Addon Manager saw a major revision in 0.20, most notably adding support for modern SSL standards, but also undergoing a visual refresh and some added user-interface features. The preferences for Addon Manager can be found in the [[Preferences_Editor#Addon_manager_options|Preferences Editor]].

<table>
<tr>
<td>[[File:AddonManager_relnotes_0.20.png|500px]]</td>
<td>
<ol>
<li> "Condensed" and "Expanded" views available. "Expanded" view is shown here.</li>
<li> Three different types of addons are now supported: Workbenches, Macros, and Preference Packs. You can choose to show just one type, or all of them in a single list.</li>
<li> The list can be limited to show just installed packages, just packages with available updates, or just packages that are not yet installed.</li>
<li> The list can be filtered, searching for a keyword in the title, description, and tags (description and tags must be specified by the addon developer in their addon's metadata). The filter can even be a regular expression, for fine-grained control of the exact search term.</li>
<li> The expanded view shows available version information, description, maintainer information, and installation version information, for packages that provide a [[Package_Metadata]] file (or for macros with embedded metadata).</li>
<li> Metadata and icons are cached locally, with a variable cache update frequency set in the user preferences.</li>
<li> Update checks may be set up to be automatic, or done manually via a button click. Configured in user preferences.</li>
</ol>
</td>
</tr>
</table>


<!--T:40-->
<!--T:40-->

Revision as of 18:43, 17 June 2022

Std AddonMgr

Menu location
Tools → Addon manager
Workbenches
All
Default shortcut
None
Introduced in version
0.17
See also
External workbenches, Macros

Description

The Std AddonMgr command opens the Addon manager. With the Addon manager you can install and manage external workbenches, macros, and preference packs provided by the FreeCAD community. By default the available addons are taken from two repositories, FreeCAD-addons and from the Macros recipes page. If GitPython and git are installed on the system, additional macros will be loaded from FreeCAD-macros. Custom repositories can be added in the Addon Manager's preference page.

Due to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version 0.18.5 or later. Alternatively you can install addons manually, see Notes below.

File:Std AddonMgr dialog.png

The v0.20 Addon manager dialog box

Usage

  1. Select the Tools → Addon manager option from the menu.
  2. If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. It also presents several options related to the Addon manager's data usage. Adjust those options to your liking and press the OK button to confirm and continue.
  3. The Addon manager dialog box opens. For more information see Options.
  4. If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.

Options

File:AddonManager relnotes 0.20.png

  1. The Addon manager provides two view layouts: "Condensed" and "Expanded". In "Condensed" view, each addon takes a single line, and its description is truncated to fit the available space. "Expanded" shows additional details, including more of the description text as well as maintainer information, more installation details, etc.
  2. Three different types of addons are supported: workbenches, macros, and preference packs. You can choose to show just one type, or all of them in a single list.
  3. The list can be limited to show just installed packages, just packages with available updates, or just packages that are not yet installed.
  4. The list can be filtered, searching for a keyword in the title, description, and tags (description and tags must be specified by the addon developer in their addon's metadata). The filter can even be a regular expression, for fine-grained control of the exact search term.
  5. The expanded view shows available version information, description, maintainer information, and installation version information, for packages that provide a package metadata file (or for macros with embedded metadata).
  6. Addon data is cached locally, with a variable cache update frequency set in the user preferences. At any time you can choose to manually update your local cache to see the latest updates available for each addon.
  7. Update checks may be set up to be automatic, or done manually via a button click (configured in user preferences). If GitPython and git are installed on your system then update information is fetched using git. If not, then update information is obtained from any present metadata file.

Clicking on an Addon in this view brings up the Addon's Details page:

File:AddonDetails 0.20.png

The details page shows the buttons allowing installing, uninstalling, updating, and temporarily disabling an Addon. For installed Addons it lists the currently installed version and the installation date, and whether that is the most recent version available. Below is an embedded web browser window showing the Addon's README page (for workbenches and preference packs), or Wiki page (for macros).

Preferences

Preferences for the FreeCAD 0.20 Addon Manager can be found in its preference page.

Notes

  • The use of addons is not restricted to the FreeCAD version they were installed from. You will also be able to use them in any other FreeCAD version, supported by the addon, that you may have on your system.
  • The addons available in the Addon manager are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the provided information carefully to make sure you know what you are installing.
  • Bug reports and feature requests should be made directly to the creator of the addon by visiting the indicated website. Many addon developers are regular users of the FreeCAD forum, and can also be contacted there.
  • If the GitPython package is installed on your computer the Addon manager will make use of it, making downloads faster.
  • You can also install addons manually. See How to install additional workbenches and How to install macros.

Information for developers

See Addon.