Modules:ExtensionsManagementWizard-Documentation-3.6 - Revision history

Wjp: /* Acknowledgment */

2010-05-10T00:29:32Z

Acknowledgment

Wjp: /* Source code & documentation */

2010-05-10T00:27:49Z

Source code & documentation

Wjp: /* Usability issues */

2010-05-10T00:26:53Z

Usability issues

Wjp: /* Development */

2010-05-09T21:00:42Z

Development

Wjp: /* Dependencies */

2010-05-09T21:00:03Z

Dependencies

Wjp: /* Usage */

2010-05-09T20:59:39Z

Usage

Wjp at 20:59, 9 May 2010

2010-05-09T20:59:06Z

Wjp: /* Module Description */

2010-05-09T20:57:37Z

Module Description

Wjp: /* General Information */

2010-05-09T20:57:08Z

General Information

Wjp: /* General Information */

2010-05-09T20:56:52Z

General Information

← Older revision		Revision as of 00:29, 10 May 2010
Line 95:		Line 95:

	===Acknowledgment===		===Acknowledgment===
−	~~Include funding~~ and ~~other support here~~	+	This work was funded in part by collaborations between [http://www.na-mic.org/Wiki/index.php/NA-MIC_and_NITRC NA-MIC and NITRC.]

← Older revision		Revision as of 00:27, 10 May 2010
Line 91:		Line 91:

	===Source code & documentation===		===Source code & documentation===
−
−	~~Links to the module's source code:~~
−
−	~~Source code:~~
−	*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.cxx ]
−	*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.h ]
−
−	~~Doxygen documentation:~~
−	*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classes.html class1]

	== More Information ==		== More Information ==

← Older revision		Revision as of 00:26, 10 May 2010
Line 48:		Line 48:

	Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.		Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.
		+
		+	== FOR DEVELOPERS ==
		+
		+	Extensions must follow the appropriate architecture and must meet minimum documentation requirements for them to be made available to end users. See [[Slicer3:Loadable_Modules]] for an example of how to make GUI and GUI-less Loadable Modules. Command Line and Scripted Modules will also work with this framework.
		+
		+	You can choose the version of your code that you want to make available to end users by having the Subversion repository URL in the s3ext script point to either the trunk of your code base or to a stable branch.
		+
		+	To enable your Command Line, Scripted, or Loadable module, add an "s3ext" script to the /Slicer3/Extensions directory of the source repository:
		+
		+	PythonSampleScriptedModule.s3ext:
		+	<pre>
		+	#
		+	# first token of each non-comment line is the keyword and the rest of the line
		+	# (including spaces) is the value.
		+	# - the value can be blank
		+	#
		+
		+	# scm is source code manager (i.e. svn)
		+	scm svn
		+	svnpath https://www.nitrc.org/svn/slicer3examples/trunk/Slicer3ExampleModules/Scripted/PythonSampleScriptedModule
		+	svnusername slicerbot
		+	svnpassword slicer
		+
		+	# list dependencies
		+	# - these should be names of other modules that have .s3ext files
		+	# - the dependencies will be built first
		+	depends ScriptedModule
		+
		+	# homepage
		+	homepage http://www.slicer.org
		+
		+	# match category in the xml description of the module (where it shows up in Modules menu)
		+	category Developer Tools
		+
		+	# give people an idea what to expect from this code
		+	# - is it just a test or something you stand beind?
		+	status Beta
		+
		+	# One line description of what the module does
		+	description This is an example of an extension module written in python
		+	</pre>

	===Source code & documentation===		===Source code & documentation===

← Older revision		Revision as of 21:00, 9 May 2010
Line 43:		Line 43:
	[[Image:Slicer36-ModulesManagement2.png \|thumb \| 350 px \| center]]		[[Image:Slicer36-ModulesManagement2.png \|thumb \| 350 px \| center]]

−	~~== Development ==~~
−
−	~~===Notes from the Developer(s)===~~
−
−	~~Algorithms used, library classes depended upon, use cases, etc.~~
−
−	~~===Tests===~~
−
−	~~On the [http://www.cdash.org/CDash/index.php?project=Slicer3 Dashboard], these tests verify that the module is working on various platforms:~~
−
−	* MyModuleTest1 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest1.cxx]
−	* MyModuleTest2 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest2.cxx]
−
−	~~===Known bugs===~~
−
−	~~Links to known bugs in the Slicer3 bug tracker~~
−
−	* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]

