Difference between revisions of "Documentation/Nightly/SlicerApplication/ExtensionsManager"

From Slicer Wiki
Jump to: navigation, search
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
__TOC__
 
__TOC__
  
3D Slicer now supports plug-ins which we call extensions.  Extensions are available from an extension server.  This allows end-users to select the extensions useful to them, without having to download the entire extension archive.
+
3D Slicer now supports plug-ins which we call ''extensions''.  Extensions are available for download from an extension server.  Extensions allow end-users to selectively install features that are useful for them.
  
 
= Extensions Manager =
 
= Extensions Manager =
  
 
[[File:Extension_Manager.png|700px]]
 
[[File:Extension_Manager.png|700px]]
 
== Prerequisites ==
 
ExtensionsManager must be enabled in the Application Settings (menu item "Edit -> Application Settings -> Extensions"). If you changed the setting, Slicer has to be restarted for it to become effective.
 
[[Image:ExtensionsManager-enable.png|Enable ExtensionsManager]]
 
  
 
== Installing an extension ==
 
== Installing an extension ==
Line 23: Line 19:
 
File:ExtensionsManager-4.1-Install_3_ExtensionAvailable.jpg|7. Extension is available
 
File:ExtensionsManager-4.1-Install_3_ExtensionAvailable.jpg|7. Extension is available
 
</gallery>
 
</gallery>
 +
 +
Note: if extension manager is not visible then make sure that ''Enable extension manager'' option is enabled in Application Settings (menu item "Edit -> Application Settings -> Extensions"). If you changed the setting, Slicer has to be restarted for it to become effective.
 +
 +
[[Image:ExtensionsManager-enable.png|Enable ExtensionsManager]]
  
 
== Installing an extension without network connection ==
 
== Installing an extension without network connection ==
  
 
<gallery widths=230px heights=230px perrow=4>
 
<gallery widths=230px heights=230px perrow=4>
File:ExtensionsManager-4.4-InstallFromFile_1_DownloadExtensionPackage.png|1. Download the extension package (or obtain it in some other way)
+
File:ExtensionsManager-4.4-InstallFromFile_1_DownloadExtensionPackage.png|1. Download the extension package using [[#How_to_manually_download_an_extension_package.3F|these instructions]] on a network-connected computer.
 
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|2. Open extensions manager
 
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|2. Open extensions manager
 
File:ExtensionsManager-4.4-InstallFromFile 3 ToolMenuInstallFromFile.png|3. Select 'Install from File' from the tools menu
 
File:ExtensionsManager-4.4-InstallFromFile 3 ToolMenuInstallFromFile.png|3. Select 'Install from File' from the tools menu
Line 33: Line 33:
 
File:ExtensionsManager-4.4-InstallFromFile_5_ExtensionIsInsalled.png|5. Extension is installed
 
File:ExtensionsManager-4.4-InstallFromFile_5_ExtensionIsInsalled.png|5. Extension is installed
 
File:ExtensionsManager-4.4-InstallFromFile_6_Restart.png|6. Restart Slicer
 
File:ExtensionsManager-4.4-InstallFromFile_6_Restart.png|6. Restart Slicer
File:ExtensionsManager-4.1-Install_3_ExtensionAvailable.jpg|7. Extension is available
+
File:ExtensionsManager-4.4-InstallFromFile_7_ExtensionIsAvailable.png|7. Extension is available
 +
</gallery>
 +
 
 +
== Updating installed extensions ==
 +
 
 +
<gallery widths=230px heights=230px perrow=4>
 +
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|1. Open extensions manager and select ''Manage Extensions'' tab
 +
File:ExtensionsManager-CheckForUpdate.png|2. Select ''Check for Updates'' from the tools menu
 +
File:ExtensionsManager-CheckForUpdate-Log-Success.png|3. Check log
 
</gallery>
 
</gallery>
 +
 +
By selecting ''Install Updates Automatically'' from the tools menu, Slicer will check if extension updates are available on start-up.
  
 
== Uninstalling an extension ==
 
== Uninstalling an extension ==
Line 49: Line 59:
  
 
<gallery widths=230px heights=230px perrow=4>
 
<gallery widths=230px heights=230px perrow=4>
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|1. Open extensions manager
+
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|1. Open extensions manager and select ''Manage Extensions'' tab
 
File:ExtensionsManager-4.1-Disable_1.png|2. Disable extension
 
File:ExtensionsManager-4.1-Disable_1.png|2. Disable extension
 
File:ExtensionsManager-4.1-Disable_2.png|3. Restart Slicer
 
File:ExtensionsManager-4.1-Disable_2.png|3. Restart Slicer
Line 55: Line 65:
  
 
== Incompatible extensions ==
 
== Incompatible extensions ==
 
+
<!--
 
'''Caveat''': Considering that installed extensions are common to all Slicer version installed by a given user and that an extension is specific to a given revision of Slicer, it's currently not possible to have working extension installed for multiple version of Slicer. The issues has been reported as #[http://www.na-mic.org/Bug/view.php?id=1958 1958] and is currently targeted for 4.2.0 release.
 
'''Caveat''': Considering that installed extensions are common to all Slicer version installed by a given user and that an extension is specific to a given revision of Slicer, it's currently not possible to have working extension installed for multiple version of Slicer. The issues has been reported as #[http://www.na-mic.org/Bug/view.php?id=1958 1958] and is currently targeted for 4.2.0 release.
 
+
-->
 
<gallery widths=230px heights=120px perrow=4>
 
<gallery widths=230px heights=120px perrow=4>
 
File:ExtensionsManager-4.1-IncompatibleExtension.jpg| Incompatible extension has been identified
 
File:ExtensionsManager-4.1-IncompatibleExtension.jpg| Incompatible extension has been identified

Revision as of 19:45, 29 November 2017

Home < Documentation < Nightly < SlicerApplication < ExtensionsManager


For the latest Slicer documentation, visit the read-the-docs.


3D Slicer now supports plug-ins which we call extensions. Extensions are available for download from an extension server. Extensions allow end-users to selectively install features that are useful for them.

Extensions Manager

Extension Manager.png

Installing an extension

Note: if extension manager is not visible then make sure that Enable extension manager option is enabled in Application Settings (menu item "Edit -> Application Settings -> Extensions"). If you changed the setting, Slicer has to be restarted for it to become effective.

Enable ExtensionsManager

Installing an extension without network connection

Updating installed extensions

By selecting Install Updates Automatically from the tools menu, Slicer will check if extension updates are available on start-up.

Uninstalling an extension

Disabling an extension

Incompatible extensions

Extensions Manager Settings

Extensions settings

  1. Extensions server URL: Address of the server used to download and install extensions
  2. Extensions installation path: Directory where extension packages should be extracted and installed

Module settings

  1. After installing an extension, the directories containing the modules bundled within an extension will be visible as additional module paths.
  2. Modules associated with an extension can also be disabled one by one.

Launcher settings

Whereas the module path is used to indicate Slicer where to look to load additional modules, the extension manager also takes care of updating the LibraryPaths / Paths / EnvironmentVariables in the launcher settings so that libraries associated with modules can be successfully loaded.



This page has been moved to read-the-docs.