For the latest Slicer documentation, visit the read-the-docs.
Extension description file
An extension description file is a text file with
s4ext extension allowing to specify metadata associated with an extension.
- A metadata is specified using a keyword followed by at least one spaces and the associated value.
- Multiline value are not supported.
- Empty line are ignored
- Line starting with a
#will be considered as comment.
This file is generated by the build system in the extension build tree. It can also be generated by the ExtensionWizard using the extension metadata reported in the extension
Note that the Extension manager ignores many fields of the extension description file and instead uses information specified in
CMakeLists.txt. Therefore, when making any changes to the extension description, it has to be done in the
CMakeLists.txt file as well.
For the superbuild-based extensions, it is critical that the build_subdirectory is initialized to the inner build location in s4ext. The value of this variable in
CMakeLists.txt is not used in all places by the dashboard scripts.
The following code block illustrates how comments, metadata and associated value can be specified:
# This is a comment metadataname This is the value associated with 'metadataname' # This is an other comment anothermetadata This is the value associated with 'anothermetadata'
 Parameter like
&foo=bar are not supported. Use a url shortener.
Partially supported metadata
||Give people an idea what to expect from this code|