Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"
From Slicer Wiki
| Line 1: | Line 1: | ||
| − | + | <!-- ---------------------------- --> | |
| + | {{module:documentation:header}} | ||
| + | <!-- ---------------------------- --> | ||
| − | + | <!-- ---------------------------- --> | |
| − | + | {{module:documentation:section|Introduction and Acknowledgements}} | |
| − | + | {{module:introduction-start|<Put the name of the module here>|image=screenshotBlankNotOptional.png}} | |
| − | + | * 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 [http://www.na-mic.org/ NA-MIC website]. | |
| − | |||
| − | { | ||
| − | |||
| − | | | ||
* Author1: Steve Pieper, Isomics (replace this with your name and affiliation) | * Author1: Steve Pieper, Isomics (replace this with your name and affiliation) | ||
* Contributor1: Nicole Aucoin, Surgical Planning Laboratory, BWH, HMS (replace this with your name and affiliation) | * Contributor1: Nicole Aucoin, Surgical Planning Laboratory, BWH, HMS (replace this with your name and affiliation) | ||
* Contributor2: Name, Affiliation | * Contributor2: Name, Affiliation | ||
| − | * Contact: name | + | * Contact: {{module:contact|name=YourName|email=EmailIsRequired}} |
| − | | | + | {{module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}} |
| − | + | {{module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}} | |
| − | | | + | {{module:introduction-end}} |
| − | |||
| − | |||
| − | + | <!-- ---------------------------- --> | |
| + | {{module:documentation:section|Module Description}} | ||
Here comes a description what the module is good for. Explain briefly how it works and point to the [[Module:EndUserDocumentationTemplate-4.0#References|references]] giving more details on the algorithm. | Here comes a description what the module is good for. Explain briefly how it works and point to the [[Module:EndUserDocumentationTemplate-4.0#References|references]] giving more details on the algorithm. | ||
| − | + | <!-- ---------------------------- --> | |
| − | + | {{module:documentation:section|Use Cases}} | |
| − | |||
Most frequently used for these scenarios: | Most frequently used for these scenarios: | ||
| Line 30: | Line 26: | ||
* Use Case 2: | * Use Case 2: | ||
| − | + | <!-- ---------------------------- --> | |
| + | {{module:documentation:section|Tutorials}} | ||
Links to tutorials that use this module | Links to tutorials that use this module | ||
| − | + | <!-- ---------------------------- --> | |
| + | {{module:documentation:section|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: | A list of all the panels in the interface, their features, what they mean, and how to use them. For instance: | ||
| Line 67: | Line 65: | ||
|} | |} | ||
| − | + | <!-- ---------------------------- --> | |
| + | {{module:documentation:section|Similar Modules}} | ||
* Point to other modules that have similar functionality | * Point to other modules that have similar functionality | ||
| − | + | <!-- ---------------------------- --> | |
| + | {{module:documentation:section|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 | For extensions: link to the source code repository and additional documentation | ||
| − | + | {{module:documentation:section|Information for Developers}} | |
| − | + | {{module:developerinfo|ModuleTemplate|type=Interactive|category=Example}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 21:30, 24 August 2011
Home < Documentation < 4.0 < Modules < YOURMODULENAMETemplate:Module:documentation:header
Template:Module:documentation:section Template:Module:introduction-start
- 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.
- Author1: Steve Pieper, Isomics (replace this with your name and affiliation)
- Contributor1: Nicole Aucoin, Surgical Planning Laboratory, BWH, HMS (replace this with your name and affiliation)
- Contributor2: Name, Affiliation
- Contact: Template:Module:contact
Template:Module:introduction-logo Template:Module:introduction-logo Template:Module:introduction-end
Template:Module:documentation:section 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.
Template:Module:documentation:section Most frequently used for these scenarios:
- Use Case 1:
- Use Case 2:
Template:Module:documentation:section Links to tutorials that use this module
Template:Module:documentation:section
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
|
|
|
Template:Module:documentation:section
- Point to other modules that have similar functionality
Template:Module:documentation:section Publications related to this module go here. Links to pdfs would be useful. For extensions: link to the source code repository and additional documentation
Template:Module:documentation:section Template:Module:developerinfo
