Documentation/4.0/Modules/Annotations - Revision history

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

2013-06-14T07:33:40Z

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

Pkarasev: spent a very long time trying to figure out how to add fiducials, docs didn't have an "idiot's quickstart guide" so I added screenshots.

2012-09-20T18:11:47Z

spent a very long time trying to figure out how to add fiducials, docs didn't have an "idiot's quickstart guide" so I added screenshots.

JChris.FillionR at 11:40, 2 February 2012

2012-02-02T11:40:50Z

JChris.FillionR at 09:18, 2 February 2012

2012-02-02T09:18:58Z

Finetjul: Use template for logos

2012-01-30T20:31:57Z

Use template for logos

Nicole at 00:22, 26 November 2011

2011-11-26T00:22:18Z

Marianna at 20:47, 11 November 2011

2011-11-11T20:47:31Z

Marianna at 20:37, 11 November 2011

2011-11-11T20:37:30Z

Marianna: Created page with ' {{documentation/{{documentation/version}}/module-header}} {{doc…'

2011-11-02T17:54:40Z

Created page with ' {{documentation/{{documentation/version}}/module-header}}   {{doc…'

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]. 
Author: Author: Nicole Aucoin, BWH 
Contributor1: FIRSTNAME LASTNAME, AFFILIATION 
Contributor2: FIRSTNAME LASTNAME, AFFILIATION 
Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email> 
{{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}}




{{note}}The section above is generated using the following wiki code:
<pre>
{{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]. 
Author: FIRSTNAME LASTNAME, AFFILIATION 
Contributor1: FIRSTNAME LASTNAME, AFFILIATION 
Contributor2: FIRSTNAME LASTNAME, AFFILIATION 
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email> 
{{documentation/{{documentation/version}}/module-introduction-row}}
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
|Image:Logo-isomics.png|Isomics, Inc. <- Replace this logo with yours
|Image:Logo-splnew.jpg|Surgical Planning Laboratory <-Replace this logo with yours
}}
{{documentation/{{documentation/version}}/module-introduction-end}}
</pre>





{{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 07:33, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	<!-- ---------------------------- -->		<!-- ---------------------------- -->
	{{documentation/{{documentation/version}}/module-header}}		{{documentation/{{documentation/version}}/module-header}}

@@ Line 34: / Line 34: @@
 * Use Case 3: using rulers to measure tumor diameters
 * Use Case 4: using ROIs to crop volume rendering
 <!-- ---------------------------- -->

@@ Line 24: / Line 24: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Module Description}}
 {{documentation/{{documentation/version}}/module-description}}
 <!-- ---------------------------- -->
@@ Line 51: / Line 49: @@
 |[[Image:Slicer4-Annotations-Toolbar.jpeg|thumb|200px|Annotation tool bar]]
 |}
-{{documentation/{{documentation/version}}/module-parametersdescription|xmlurl={{documentation/{{documentation/version}}/module-qtloadable-xmlurl|{{documentation/modulename}}|18772}} }}
+{{documentation/{{documentation/version}}/module-parametersdescription}}
@@ Line 63: / Line 61: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Information for Developers}}
-{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Core}}
+{{documentation/{{documentation/version}}/module-developerinfo}}
 <!-- ---------------------------- -->
-{{documentation/{{documentation/version}}/module-footer|category=Example}}
+{{documentation/{{documentation/version}}/module-footer}}
 <!-- ---------------------------- -->

@@ Line 16: / Line 16: @@
 {{documentation/{{documentation/version}}/module-introduction-row}}
 {{documentation/{{documentation/version}}/module-introduction-logo-gallery
-|Image:Logo-splnew.jpg|Surgical Planning Laboratory
+|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}
-|Image:NAMIC 380x463.jpg|NA-MIC
+|{{collaborator|logo|namic}}|{{collaborator|longname|namic}}
-|Image:NAC-logo.png|NAC
+|{{collaborator|logo|nac}}|{{collaborator|longname|nac}}
 }}
 {{documentation/{{documentation/version}}/module-introduction-end}}

@@ Line 8: / Line 8: @@
 {{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: Nicole Aucoin, BWH<br>
+Author: Nicole Aucoin, SPL<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:NAMIC 380x463.jpg|NA-MIC
 |Image:NAC-logo.png|NAC

@@ Line 8: / Line 8: @@
 {{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: Nicole Aucoin, SPL<br>
+Author: Nicole Aucoin, BWH<br>
 Contact: Nicole Aucoin, <email>nicole@bwh.harvard.edu</email><br>
 {{documentation/{{documentation/version}}/module-introduction-row}}
@@ Line 20: / Line 24: @@
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Module Description}}
 <!-- ---------------------------- -->
@@ Line 41: / Line 32: @@
 Most frequently used for these scenarios:
-* Use Case 1:
+* Use Case 1: placing fiducial markers at points of interest on images
-* Use Case 2:
+* Use Case 2: using fiducials to seed tractography
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Tutorials}}
 <!-- ---------------------------- -->
 {{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:
+A list of all the panels in the interface, their features, what they mean, and how to use them.
-{|style="width: 100%"
+{|
+|[[Image:Slicer4-Annotations-GUI.jpeg|thumb|200px|Annotations]]
-* Input panel1:
+|[[Image:Slicer4-Annotations-ModifyPropeties.jpeg|thumb|200px|Modify Annotation Properties]]
-** First input
+|[[Image:Slicer4-Annotations-ModifyHierarchy.jpeg|thumb|200px|Modify Hierarchy Properties]]
-** Second input
+|[[Image:Slicer4-Annotations-Toolbar.jpeg|thumb|200px|Annotation tool bar]]
 |}
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Similar Modules}}
-* Point to other modules that have similar functionality
+* The Annotations tool bar at the top of the main Slicer window is used to add new annotations to the scene.
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|References}}
 <!-- ---------------------------- -->
 {{documentation/{{documentation/version}}/module-section|Information for Developers}}
-{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Core}}