Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"
Line 1: | Line 1: | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module:documentation:header}} | + | {{module:documentation:header|version=4.0}} |
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
Line 108: | Line 108: | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
− | {{module:documentation:footer}} | + | {{module:documentation:footer|version=4.0}} |
<!-- ---------------------------- --> | <!-- ---------------------------- --> |
Revision as of 23:05, 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.
- Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
- Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
- Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
- Contact: Template:Module:contact
Template:Module:introduction-logo Template:Module:introduction-logo Template:Module:introduction-end
The section above is generated using the following wiki code:
{{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]. * Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION> * Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION> * Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION> * Contact: {{module:contact|name=<FIRSTNAME> <LASTNAME>|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}}
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.
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:
{{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:
{{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}}
Using this later template, the final syntax would be:
{{module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}
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
The section above is generated using the following wiki code:
{{module:documentation:section|Information for Developers}} {{module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}