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

From Slicer Wiki
Jump to: navigation, search
Line 18: Line 18:
 
{{module:documentation:section|Module Description}}
 
{{module:documentation: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 [[Module:EndUserDocumentationTemplate-4.0#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 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>
 +
 +
Using this later template, the final syntax would be:
 +
<pre>{{module:cli:generaldescription|xmlurl={{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}} }}</pre>
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 21:42, 24 August 2011

Home < Documentation < 4.0 < Modules < YOURMODULENAME

Template:Module:documentation:header

Template:Module:documentation:section Template: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:Module:contact

Template:Module:introduction-logo Template:Module:introduction-logo Template:Module:introduction-end

Template:Module:documentation: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:

{{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:

{{module:cli:xmlurl|<YOURMODULENAME>|<SVNREVISION>}}

Using this later template, the final syntax would be:

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

Template:Module:documentation:section Most frequently used for these scenarios:

  • Use Case 1:
  • Use Case 2:

Template:Module:documentation:section Links to tutorials that use this module

Template:Module:documentation: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:Module:documentation:section

  • Point to other modules that have similar functionality

Template:Module:documentation: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:Module:documentation:section Template:Module:developerinfo