Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"
Line 72: | Line 72: | ||
==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. | ||
+ | For extensions: link to the source code repository and additional documentation | ||
= Information for Developers = | = Information for Developers = |
Revision as of 14:03, 11 August 2011
Home < Documentation < 4.0 < Modules < YOURMODULENAMEReturn to the Slicer 4.0 Documentation
Introduction and Acknowledgements
|
||
Module Description
Here comes a description what the module is good for. Explain briefly how it works and point to the references giving more details on the algorithm.
Use Cases
Most frequently used for these scenarios:
- Use Case 1:
- Use Case 2:
Tutorials
Links to tutorials that use this module
Panels and their use
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
|
|
|
Similar Modules
- Point to other modules that have similar functionality
References
Publications related to this module go here. Links to pdfs would be useful. For extensions: link to the source code repository and additional documentation
Information for Developers
Module Type & Category
Type: Interactive or CLI
Category: Base or (Filtering, Registration, etc.)
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 Slicer4 Dashboard, these tests verify that the module is working on various platforms:
- MyModuleTest1 MyModuleTest1.cxx
- MyModuleTest2 MyModuleTest2.cxx
Source code & documentation
Links to the module's source code:
Source code:
Doxygen documentation: