Difference between revisions of "Slicer4:Module Documentation-4.0 Template"
(No difference)
| |
Revision as of 18:23, 13 June 2011
Home < Slicer4:Module Documentation-4.0 TemplateReturn to Slicer 4 alpha Documentation
Module Name
MyModule
General Information
Module Description
Overview of what the module does goes here.
Authors, Collaborators & Contact
- Author1: Affiliation & logo, if desired
- Contributor1: Affiliation & logo, if desired
- Contributor2: Affiliation & logo, if desired
- Contact: name, email
Similar Modules
- Point to other modules that have similar functionality
Module Type & Category
Type: Interactive or CLI
Category: Base or (Filtering, Registration, etc.)
Usage
Use Cases, Examples
This module is especially appropriate for these use cases:
- Use Case 1:
- Use Case 2:
Examples of the module in use:
- Example 1
- Example 2
Tutorials
Links to tutorials explaining how to use this module:
- Tutorial 1
- Data Set 1
Quick Tour of Features and Use
A list panels in the interface, their features, what they mean, and how to use them. For instance:
|
Development
Notes from the Developer(s)
Algorithms used, library classes depended upon, use cases, etc.
Dependencies
Other modules or packages that are required for this module's use.
Tests
On the Dashboard, these tests verify that the module is working on various platforms:
- MyModuleTest1 MyModuleTest1.cxx
- MyModuleTest2 MyModuleTest2.cxx
Known bugs
Links to known bugs in the Slicer3 bug tracker
Usability issues
Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.
Source code & documentation
Links to the module's source code:
Source code:
Doxygen documentation:
More Information
Acknowledgment
Include funding and other support here.
References
Publications related to this module go here. Links to pdfs would be useful.
