Difference between revisions of "Slicer3:Module Documentation Template"

From NAMIC Wiki
Jump to: navigation, search
Line 1: Line 1:
===Module Name===
+
<big>'''Note:''' We are migrating this content to the slicer.org domain - <font color="orange">The newer page is [http://www.slicer.org/slicerWiki/index.php/Slicer3:Module_Documentation_Template  here]</font></big>
MyModule
 
 
 
{|
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
 
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
 
|}
 
 
 
== General Information ==
 
===Module Type & Category===
 
 
 
Type: Interactive or CLI
 
 
 
Category: Base or (Filtering, Registration, ''etc.'')
 
 
 
===Authors, Collaborators & Contact===
 
* Author1: Affiliation & logo, if desired
 
* Contributor1: Affiliation & logo, if desired
 
* Contributor2: Affiliation & logo, if desired
 
* Contact: name, email
 
 
 
===Module Description===
 
Overview of what the module does goes here.
 
 
 
== Usage ==
 
 
 
===Examples, Use Cases & Tutorials===
 
 
 
* Note use cases for which this module is especially appropriate, and/or link to examples.
 
* Link to examples of the module's use
 
* Link to any existing tutorials
 
 
 
===Quick Tour of Features and Use===
 
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
 
 
 
* '''Input panel:'''
 
* '''Parameters panel:'''
 
* '''Output panel:'''
 
* '''Viewing panel:'''
 
 
 
== Development ==
 
 
 
===Dependencies===
 
 
 
Other modules or packages that are required for this module's use.
 
 
 
===Known bugs===
 
 
 
Follow this link to the Slicer3 bug tracker:
 
 
 
http://na-mic.org/Mantis/main_page.php
 
 
 
===Usability issues===
 
 
 
Follow this link to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing:
 
 
 
http://na-mic.org/Mantis/main_page.php
 
 
 
===Source code & documentation===
 
 
 
Customize following links for your module:
 
 
 
http://www.na-mic.org/ViewVC/index.cgi/
 
 
 
Links to documentation generated by doxygen:
 
 
 
http://www.na-mic.org/Slicer/Documentation/Slicer3/html/
 
 
 
== More Information ==
 
 
 
===Acknowledgement===
 
Include funding and other support here.
 
 
 
===References===
 
Publications related to this module go here. Links to pdfs would be useful.
 

Revision as of 15:04, 22 May 2008

Home < Slicer3:Module Documentation Template

Note: We are migrating this content to the slicer.org domain - The newer page is here