Difference between revisions of "Slicer3:Extensions"

From Slicer Wiki
Jump to: navigation, search
Line 3: Line 3:
 
== FOR DEVELOPERS ==
 
== FOR DEVELOPERS ==
  
Extensions must follow the appropriate architecture 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.
+
Extensions must follow the appropriate architecture 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.
  
 
To enable your Command Line, Scripted, or Loadable module, add an "s3ext" script to the /Slicer3/Extensions directory of the source repository:
 
To enable your Command Line, Scripted, or Loadable module, add an "s3ext" script to the /Slicer3/Extensions directory of the source repository:

Revision as of 21:29, 8 May 2009

Home < Slicer3:Extensions

3D Slicer now supports extensions. Extensions are available from an extension server. This allows end-users to select the extensions useful to them, without having to download the entire extension archive.

FOR DEVELOPERS

Extensions must follow the appropriate architecture 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.

To enable your Command Line, Scripted, or Loadable module, add an "s3ext" script to the /Slicer3/Extensions directory of the source repository:

PythonSampleScriptedModule.s3ext:

#
# 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