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

From Slicer Wiki
Jump to: navigation, search
Line 1: Line 1:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:header}}
+
{{documentation:4.0:module:header}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Introduction and Acknowledgements}}
+
{{documentation:4.0:module:section|Introduction and Acknowledgements}}
−
{{module:introduction-start|<Put the name of the module here>|image=screenshotBlankNotOptional.png}}
+
{{documentation:4.0: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: {{module:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
+
* Contact: {{documentation:4.0:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
−
{{module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+
{{documentation:4.0: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}}
+
{{documentation:4.0:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
−
{{module:introduction-end}}
+
{{documentation:4.0: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>
−
{{module:documentation:section|Introduction and Acknowledgements}}
+
{{documentation:4.0:module:section|Introduction and Acknowledgements}}
−
{{module:introduction-start|<Put the name of the module here>|image=screenshotBlankNotOptional.png}}
+
{{documentation:4.0: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: {{module:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
+
* Contact: {{documentation:4.0:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
−
{{module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+
{{documentation:4.0: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}}
+
{{documentation:4.0:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
−
{{module:introduction-end}}
+
{{documentation:4.0:module:introduction-end}}
 
</pre>
 
</pre>
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Module Description}}
+
{{documentation:4.0: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.
+
Here comes a description what the module is good for. Explain briefly how it works and point to the [[Documentation/4.0/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>{{module:cli:generaldescription|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:4.0: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>{{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}}</pre>
+
<pre>{{documentation:4.0: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>{{module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}</pre>
+
<pre>{{documentation:4.0:module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}</pre>
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Use Cases}}
+
{{documentation:4.0:module:section|Use Cases}}
 
Most frequently used for these scenarios:
 
Most frequently used for these scenarios:
  
Line 49: Line 49:
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Tutorials}}
+
{{documentation:4.0:module:section|Tutorials}}
 
Links to tutorials that use this module
 
Links to tutorials that use this module
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Panels and their use}}
+
{{documentation:4.0: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:
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Similar Modules}}
+
{{documentation:4.0:module:section|Similar Modules}}
 
* Point to other modules that have similar functionality
 
* Point to other modules that have similar functionality
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|References}}
+
{{documentation:4.0: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
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{module:documentation:section|Information for Developers}}
+
{{documentation:4.0:module:section|Information for Developers}}
−
{{module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+
{{documentation:4.0: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>
−
{{module:documentation:section|Information for Developers}}
+
{{documentation:4.0:module:section|Information for Developers}}
−
{{module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+
{{documentation:4.0:module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}
 
</pre>
 
</pre>
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
−
{{documentation/4.0/module/footer}}
+
{{documentation:4.0:module:footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 03:07, 25 August 2011

Home < Documentation < 4.0 < Modules < YOURMODULENAME

Template:Documentation:4.0:module:header

Template:Documentation:4.0:module:section Template:Documentation:4.0: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:Documentation:4.0:contact

Template:Documentation:4.0:module:introduction-logo Template:Documentation:4.0:module:introduction-logo Template:Documentation:4.0:module:introduction-end

Note The section above is generated using the following wiki code: 

{{documentation:4.0:module:section|Introduction and Acknowledgements}}
{{documentation:4.0: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:4.0:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
{{documentation:4.0:module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
{{documentation:4.0:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
{{documentation:4.0:module:introduction-end}}

Template:Documentation:4.0:module: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:

{{documentation:4.0: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:4.0:module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}}

Using this later template, the final syntax would be: 

{{documentation:4.0:module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}

Template:Documentation:4.0:module:section Most frequently used for these scenarios:

  • Use Case 1:
  • Use Case 2:

Template:Documentation:4.0:module:section Links to tutorials that use this module

Template:Documentation:4.0:module:section

A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:

  • Input panel1:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 1
  • Input panel2:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 2

Template:Documentation:4.0:module:section

  • Point to other modules that have similar functionality

Template:Documentation:4.0:module: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:Documentation:4.0:module:section Template:Documentation:4.0:module:developerinfo


Note The section above is generated using the following wiki code: 

{{documentation:4.0:module:section|Information for Developers}}
{{documentation:4.0:module:developerinfo|ModuleTemplate|type=Interactive|category=Example}}

Template:Documentation:4.0:module:footer

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