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

From Slicer Wiki
Jump to: navigation, search
Line 15: Line 15:
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
  
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 +
<!-- ----------------------------------------------------------------- -->
 
{{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/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}}|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>
Line 28: Line 31:
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
</pre>
 
</pre>
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- ----------------------------------------------------------------- -->
 +
 +
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 33: Line 41:
 
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.
 
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.
  
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE 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-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-cli-description|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
  
Line 40: Line 51:
 
Using this later template, the final syntax would be:
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
<pre>{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- ----------------------------------------------------------------- -->
 +
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 101: Line 116:
  
  
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 +
<!-- ----------------------------------------------------------------- -->
 
{{note}}The section above is generated using the following wiki code:
 
{{note}}The section above is generated using the following wiki code:
 
<pre>
 
<pre>
Line 114: Line 132:
 
Using this later template, the final syntax would be:
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
<pre>{{documentation/{{documentation/version}}/module-cli-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- ----------------------------------------------------------------- -->
 +
<!-- ----------------------------------------------------------------- -->
  
  

Revision as of 19:26, 25 August 2011

Home < Documentation < 4.0 < Modules < YOURMODULENAME


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: Template:Documentation/4.0/contact
Template:Documentation/4.0/module-introduction-logoTemplate:Documentation/4.0/module-introduction-logo

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

{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}|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}}


Module Description

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/{{documentation/version}}/module-cli-description|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|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be: 

{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}


Use Cases

Most frequently used for these scenarios:

  • Use Case 1:
  • Use Case 2:

Tutorials

Links to tutorials that use this module

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:

  • 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

Similar Modules

  • Point to other modules that have similar functionality

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

Information for Developers

Work in progress
 Section under construction.


Note 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}}

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:

{{documentation/{{documentation/version}}/module-cli-category|xmlurl=http://path/to/YOURMODULENAME.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|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be: 

{{documentation/{{documentation/version}}/module-cli-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}


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