Documentation/4.0/Modules/YOURMODULENAME - Revision history

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

2013-06-14T07:28:50Z

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

JChris.FillionR at 12:32, 2 February 2012

2012-02-02T12:32:13Z

JChris.FillionR at 12:30, 2 February 2012

2012-02-02T12:30:37Z

Finetjul: Use template for logos

2012-01-30T20:28:45Z

Use template for logos

JChris.FillionR at 21:18, 20 October 2011

2011-10-20T21:18:21Z

JChris.FillionR at 20:49, 20 October 2011

2011-10-20T20:49:27Z

JChris.FillionR at 19:33, 25 August 2011

2011-08-25T19:33:24Z

JChris.FillionR at 19:30, 25 August 2011

2011-08-25T19:30:44Z

JChris.FillionR at 19:27, 25 August 2011

2011-08-25T19:27:16Z

JChris.FillionR at 19:26, 25 August 2011

2011-08-25T19:26:29Z

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

@@ Line 41: / Line 41: @@
 {{documentation/{{documentation/version}}/module-section|Panels and their use}}
 N/A
 <!-- ---------------------------- -->

@@ Line 18: / Line 18: @@
 }}
 {{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}}
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Use Cases}}
-Most frequently used for these scenarios:
+N/A
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Tutorials}}
-Links to tutorials that use this module
+N/A
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Panels and their use}}
+N/A
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Similar Modules}}
-* Point to other modules that have similar functionality
+N/A
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|References}}
-Publications related to this module go here. Links to pdfs would be useful.
+N/A
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Information for Developers}}
-{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+{{documentation/{{documentation/version}}/module-developerinfo}}
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-footer|category=Example}}
+{{documentation/{{documentation/version}}/module-footer}}
 <!-- ---------------------------- -->

@@ Line 14: / Line 14: @@
 {{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-logo-gallery
-|Image:Logo-isomics.png|Isomics, Inc. <- Replace this logo with yours
+|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}} <- Replace this logo with yours
-|Image:Logo-splnew.jpg|Surgical Planning Laboratory   <-Replace this logo with yours
+|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}   <-Replace this logo with yours
 }}
 {{documentation/{{documentation/version}}/module-introduction-end}}
@@ Line 34: / Line 34: @@
 {{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-logo-gallery
-|Image:Logo-isomics.png|Isomics, Inc. <- Replace this logo with yours
+|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}} <- Replace this logo with yours
-|Image:Logo-splnew.jpg|Surgical Planning Laboratory   <-Replace this logo with yours
+|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}   <-Replace this logo with yours
 }}
 {{documentation/{{documentation/version}}/module-introduction-end}}

@@ Line 52: / Line 52: @@
 <!-- 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-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:
@@ Line 58: / Line 58: @@
 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-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 <!-- ----------------------------------------------------------------- -->
 <!-- ----------------------------------------------------------------- -->
@@ Line 133: / Line 133: @@
 </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-cli-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</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:
@@ Line 139: / Line 139: @@
 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-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 <!-- ----------------------------------------------------------------- -->
 <!-- ----------------------------------------------------------------- -->

@@ Line 5: / Line 5: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
-{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}|image=screenshotBlankNotOptional.png}}
+{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
-* 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].
+{{documentation/{{documentation/version}}/module-introduction-row}}
-* Author: FIRSTNAME LASTNAME, AFFILIATION
+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>
-* Contributor1: FIRSTNAME LASTNAME, AFFILIATION
+Author: FIRSTNAME LASTNAME, AFFILIATION<br>
-* Contributor2: FIRSTNAME LASTNAME, AFFILIATION
+Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
-* Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email>
+Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
-{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
-{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
+{{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-end}}
@@ Line 21: / Line 25: @@
 <pre>
 {{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
-{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}|image=screenshotBlankNotOptional.png}}
+{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
-* 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].
+{{documentation/{{documentation/version}}/module-introduction-row}}
-* Author: FIRSTNAME LASTNAME, AFFILIATION
+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>
-* Contributor1: FIRSTNAME LASTNAME, AFFILIATION
+Author: FIRSTNAME LASTNAME, AFFILIATION<br>
-* Contributor2: FIRSTNAME LASTNAME, AFFILIATION
+Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
-* Contact: {{documentation/{{documentation/version}}/contact|name=FIRSTNAME LASTNAME|email=EmailIsRequired}}
+Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
-{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
-{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
+{{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-end}}
 </pre>

@@ Line 10: / Line 10: @@
 * Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
 * Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
-* Contact: {{documentation/{{documentation/version}}/contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
+* Contact: <FIRSTNAME> <LASTNAME>, <email>john@doe.org</email>
 {{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}}