Difference between revisions of "Documentation/4.0/Modules/SlicerWelcome"
Line 10: | Line 10: | ||
Author: Wendy Plesniak, SPL<br> | Author: Wendy Plesniak, SPL<br> | ||
Contributor1: Ron Kikinis, SPL <br> | Contributor1: Ron Kikinis, SPL <br> | ||
− | Contributor2: Steve Pieper, Isomics <br> | + | Contributor2: Steve Pieper, Isomics, Inc. <br> |
Contributor3: Sonia Pujol, SPL <br> | Contributor3: Sonia Pujol, SPL <br> | ||
− | Contact: Wendy Plesniak, wjp@bwh.harvard.edu<br> | + | Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email><br> |
{{documentation/{{documentation/version}}/module-introduction-row}} | {{documentation/{{documentation/version}}/module-introduction-row}} | ||
{{documentation/{{documentation/version}}/module-introduction-logo-gallery | {{documentation/{{documentation/version}}/module-introduction-logo-gallery | ||
|Image:Logo-splnew.jpg|Surgical Planning Laboratory | |Image:Logo-splnew.jpg|Surgical Planning Laboratory | ||
|Image:Logo-isomics.png|Isomics, Inc. | |Image:Logo-isomics.png|Isomics, Inc. | ||
+ | |Image:NAMIC 380x463.jpg|NA-MIC | ||
+ | |Image:NAC-logo.png|NAC | ||
}} | }} | ||
{{documentation/{{documentation/version}}/module-introduction-end}} | {{documentation/{{documentation/version}}/module-introduction-end}} |
Revision as of 20:52, 11 November 2011
Home < Documentation < 4.0 < Modules < SlicerWelcome
Introduction and Acknowledgements
This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the NA-MIC website. | |||||||||
|
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.
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:
{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}
Using this later template, the final syntax would be:
{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}
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
Section under construction. |
The section above is generated using the following wiki code:
{{documentation/{{documentation/version}}/module-section|Information for Developers}} {{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:
{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}
Using this later template, the final syntax would be:
{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}