UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:42:42Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

UpdateBot: Nightly -> 4.2

2012-10-31T22:00:57Z

Nightly -> 4.2

New page

{{:Documentation/{{documentation/version}}/Extensions/Description}}

__TOC__

=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 =
<gallery widths=230px heights=230px perrow=4>
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|1. Open extensions manager
File:ExtensionsManager-4.1-Install_1a_extension_list.png|2. Choose an extension
File:ExtensionsManager-4.1-Install_1_extension_details.png|3. Look at extension details
File:ExtensionsManager-4.1-Install_2a_InstallButton.png.jpg|4. Click on "Install"
File:ExtensionsManager-4.1-Install_2b_ExtensionInstalled_ManagerAndInstallWidget.jpg|5. Extension is installed
File:ExtensionsManager-4.1-Install_Restart.jpg|6. Restart Slicer
File:ExtensionsManager-4.1-Install_3_ExtensionAvailable.jpg|7. Extension is available
</gallery>

= Uninstalling an extension =

<gallery widths=230px heights=230px perrow=4>
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|1. Open extensions manager
File:ExtensionsManager-4.1-Uninstall_1b_UninstallButton.jpg|2. Click on "Uninstall"
File:ExtensionsManager-4.1-Uninstall_2_ScheduledForUninstall.jpg|3. Extension is scheduled for uninstall
File:ExtensionsManager-4.1-Uninstall_3_Restart.jpg|4. Restart Slicer
File:ExtensionsManager-4.1-Uninstall_4_ExtensionUninstalled.png| 5. Extension has been uninstalled
</gallery>

= Disabling an extension =

<gallery widths=230px heights=230px perrow=4>
File:ExtensionsManager-4.1-Install_0_ExtensionsManagerMenu.jpg|1. Open extensions manager
File:ExtensionsManager-4.1-Disable_1.png|2. Disable extension
File:ExtensionsManager-4.1-Disable_2.png|3. Restart Slicer
</gallery>

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

<gallery widths=230px heights=120px perrow=4>
File:ExtensionsManager-4.1-IncompatibleExtension.jpg| Incompatible extension has been identified
File:ExtensionsManager-4.1-IncompatibleExtension_ErrorLogMessage.png | Error log message
</gallery>

= Extensions Manager Settings =

{|
| <gallery widths=400px heights=230px perrow=1>
File:ExtensionsManager-4.1-UnderTheHood_1_ExtensionsSettings.png|Extensions settings
</gallery>
||
# Extensions server URL: Address of the server used to download and install extensions
# Extensions installation path: Directory where extension packages should be extracted and installed
|}

{|
| <gallery widths=400px heights=230px perrow=1>
File:ExtensionsManager-4.1-UnderTheHood_2_ModulesSettings.png|Module settings
</gallery>
||
# After installing an extension, the directories containing the modules bundled within an extension will be visible as additional module paths.
# Modules associated with an extension can also be disabled one by one.
|}

{|
| <gallery widths=400px heights=230px perrow=1>
File:ExtensionsManager-4.1-UnderTheHood_3_LauncherSettings.png|Launcher settings
</gallery>
||
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 <code>LibraryPaths</code> / <code>Paths</code> / <code>EnvironmentVariables</code> in the launcher settings so that libraries associated with modules can be successfully loaded.
|}

← Older revision		Revision as of 07:42, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	{{:Documentation/{{documentation/version}}/Extensions/Description}}		{{:Documentation/{{documentation/version}}/Extensions/Description}}

Documentation/4.2/SlicerApplication/ExtensionsManager - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

UpdateBot: Nightly -> 4.2