Grundlett: Text replacement - "\[http:\/\/www\.slicer\.org\/slicerWiki\/images\/([^ ]+) ([^]]+)]" to "[http://www.slicer.org/w/img_auth.php/$1 $2]"

2019-11-27T12:39:46Z

Text replacement - "\[http:\/\/www\.slicer\.org\/slicerWiki\/images\/([^ ]+) ([^]]+)]" to "[http://www.slicer.org/w/img_auth.php/$1 $2]"

Grundlett: Text replacement - "slicerWiki/index.php" to "wiki"

2019-11-21T17:04:02Z

Text replacement - "slicerWiki/index.php" to "wiki"

UpdateBot: Nightly -> 4.10

2018-10-19T00:43:44Z

Nightly -> 4.10

New page

<noinclude>{{documentation/versioncheck}}</noinclude>
= Overview =

Extensions are packaged against a specific version of Slicer, to be distributed and available for a revision X of Slicer, extensions have to be build against that same revision of Slicer. Otherwise, an extension will be considered as [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager#Incompatible_extensions|incompatible]].

<ol style="list-style-type:none; border-left:thick solid darkgreen; padding-left:1em;">
<li>If you are not familiar with the extension creation and contribution process, consider reading [[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions|Step-by-step: How to create, publish and distribute an extension]].</li>
</ol>

= CMake variables =

To create an extension, the following CMake variables should be defined:

{|class="wikitable alternance" style="text-align:left; width:70%; border:1px solid black;"
|-
! scope=col style="background:#cde6f8;"| CMake variable
! scope=col style="background:#cde6f8;"| Description
! scope=col style="background:#cde6f8;"| Mandatory
|-
| <code>EXTENSION_NAME</code>
| Name of the extension
| {{Done}}
|-
| <code>EXTENSION_HOMEPAGE</code>
| Url of the web page describing the extension
| {{Done}}
|-
| <code>EXTENSION_CATEGORY</code>
| Extension category
| {{Done}}
|-
| <code>EXTENSION_CONTRIBUTORS</code>
| Extension contributor specified as <code>Firstname1 Lastname1 ([SubOrg1, ]Org1), Firstname2 Lastname2 ([SubOrg2, ]Org2)</code>
|
|-
| <code>EXTENSION_DESCRIPTION</code>
| One line describing what is the purpose of the extension
|
|-
| <code>EXTENSION_ICONURL</code>
| Url to an icon (png, size 128x128 pixels)
|
|-
| <code>EXTENSION_SCREENSHOTURLS</code>
| Space separated list of urls to images
|
|-
| <code>EXTENSION_DEPENDS</code>
| List of extensions required to build this extension. Specify "NA" if there are no dependency.
|
|}

List of partially supported CMake variables:

{|class="wikitable alternance" style="text-align:left; width:70%; border:1px solid black;"
|-
! scope=col style="background:#cde6f8;"| CMake variable
! scope=col style="background:#cde6f8;"| Description
|-
| <code>EXTENSION_STATUS</code>
| Give people an idea what to expect from this code
|}

= Project layout =

The code should be organized as illustrated below:

<pre>

MyExtension <- - - - - - - - - - - - - - - - - - - - - - Top-level folder of the extension project
|
|-- CMakeLists.txt
|
|-- MyExtension.png
|
|-- MyCLIModule
| |
| |-- CMakeLists.txt
| |
| |-- MyCLIModule.cxx
| |
| |-- MyCLIModule.xml
. .
. .
|
|-- MyLoadableModule
|
|-- CMakeLists.txt
|
|-- qSlicerMyLoadableModuleModule.cxx
|
|-- qSlicerMyLoadableModuleModule.h
.
.
</pre>

= Top-level CMakeLists.txt =

The top-level <code>CMakeLists.txt</code> could be organized as reported below:

<pre>
cmake_minimum_required(VERSION 2.8.9)

#-----------------------------------------------------------------------------
# Extension meta-information <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
set(EXTENSION_NAME MyExtension) <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
set(EXTENSION_HOMEPAGE "http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Extensions/${EXTENSION_NAME}") <- - - - EXTENSION SPECIFIC
set(EXTENSION_CATEGORY "Examples") <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
set(EXTENSION_CONTRIBUTORS "Jean-Christophe Fillion-Robin (Kitware)") <- - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
set(EXTENSION_DESCRIPTION "This is an example of extension bundling a CLI, a loadable and a scripted module") <- - - - - - - EXTENSION SPECIFIC
set(EXTENSION_ICONURL "http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Extensions/Testing/LoadableExtensionTemplate/Resources/Icons/LoadableExtensionTemplate.png?revision=19437&view=co")

#-----------------------------------------------------------------------------
find_package(Slicer REQUIRED)
include(${Slicer_USE_FILE})

#-----------------------------------------------------------------------------
add_subdirectory(MyCLIModule)
add_subdirectory(MyLoadableModule)
[...]

#-----------------------------------------------------------------------------
include(${Slicer_EXTENSION_CPACK}) <- - - - - EXTENSION SPECIFIC

</pre>

= Possible tweak of Module level CMakeLists.txt =

During the development process, it could be useful to be able to build each module against a given slicer build tree without having to build the complete extensions, to do so the <code>CMakeLists.txt</code> of each module could include <code>find_package(Slicer REQUIRED)</code>.

For example, the <code>CMakeLists.txt</code> of <code>MyCLIModule</code> module that would be bundled into <code>MyExtension</code> could include the following code:

<pre>
cmake_minimum_required(VERSION 2.8.9)

#-----------------------------------------------------------------------------
set(MODULE_NAME MyCLIModule) # Do not use 'project()'

#-----------------------------------------------------------------------------
find_package(Slicer REQUIRED)
include(${Slicer_USE_FILE})

[...]
</pre>



= Additional documentation =

* [[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions|Step-by-step: How to create, publish and distribute an extension]]
* [http://www.slicer.org/slicerWiki/images/a/a1/AHM-2011-SlicerExtensions-final.ppt AHM 2011 SlicerExtensions presentation]
* Read [[Documentation/{{documentation/version}}/FAQ|FAQ]]

@@ Line 232: / Line 232: @@
 * [[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions|Step-by-step: How to create, publish and distribute an extension]]
-* [http://www.slicer.org/slicerWiki/images/a/a1/AHM-2011-SlicerExtensions-final.ppt AHM 2011 SlicerExtensions presentation]
+* [http://www.slicer.org/w/img_auth.php/a/a1/AHM-2011-SlicerExtensions-final.ppt AHM 2011 SlicerExtensions presentation]
 * Read [[Documentation/{{documentation/version}}/FAQ|FAQ]]

@@ Line 106: / Line 106: @@
 # Extension meta-information <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
 set(EXTENSION_NAME MyExtension)  <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
-set(EXTENSION_HOMEPAGE "http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Extensions/${EXTENSION_NAME}")  <- - - - EXTENSION SPECIFIC
+set(EXTENSION_HOMEPAGE "http://www.slicer.org/wiki/Documentation/4.1/Extensions/${EXTENSION_NAME}")  <- - - - EXTENSION SPECIFIC
 set(EXTENSION_CATEGORY "Examples")  <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  EXTENSION SPECIFIC
 set(EXTENSION_CONTRIBUTORS "Jean-Christophe Fillion-Robin (Kitware)")  <- - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
@@ Line 182: / Line 182: @@
 # Extension meta-information <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
 set(EXTENSION_NAME MyLoadableModuleExtension)  <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC
-set(EXTENSION_HOMEPAGE "http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Extensions/${MODULE_NAME}")  <- - - - -  EXTENSION SPECIFIC
+set(EXTENSION_HOMEPAGE "http://www.slicer.org/wiki/Documentation/4.1/Extensions/${MODULE_NAME}")  <- - - - -  EXTENSION SPECIFIC
 set(EXTENSION_CATEGORY "Examples")  <- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  EXTENSION SPECIFIC
 set(EXTENSION_CONTRIBUTORS "Jean-Christophe Fillion-Robin (Kitware)")  <- - - - - - - - - - - - - - - - - - - - - - - - - - - EXTENSION SPECIFIC

Documentation/4.10/Developers/Tutorials/BundleModulesIntoExtension - Revision history

Grundlett: Text replacement - "\[http:\/\/www\.slicer\.org\/slicerWiki\/images\/([^ ]+) ([^]]+)]" to "[http://www.slicer.org/w/img_auth.php/$1 $2]"

Grundlett: Text replacement - "slicerWiki/index.php" to "wiki"

UpdateBot: Nightly -> 4.10