Difference between revisions of "Slicer3:Module Documentation Template"
From NAMIC Wiki
| Line 36: | Line 36: | ||
===Known bugs=== | ===Known bugs=== | ||
| − | + | Link to bug tracker. Will encourage reporting of bugs. | |
| − | |||
===Usability issues=== | ===Usability issues=== | ||
Revision as of 20:45, 7 June 2007
Home < Slicer3:Module Documentation TemplateContents
Module Name
MyModule
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. Will encourage reporting of bugs.
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.
