Documentation/4.0/Developers/ModuleWizard - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:30:05Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Spujol: /* Examples */

2012-06-13T17:44:05Z

Examples

Pieper at 22:13, 7 January 2012

2012-01-07T22:13:02Z

Pieper: Created page with '== Background =='

2012-01-07T22:05:46Z

Created page with '== Background =='

New page

== Background ==

← Older revision		Revision as of 07:30, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	== Background ==		== Background ==

@@ Line 32: / Line 32: @@
    ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/ScriptedLoadableExtensionTemplate --target ../MyScript MyScript
 To create [[Documentation/4.0/EditorExtension|An EditorExtension]]
    ./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/EditorExtensionTemplate --target ../MyEditorEffect MyEditorEffect

← Older revision		Revision as of 22:13, 7 January 2012
Line 1:		Line 1:
	== 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 [[Documentation/4.0/EditorExtension\|An EditorExtension]]
		+	./Utilities/Scripts/ModuleWizard.py --template ./Extensions/Testing/EditorExtensionTemplate --target ../MyEditorEffect MyEditorEffect