Difference between revisions of "Documentation/4.0/Modules/YOURMODULENAME"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 5: Line 6:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
{{documentation/{{documentation/version}}/module-introduction-start|<Put the name of the module here>|image=screenshotBlankNotOptional.png}}
+
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
* 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].
+
{{documentation/{{documentation/version}}/module-introduction-row}}
* Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
+
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>
* Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
+
Author: FIRSTNAME LASTNAME, AFFILIATION<br>
* Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
+
Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
* Contact: {{documentation/{{documentation/version}}/contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
+
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
+
{{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}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{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|<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}}
 
</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{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/{{documentation/version}}/Modules/YOURMODULENAME#References|references]] giving more details on the algorithm.
+
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-cli-description|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
+
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}}
  
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
+
{{documentation/{{documentation/version}}/module-description}}
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}}</pre>
+
-->
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}} }}</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{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:
+
<!--
 
+
{{documentation/{{documentation/version}}/module-parametersdescription}}
{|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}}
 
 
 
 
{{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-cli-category|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|YOURMODULENAME|SVNREVISION}}</pre>
 
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}} }}</pre>
 
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{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.
Author: FIRSTNAME LASTNAME, AFFILIATION
Contributor1: FIRSTNAME LASTNAME, AFFILIATION
Contributor2: FIRSTNAME LASTNAME, AFFILIATION
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email>

Isomics, Inc. <- Replace this logo with yours  
Surgical Planning Laboratory (SPL) <-Replace this logo with yours  

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