Difference between revisions of "Slicer3:Module Documentation Template"
From NAMIC Wiki
| Line 1: | Line 1: | ||
| − | |||
===Module Name=== | ===Module Name=== | ||
MyModule | MyModule | ||
| Line 21: | Line 20: | ||
Overview of what the module does goes here. | Overview of what the module does goes here. | ||
| − | ===Examples & Tutorials=== | + | ===Examples, Use Cases & Tutorials=== |
===Quick Tour of Features and Use=== | ===Quick Tour of Features and Use=== | ||
Revision as of 20:34, 7 June 2007
Home < Slicer3:Module Documentation TemplateContents
Module Name
MyModule
 Return to Project Week Main Page |
Return to Project Week Main Page |
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.
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
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.
