Difference between revisions of "Slicer3:Module Documentation Template"
From Slicer Wiki
m (1 revision) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Documentation|Return to Slicer Documentation]] | ||
| + | __NOTOC__ | ||
===Module Name=== | ===Module Name=== | ||
MyModule | MyModule | ||
| Line 48: | Line 50: | ||
===Known bugs=== | ===Known bugs=== | ||
| − | Follow this link to the Slicer3 bug tracker | + | Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. |
| + | |||
| − | |||
===Usability issues=== | ===Usability issues=== | ||
| − | Follow this link to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing | + | Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing. |
| − | |||
| − | |||
===Source code & documentation=== | ===Source code & documentation=== | ||
| − | Customize following | + | Customize following [http://www.na-mic.org/ViewVC/index.cgi/ links] for your module. |
| − | |||
| − | http://www.na-mic.org/ViewVC/index.cgi/ | ||
| − | Links to documentation generated by doxygen | + | [http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen. |
| − | |||
== More Information == | == More Information == | ||
| − | === | + | ===Acknowledgment=== |
Include funding and other support here. | Include funding and other support here. | ||
===References=== | ===References=== | ||
Publications related to this module go here. Links to pdfs would be useful. | Publications related to this module go here. Links to pdfs would be useful. | ||
Latest revision as of 10:55, 23 May 2008
Home < Slicer3:Module Documentation TemplateReturn to Slicer Documentation
Module 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. For instance:
- Input panel:
- Parameters panel:
- Output panel:
- Viewing panel:
Development
Dependencies
Other modules or packages that are required for this module's use.
Known bugs
Follow this link to 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
Customize following links for your module.
Links to documentation generated by doxygen.
More Information
Acknowledgment
Include funding and other support here.
References
Publications related to this module go here. Links to pdfs would be useful.
