Difference between revisions of "Slicer3:Module Documentation Template"

From NAMIC Wiki
Jump to: navigation, search
Line 25: Line 25:
 
===Examples, Use Cases & Tutorials===
 
===Examples, Use Cases & Tutorials===
  
* Indicate particular applications where this module is especially useful (or not so useful?) or link to examples.
+
* 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 examples of the module's use
 
* Link to any existing tutorials
 
* Link to any existing tutorials

Revision as of 20:51, 7 June 2007

Home < Slicer3:Module Documentation Template

Module Name

MyModule

ScreenshotBlank.png
ScreenshotBlank.png
ScreenshotBlank.png

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

  • 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.

  • 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?)

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.