Documentation/Nightly/Developers/Tutorials/Contribute Extension Description File using Extension Wizard

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

Overview

This page describe how to easily contribute an extension description file using the ExtensionWizard. The wizard automates the manual steps documented here.

Definitions

• Extension description file: This is a text file with extension .s4ext that fully described an extension. More details here.

• ExtensionsIndex: This is a repository containing a list of extension description files *.s4ext. These description files are used by the Slicer extensions build system to build, test, package and upload extensions on the extensions server. More details here

Prerequisites

• Extension belongs to Category 1 or Category 2 as described in Slicer requirements
• Extension has been built, tested and installed on at least one platform (Linux, MacOSX or Windows)

Contributing a new extension / Requesting an extension update

Conventions

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

1. On Windows, Git Bash is expected (not the Windows command line). Need help ?

$ echo "This is a command"

Extensions built against Slicer trunk

The following instruction describes how to contribute extension description file for an extension being built against slicer trunk.

$ bin/slicerExtensionWizard --contribute ~/Slicer-MyExtension/

Extensions build against Slicer 4.10

The following instruction describes how to contribute extension description file for an extension being built against slicer 4.10.

$ bin/slicerExtensionWizard --contribute --target 4.10  ~/Slicer-MyExtension/