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)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
*PAGENAME:{{PAGENAME}}
+
<noinclude>{{documentation/versioncheck}}</noinclude>
−
 
 
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:header|version=4.0}}
+
{{documentation/{{documentation/version}}/module-header}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Introduction and Acknowledgements}}
+
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
−
{{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: {{module:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
+
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
−
{{module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
−
{{module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
+
{{documentation/{{documentation/version}}/module-introduction-row}}
−
{{module:introduction-end}}
+
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
−
 
+
|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}} <- Replace this logo with yours
−
{{note}}The section above is generated using the following wiki code:
+
|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}  <-Replace this logo with yours
−
<pre>
+
}}
−
{{module:documentation:section|Introduction and Acknowledgements}}
+
{{documentation/{{documentation/version}}/module-introduction-end}}
−
{{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}}
 
−
</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation: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 [[Module:EndUserDocumentationTemplate-4.0#References|references]] giving more details on the algorithm.
+
N/A
−
 
+
<!--
−
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>{{module:cli:generaldescription|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
+
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 your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
+
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}}
−
<pre>{{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}}</pre>
 
  
−
Using this later template, the final syntax would be:
+
{{documentation/{{documentation/version}}/module-description}}
−
<pre>{{module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}</pre>
+
-->
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Use Cases}}
+
{{documentation/{{documentation/version}}/module-section|Use Cases}}
−
Most frequently used for these scenarios:
+
N/A
−
 
 
−
* Use Case 1:
 
−
* Use Case 2:
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Tutorials}}
+
{{documentation/{{documentation/version}}/module-section|Tutorials}}
−
Links to tutorials that use this module
+
N/A
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation: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]]
 
−
|}
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Similar Modules}}
+
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
−
* Point to other modules that have similar functionality
+
N/A
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation: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
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Information for Developers}}
+
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
−
{{module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+
{{documentation/{{documentation/version}}/module-developerinfo}}
−
 
 
  
−
{{note}}The section above is generated using the following wiki code:
 
−
<pre>
 
−
{{module:documentation:section|Information for Developers}}
 
−
{{module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}
 
−
</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:footer|version=4.0}}
+
{{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

Work in progress
 Section under construction.


Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.0/Modules/YOURMODULENAME&oldid=32368"