Difference between revisions of "Slicer3:Module Documentation Template"

From NAMIC Wiki
Jump to: navigation, search
Line 53: Line 53:
 
===Usability issues===
 
===Usability issues===
  
Link to Slicer3 bug tracker is given below. Please select the "usability issue" category when entering you comments:
+
Link to Slicer3 bug tracker is given below. Please select the '''usability issue category''' when entering you comments:
  
 
http://na-mic.org/Mantis/main_page.php
 
http://na-mic.org/Mantis/main_page.php

Revision as of 11:58, 11 June 2007

Home < Slicer3:Module Documentation Template

Module Name

MyModule

Caption 1
Caption 2
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.

  • Input panel:
  • Parameters panel:
  • Output panel:
  • Viewing panel:

Development

Dependencies

Other modules or packages that are required for this module's use.

Known bugs

Link to bug tracker.

http://na-mic.org/Mantis/main_page.php

Usability issues

Link to Slicer3 bug tracker is given below. Please select the usability issue category when entering you comments:

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