Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"
Line 1: | Line 1: | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:header}} |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Introduction and Acknowledgements}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}: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]. | * 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]. | ||
* Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | * Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | ||
* Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | * Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | ||
* Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | * Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | ||
− | * Contact: {{documentation: | + | * Contact: {{documentation:{{documentation:version}}:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:introduction-end}} |
{{note}}The section above is generated using the following wiki code: | {{note}}The section above is generated using the following wiki code: | ||
<pre> | <pre> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Introduction and Acknowledgements}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}: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]. | * 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]. | ||
* Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | * Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | ||
* Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | * Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | ||
* Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | * Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION> | ||
− | * Contact: {{documentation: | + | * Contact: {{documentation:{{documentation:version}}:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:introduction-end}} |
</pre> | </pre> | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{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 [[Documentation/ | + | Here comes a description what the module is good for. Explain briefly how it works and point to the [[Documentation/{{documentation:version}}/Modules/YOURMODULENAME#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: | + | 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:cli:generaldescription|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: | If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL: | ||
− | <pre>{{documentation: | + | <pre>{{documentation:{{documentation:version}}:module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}}</pre> |
Using this later template, the final syntax would be: | Using this later template, the final syntax would be: | ||
− | <pre>{{documentation: | + | <pre>{{documentation:{{documentation:version}}:module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}</pre> |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Use Cases}} |
Most frequently used for these scenarios: | Most frequently used for these scenarios: | ||
Line 49: | Line 49: | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Tutorials}} |
Links to tutorials that use this module | Links to tutorials that use this module | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module: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 88: | Line 88: | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Similar Modules}} |
* Point to other modules that have similar functionality | * Point to other modules that have similar functionality | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module: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 | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Information for Developers}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:developerinfo|ModuleTemplate|type=Interactive|category=Example}} |
{{note}}The section above is generated using the following wiki code: | {{note}}The section above is generated using the following wiki code: | ||
<pre> | <pre> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:section|Information for Developers}} |
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:developerinfo|ModuleTemplate|type=Interactive|category=Example}} |
</pre> | </pre> | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{documentation: | + | {{documentation:{{documentation:version}}:module:footer}} |
<!-- ---------------------------- --> | <!-- ---------------------------- --> |
Revision as of 03:13, 25 August 2011
Home < Documentation < 4.0 < Modules < YOURMODULENAME{{documentation:Template:Documentation:version:module:header}}
{{documentation:Template:Documentation:version:module:section|Introduction and Acknowledgements}} {{documentation:Template:Documentation:version: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 NA-MIC website.
- Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
- Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
- Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
- Contact: {{documentation:Template:Documentation:version:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
{{documentation:Template:Documentation:version:module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}} {{documentation:Template:Documentation:version:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}} {{documentation:Template:Documentation:version:module:introduction-end}}
The section above is generated using the following wiki code:
{{documentation:{{documentation:version}}:module:section|Introduction and Acknowledgements}} {{documentation:{{documentation:version}}: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]. * Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION> * Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION> * Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION> * Contact: {{documentation:{{documentation:version}}:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}} {{documentation:{{documentation:version}}:module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}} {{documentation:{{documentation:version}}:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}} {{documentation:{{documentation:version}}:module:introduction-end}}
{{documentation:Template: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 [[Documentation/Template:Documentation:version/Modules/YOURMODULENAME#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:
{{documentation:{{documentation:version}}:module:cli:generaldescription|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|<YOURMODULENAME>|<SVNREVISION>}}
Using this later template, the final syntax would be:
{{documentation:{{documentation:version}}:module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}
{{documentation:Template:Documentation:version:module:section|Use Cases}} Most frequently used for these scenarios:
- Use Case 1:
- Use Case 2:
{{documentation:Template:Documentation:version:module:section|Tutorials}} Links to tutorials that use this module
{{documentation:Template:Documentation:version:module: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:
|
|
|
{{documentation:Template:Documentation:version:module:section|Similar Modules}}
- Point to other modules that have similar functionality
{{documentation:Template:Documentation:version:module:section|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
{{documentation:Template:Documentation:version:module:section|Information for Developers}} {{documentation:Template:Documentation:version:module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}
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}}
{{documentation:Template:Documentation:version:module:footer}}