Difference between revisions of "Documentation/4.0/Developers/ModuleWizard"

From Slicer Wiki
Jump to: navigation, search
(Created page with '== Background ==')
 
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
== Background ==
 
== Background ==
 +
 +
Slicer modules typically consist of several files of various types, such as CMake files, source files, and binary files.
 +
 +
In many cases, the names of the files and the names of text strings inside the files are related and need to be in sync in order for things to compile.
 +
 +
Also, it is not uncommon to want to use one module as the starting point for implementing similar functionality.
 +
 +
== Terminology ==
 +
 +
* The ''template'' is a directory containing a slicer module
 +
* The ''templateKey'' is a text string, typically the name of the module, that is used in both filename and identifiers inside the module.
 +
* The ''target'' is a directory where you want the new module to be placed
 +
* The ''moduleName'' is the string that you want to use in place of the ''templateKey''
 +
 +
== Usage ==
 +
 +
ModuleWizard [--template <dir>] [--templateKey <key>] [--target <dir>] <moduleName>
 +
  --template default ./Modules/Loadable/ModuleTemplate
 +
  --templateKey default is dirname of template
 +
  --target default ./Modules/Loadable/<moduleName>
 +
 +
== Examples ==
 +
 +
These can be run from the Slicer4 source directory.
 +
 +
To create a Loadable Extension:
 +
 +
  ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/LoadableExtensionTemplate --target ../MyExtension MyExtension
 +
 +
To create a Scripted Loadable Extension:
 +
 +
  ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/ScriptedLoadableExtensionTemplate --target ../MyScript MyScript
 +
 +
To create a CLI Extension:
 +
 +
  ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate --target ../MyExtension MyExtension
 +
 +
To create [[Documentation/4.0/EditorExtension|An EditorExtension]]
 +
  ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/EditorExtensionTemplate --target ../MyEditorEffect MyEditorEffect

Latest revision as of 07:30, 14 June 2013

Home < Documentation < 4.0 < Developers < ModuleWizard


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


Background

Slicer modules typically consist of several files of various types, such as CMake files, source files, and binary files.

In many cases, the names of the files and the names of text strings inside the files are related and need to be in sync in order for things to compile.

Also, it is not uncommon to want to use one module as the starting point for implementing similar functionality.

Terminology

  • The template is a directory containing a slicer module
  • The templateKey is a text string, typically the name of the module, that is used in both filename and identifiers inside the module.
  • The target is a directory where you want the new module to be placed
  • The moduleName is the string that you want to use in place of the templateKey

Usage

ModuleWizard [--template <dir>] [--templateKey <key>] [--target <dir>] <moduleName>
 --template default ./Modules/Loadable/ModuleTemplate
 --templateKey default is dirname of template
 --target default ./Modules/Loadable/<moduleName>

Examples

These can be run from the Slicer4 source directory.

To create a Loadable Extension: 

 ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/LoadableExtensionTemplate --target ../MyExtension MyExtension

To create a Scripted Loadable Extension: 

 ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/ScriptedLoadableExtensionTemplate --target ../MyScript MyScript

To create a CLI Extension: 

 ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/CLIExtensionTemplate --target ../MyExtension MyExtension

To create An EditorExtension 

 ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/EditorExtensionTemplate --target ../MyEditorEffect MyEditorEffect
Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0/Developers/ModuleWizard&oldid=32427"