View source for Documentation/4.8/Developers/Tutorials/Contribute Extension Description File using Extension Wizard

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

= Overview =

This page describes how to easily contribute an extension description file using the [[Documentation/{{documentation/version}}/Developers/ExtensionWizard|ExtensionWizard]]. The wizard automates the manual steps documented [[Documentation/{{documentation/version}}/Developers/Tutorials/Contribute_Extension_Description_File|here]].

It will automatically generate the extension description file (<code>.s4ext</code>) based on the <code>CMakeLists.txt</code> in the extension directory.

= Definitions =

* '''Extension description file''': This is a text file with extension <code>.s4ext</code> that fully described an extension. More details [[Documentation/{{documentation/version}}/Developers/Extensions/DescriptionFile|here]].

* '''ExtensionsIndex''': This is a repository containing a list of extension description files <code>*.s4ext</code>. These description files are used by the Slicer extensions build system to build, test, package and upload extensions on the extensions server. More details [[Documentation/{{documentation/version}}/Developers/Extensions/Index|here]]

= Prerequisites =

* Extension belongs to Category 1 or Category 2 as described in [[Documentation/{{documentation/version}}/Extensions/CatalogPolicies|Slicer requirements]]
* Extension has been built, tested and installed on at least one platform (Linux, MacOSX or Windows)

= Conventions =

* Terminal command - Block like the one below indicates that the command should be executed in a terminal. 

<ol style="list-style-type:none; border-left:thick solid darkgreen; padding-left:1em;">  
<li>On '''Windows''', Git Bash is expected (not the Windows command line). [https://help.github.com/articles/set-up-git#platform-windows Need help ?]</li>
</ol>

{{pre2|<nowiki>$ echo "This is a command"</nowiki>}}

= Contributing a new extension / Requesting an extension update =

Typing this command will create a pull request on ExtensionsIndex repository.

<ol style="list-style-type:none; border-left:thick solid red; padding-left:1em;">  
<li>Make sure the latest changes associated with your extension have been pushed in your extension repository.</li>
</ol>

== Extensions built against Slicer trunk ==

{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute ~/src/Slicer-MyExtension/</nowiki>}}

== Extensions build against Slicer {{Documentation/currentversion}} ==

{{pre2|<nowiki>$ bin/slicerExtensionWizard --contribute --target </nowiki>{{Documentation/currentversion}}<nowiki>  ~/src/Slicer-MyExtension/</nowiki>}}