UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T08:04:11Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

JChris.FillionR: 4.1 -> Nightly

2012-08-22T16:57:58Z

4.1 -> Nightly

New page

{{documentation/{{documentation/version}}/module-header}}



{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
{{documentation/{{documentation/version}}/module-introduction-row}}
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>
Author: Demian Wasserman, BWH<br>
Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email><br>
{{documentation/{{documentation/version}}/module-introduction-row}}
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
|Image:Logo-splnew.jpg|Surgical Planning Laboratory
|Image:Logo-namic.jpg|NA-MIC
}}
{{documentation/{{documentation/version}}/module-introduction-end}}


{{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 [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#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>{{documentation/{{documentation/version}}/module-description|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>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>

Using this later template, the final syntax would be:
<pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>





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

* Use Case 1:
* Use Case 2:


{{documentation/{{documentation/version}}/module-section|Tutorials}}
Links to tutorials that use this module


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

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


{{documentation/{{documentation/version}}/module-section|Similar Modules}}
* Point to other modules that have similar functionality


{{documentation/{{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/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}




{{note}}The section above is generated using the following wiki code:
<pre>
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
</pre>

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

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>

Using this later template, the final syntax would be:
<pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>





{{documentation/{{documentation/version}}/module-footer|category=Example}}

← Older revision		Revision as of 08:04, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	<!-- ---------------------------- -->		<!-- ---------------------------- -->
	{{documentation/{{documentation/version}}/module-header}}		{{documentation/{{documentation/version}}/module-header}}

Documentation/Nightly/TractographyFiducialSeeding - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

JChris.FillionR: 4.1 -> Nightly