Difference between revisions of "Modules:Documentation-Template"
From Slicer Wiki
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | [[Documentation|Return to Slicer Documentation]] | ||
| + | |||
* Most modules should contain the following information. Duplication between these pages and the contents of the help inside the module are ok. | * Most modules should contain the following information. Duplication between these pages and the contents of the help inside the module are ok. | ||
=Who= | =Who= | ||
| − | Who wrote the module: | + | *Who wrote the module: |
* Author, | * Author, | ||
* Lab, | * Lab, | ||
| Line 10: | Line 12: | ||
* Pointer to the web location of the paper that describes the algorithm | * Pointer to the web location of the paper that describes the algorithm | ||
* What data or type of data was used for the development of the algorithm | * What data or type of data was used for the development of the algorithm | ||
| − | = | + | =Parameters= |
* What is the meaning of the parameters exposed, assuming one has read the paper | * What is the meaning of the parameters exposed, assuming one has read the paper | ||
* Known strategies for adjusting to other types of data or pointer to a short tutorial | * Known strategies for adjusting to other types of data or pointer to a short tutorial | ||
Latest revision as of 12:09, 14 April 2008
Home < Modules:Documentation-TemplateReturn to Slicer Documentation
- Most modules should contain the following information. Duplication between these pages and the contents of the help inside the module are ok.
Who
- Who wrote the module:
- Author,
- Lab,
- Supervisor (if applicable),
- logo of lab/institution
What
- Short description what the module is supposed to do
- Pointer to the web location of the paper that describes the algorithm
- What data or type of data was used for the development of the algorithm
Parameters
- What is the meaning of the parameters exposed, assuming one has read the paper
- Known strategies for adjusting to other types of data or pointer to a short tutorial
