Difference between revisions of "Slicer3:Module Documentation Template"

From NAMIC Wiki
Jump to: navigation, search
m (Text replacement - "http://www.slicer.org/slicerWiki/index.php/" to "https://www.slicer.org/wiki/")
 
(19 intermediate revisions by 3 users not shown)
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 [https://www.slicer.org/wiki/Slicer3:Module_Documentation_Template  here]</font></big>
MyModule
 
 
 
{|
 
|[[Image:screenshotBlank.png | thumb | 280px ]]
 
|[[Image:screenshotBlank.png | thumb | 280px ]]
 
|[[Image:screenshotBlank.png | thumb | 280px ]]
 
|}
 
 
 
===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.
 
 
 
===Examples, Use Cases & Tutorials===
 
 
 
===Quick Tour of Features and Use===
 
List all the panels in your interface, their features, what they mean, and how to use them.
 
* '''Input panel:'''
 
* '''Parameters panel:'''
 
* '''Output panel:'''
 
* '''Viewing panel:'''
 
 
 
===Dependencies===
 
Other modules or packages that are required for this module's use.
 
 
 
===Known bugs===
 
Link to bug tracker. (Can we filter on bug reports?) Will encourage reporting of bugs.
 
 
 
===Usability issues===
 
Link to bug tracker. (can we filter on usability reports?)
 
 
 
===Source code & documentation===
 
links to code in svn
 
 
 
links to doxygen
 
 
 
===Acknowledgement===
 
Include funding and other support here.
 
 
 
===References===
 
Publications related to this module go here. Links to pdfs would be useful.
 

Latest revision as of 18:07, 10 July 2017

Home < Slicer3:Module Documentation Template

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