|
|
| Line 18: |
Line 18: |
| | }} | | }} |
| | {{documentation/{{documentation/version}}/module-introduction-end}} | | {{documentation/{{documentation/version}}/module-introduction-end}} |
| − |
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | {{note}}The section above is generated using the following wiki code:
| |
| − | <pre>
| |
| − | {{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
| |
| − | {{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>
| |
| − | Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
| |
| − | {{documentation/{{documentation/version}}/module-introduction-row}}
| |
| − | {{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}}
| |
| − | </pre>
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − |
| |
| − |
| |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|Module Description}} | | {{documentation/{{documentation/version}}/module-section|Module Description}} |
| | + | 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. | | 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}} |
| − | <!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | 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|xmlurl=http://path/to/YOURMODULE.xml }}</pre> | |
| − | | |
| − | If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
| |
| − | | |
| − | Using this later template, the final syntax would be:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| | | | |
| | + | {{documentation/{{documentation/version}}/module-description}} |
| | + | --> |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|Use Cases}} | | {{documentation/{{documentation/version}}/module-section|Use Cases}} |
| − | Most frequently used for these scenarios:
| + | N/A |
| − | | |
| − | * Use Case 1:
| |
| − | * Use Case 2:
| |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|Tutorials}} | | {{documentation/{{documentation/version}}/module-section|Tutorials}} |
| − | Links to tutorials that use this module
| + | N/A |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|Panels and their use}} | | {{documentation/{{documentation/version}}/module-section|Panels and their use}} |
| − | | + | N/A |
| − | A list of all the panels in the interface, their features, what they mean, and how to use them. For instance: | |
| − | | |
| − | {|style="width: 100%"
| |
| − | |
| |
| − | * Input panel1:
| |
| − | ** First input
| |
| − | ** Second input
| |
| − | * Parameters panel:
| |
| − | ** First parameter
| |
| − | ** Second parameter
| |
| − | * Output panel:
| |
| − | ** First output
| |
| − | ** Second output
| |
| − | * Viewing panel:
| |
| − | | align="right" |
| |
| − | [[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
| |
| − | |-
| |
| − | |
| |
| − | * Input panel2:
| |
| − | ** First input
| |
| − | ** Second input
| |
| − | * Parameters panel:
| |
| − | ** First parameter
| |
| − | ** Second parameter
| |
| − | * Output panel:
| |
| − | ** First output
| |
| − | ** Second output
| |
| − | * Viewing panel:
| |
| − | | align="right" |
| |
| − | [[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
| |
| − | |}
| |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|Similar Modules}} | | {{documentation/{{documentation/version}}/module-section|Similar Modules}} |
| − | * Point to other modules that have similar functionality
| + | N/A |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|References}} | | {{documentation/{{documentation/version}}/module-section|References}} |
| − | Publications related to this module go here. Links to pdfs would be useful.
| + | N/A |
| − | For extensions: link to the source code repository and additional documentation
| |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| | {{documentation/{{documentation/version}}/module-section|Information for Developers}} | | {{documentation/{{documentation/version}}/module-section|Information for Developers}} |
| − | {{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}} | + | {{documentation/{{documentation/version}}/module-developerinfo}} |
| − | | |
| − | | |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | {{note}}The section above is generated using the following wiki code:
| |
| − | <pre>
| |
| − | {{documentation/{{documentation/version}}/module-section|Information for Developers}}
| |
| − | {{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
| |
| − | </pre>
| |
| − | | |
| − | 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:<pre>{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</pre>
| |
| − | | |
| − | If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
| |
| − | | |
| − | Using this later template, the final syntax would be:
| |
| − | <pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| − | <!-- ----------------------------------------------------------------- -->
| |
| | | | |
| | | | |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
| − | {{documentation/{{documentation/version}}/module-footer|category=Example}} | + | {{documentation/{{documentation/version}}/module-footer}} |
| | <!-- ---------------------------- --> | | <!-- ---------------------------- --> |