← Older revision		Revision as of 21:00, 9 May 2010
Line 48:		Line 48:

	Algorithms used, library classes depended upon, use cases, etc.		Algorithms used, library classes depended upon, use cases, etc.
−
−	~~===Dependencies===~~
−
−	~~Other modules or packages that are required for this module's use.~~

	===Tests===		===Tests===

← Older revision		Revision as of 20:59, 9 May 2010
Line 42:		Line 42:

	[[Image:Slicer36-ModulesManagement2.png \|thumb \| 350 px \| center]]		[[Image:Slicer36-ModulesManagement2.png \|thumb \| 350 px \| center]]
−
−	~~== Usage ==~~
−
−	~~===Use Cases, Examples===~~
−
−	~~This module is especially appropriate for these use cases:~~
−
−	* Use Case 1:
−	* Use Case 2:
−
−	~~Examples of the module in use:~~
−
−	* Example 1
−	* Example 2
−
−	~~===Tutorials===~~
−
−	~~Links to tutorials explaining how to use this module:~~
−
−	* Tutorial 1
−	** Data Set 1
−
−	~~===Quick Tour of Features and Use===~~
−
−	~~A list panels in the interface, their features, what they mean, and how to use them. For instance:~~
−
−	{\|
−	\|
−	* '''Input panel:'''
−	** '''First input'''
−	** '''Second input'''
−	* '''Parameters panel:'''
−	** '''First parameter'''
−	** '''Second parameter'''
−	* '''Output panel:'''
−	** '''First output'''
−	** '''Second output'''
−	* '''Viewing panel:'''
−	~~\|[[Image:screenshotBlankNotOptional.png\|thumb\|280px\|User Interface]]~~
−	\|}

	== Development ==		== Development ==

@@ Line 37: / Line 37: @@
 * You can select a local install directory for your downloaded extensions (be sure to choose a directory with enough free space).
 * Select the extensions you wish to install and click to download them. Installed extensions will be available when you restart slicer.
-* To turn modules on or off, you can use the Module Settings page of the View->Application Settings dialog: [[Image:Slicer36-ModulesManagement1.png]]
+* To turn modules on or off, you can use the Module Settings page of the View->Application Settings dialog:
-[[Image:Slicer36-ModulesManagement2.png |thumb | 350 px | left]]
+[[Image:Slicer36-ModulesManagement1.png]]
 == Usage ==

← Older revision		Revision as of 20:57, 9 May 2010
Line 12:		Line 12:

	'''Note:''' We are currently using NITRC as a repository for contributed extensions. As a general rule, we do not test them ourselves, it is the downloaders' job to ensure that they do what they want them to do.		'''Note:''' We are currently using NITRC as a repository for contributed extensions. As a general rule, we do not test them ourselves, it is the downloaders' job to ensure that they do what they want them to do.
−	~~[[Image:Slicer35-Extensions1.png \| thumb \| 350 px \| left ]]~~ [[Image:Slicer36-SlicerOnNITRC.png \| thumb \| 350 px \| left ]]	+	[[Image:Slicer36-SlicerOnNITRC.png \| thumb \| 350 px \| left ]]

← Older revision		Revision as of 20:56, 9 May 2010
Line 12:		Line 12:

	'''Note:''' We are currently using NITRC as a repository for contributed extensions. As a general rule, we do not test them ourselves, it is the downloaders' job to ensure that they do what they want them to do.		'''Note:''' We are currently using NITRC as a repository for contributed extensions. As a general rule, we do not test them ourselves, it is the downloaders' job to ensure that they do what they want them to do.
−	[[Image:Slicer36-SlicerOnNITRC.png \| thumb \| 350 px \| left ]]	+	[[Image:Slicer35-Extensions1.png \| thumb \| 350 px \| left ]] [[Image:Slicer36-SlicerOnNITRC.png \| thumb \| 350 px \| left ]]