Documentation/4.0/Modules/YOURMODULENAME

From Slicer Wiki
Revision as of 03:13, 25 August 2011 by JChris.FillionR (talk | contribs)
Jump to: navigation, search
Home < Documentation < 4.0 < Modules < YOURMODULENAME

{{documentation:Template:Documentation:version:module:header}}

{{documentation:Template:Documentation:version:module:section|Introduction and Acknowledgements}} {{documentation:Template: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 NA-MIC website.
  • Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
  • Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
  • Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
  • Contact: {{documentation:Template:Documentation:version:contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}

{{documentation:Template:Documentation:version:module:introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}} {{documentation:Template:Documentation:version:module:introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}} {{documentation:Template:Documentation:version:module:introduction-end}}

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

{{documentation:Template: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/Template:Documentation:version/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:

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

Using this later template, the final syntax would be: 

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

{{documentation:Template:Documentation:version:module:section|Use Cases}} Most frequently used for these scenarios:

  • Use Case 1:
  • Use Case 2:

{{documentation:Template:Documentation:version:module:section|Tutorials}} Links to tutorials that use this module

{{documentation:Template:Documentation:version: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:

  • 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

{{documentation:Template:Documentation:version:module:section|Similar Modules}}

  • Point to other modules that have similar functionality

{{documentation:Template:Documentation:version:module:section|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

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


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

{{documentation:Template:Documentation:version:module:footer}}

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