Difference between revisions of "Slicer3:Module Documentation Template"

From NAMIC Wiki
Jump to: navigation, search
Line 12: Line 12:
 
===Module Description===
 
===Module Description===
 
Overview of what the module does goes here.
 
Overview of what the module does goes here.
 +
 +
===Use cases===
  
 
===Quick Tour of Features and Use===
 
===Quick Tour of Features and Use===

Revision as of 20:01, 7 June 2007

Home < Slicer3:Module Documentation Template

Module Name

MyModule

Module Type

Interactive / CLI?

Authors & Contributors

  • Author1: Affiliation & logo, if desired
  • Contributor1: Affiliation & logo, if desired
  • Contributor2: Affiliation & logo, if desired

Module Description

Overview of what the module does goes here.

Use cases

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.

Acknowledgement

Include funding and other support here.

References

Publications related to this module go here. Links to pdfs would be useful.