Difference between revisions of "Slicer3:Module Documentation Template"
| Line 8: | Line 8: | ||
|} | |} | ||
| + | == General Information == | ||
===Module Type & Category=== | ===Module Type & Category=== | ||
| Line 22: | Line 23: | ||
===Module Description=== | ===Module Description=== | ||
Overview of what the module does goes here. | Overview of what the module does goes here. | ||
| + | |||
| + | == Usage == | ||
===Examples, Use Cases & Tutorials=== | ===Examples, Use Cases & Tutorials=== | ||
| Line 35: | Line 38: | ||
* '''Output panel:''' | * '''Output panel:''' | ||
* '''Viewing panel:''' | * '''Viewing panel:''' | ||
| + | |||
| + | == Development == | ||
===Dependencies=== | ===Dependencies=== | ||
| + | |||
Other modules or packages that are required for this module's use. | Other modules or packages that are required for this module's use. | ||
===Known bugs=== | ===Known bugs=== | ||
| + | |||
Link to bug tracker. (Can we filter on bug reports?) | Link to bug tracker. (Can we filter on bug reports?) | ||
| + | |||
| + | http://na-mic.org/Mantis/main_page.php | ||
===Usability issues=== | ===Usability issues=== | ||
| + | |||
| + | http://na-mic.org/Mantis/main_page.php | ||
| + | |||
Link to bug tracker. (Can we filter on usability reports?) | Link to bug tracker. (Can we filter on usability reports?) | ||
===Source code & documentation=== | ===Source code & documentation=== | ||
| − | links | + | |
| + | Customize following links for your module: | ||
| + | |||
| + | http://www.na-mic.org/ViewVC/index.cgi/ | ||
links to doxygen | links to doxygen | ||
| + | |||
| + | http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ | ||
| + | |||
| + | == More Information == | ||
===Acknowledgement=== | ===Acknowledgement=== | ||
Revision as of 16:18, 8 June 2007
Home < Slicer3:Module Documentation TemplateModule Name
MyModule
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. (Can we filter on bug reports?)
http://na-mic.org/Mantis/main_page.php
Usability issues
http://na-mic.org/Mantis/main_page.php
Link to bug tracker. (Can we filter on usability reports?)
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.
