Difference between revisions of "Slicer3:Module Documentation Template"

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

@@ 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
-===Module Type & Category===
-Interactive / CLI?
-===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.
-===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===
-If you know something doesn't work (yet), leave a note here.
-This would be a convenient place to expose outstanding bugs to users.
-===Usability issues===
-This would be a convenient place to expose outstanding usability problems to users.
-===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.