Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"
From Slicer Wiki
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887) |
|||
(30 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-header}} |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}} |
− | {{module | + | {{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}} |
− | + | {{documentation/{{documentation/version}}/module-introduction-row}} | |
− | + | 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].<br> | |
− | + | Author: FIRSTNAME LASTNAME, AFFILIATION<br> | |
− | + | Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br> | |
− | + | Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br> | |
− | {{module | + | Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br> |
− | {{ | + | {{documentation/{{documentation/version}}/module-introduction-row}} |
− | {{module | + | {{documentation/{{documentation/version}}/module-introduction-logo-gallery |
+ | |{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}} <- Replace this logo with yours | ||
+ | |{{collaborator|logo|spl}}|{{collaborator|longname|spl}} <-Replace this logo with yours | ||
+ | }} | ||
+ | {{documentation/{{documentation/version}}/module-introduction-end}} | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-section|Module Description}} |
− | Here comes a description what the module is good for. Explain briefly how it works and point to the [[ | + | N/A |
+ | <!-- | ||
+ | Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|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:<pre>{{documentation/{{documentation/version}}/module-description}} |
− | {{module | ||
− | |||
− | + | {{documentation/{{documentation/version}}/module-description}} | |
− | + | --> | |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-section|Use Cases}} |
− | + | N/A | |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-section|Tutorials}} |
+ | N/A | ||
− | + | <!-- ---------------------------- --> | |
+ | {{documentation/{{documentation/version}}/module-section|Panels and their use}} | ||
+ | N/A | ||
+ | <!-- | ||
+ | {{documentation/{{documentation/version}}/module-parametersdescription}} | ||
+ | --> | ||
− | { | + | <!-- ---------------------------- --> |
− | + | {{documentation/{{documentation/version}}/module-section|Similar Modules}} | |
− | + | N/A | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-section|References}} |
− | + | N/A | |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module | + | {{documentation/{{documentation/version}}/module-section|Information for Developers}} |
− | + | {{documentation/{{documentation/version}}/module-developerinfo}} | |
− | + | ||
− | {{ | + | <!-- ---------------------------- --> |
− | + | {{documentation/{{documentation/version}}/module-footer}} | |
+ | <!-- ---------------------------- --> |
Latest revision as of 07:28, 14 June 2013
Home < Documentation < 4.0 < Modules < YOURMODULENAME
For the latest Slicer documentation, visit the read-the-docs. |
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
N/A
Use Cases
N/A
Tutorials
N/A
Panels and their use
N/A
Similar Modules
N/A
References
N/A
Information for Developers
Section under construction. |