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

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(36 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
[[Documentation-4.0|Return to the Slicer 4.0 Documentation]]
+
<noinclude>{{documentation/versioncheck}}</noinclude>
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-header}}
 +
<!-- ---------------------------- -->
  
−
[[Announcements:Slicer4-alpha#Highlights|Gallery of New Features]]
+
<!-- ---------------------------- -->
 +
{{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: FIRSTNAME LASTNAME, AFFILIATION<br>
 +
Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
 +
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
 +
Contact: FIRSTNAME LASTNAME, <email>john@doe.org</email><br>
 +
{{documentation/{{documentation/version}}/module-introduction-row}}
 +
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 +
|{{collaborator|logo|isomics}}|{{collaborator|longname|isomics}} <- Replace this logo with yours
 +
|{{collaborator|logo|spl}}|{{collaborator|longname|spl}}  <-Replace this logo with yours
 +
}}
 +
{{documentation/{{documentation/version}}/module-introduction-end}}
  
−
__NOTOC__
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Module Description}}
 +
N/A
 +
<!--
 +
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.
  
−
=Introduction and Acknowledgements=
+
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}}
−
{|
 
−
|rowspan="2"|[[Image:screenshotBlankNotOptional.png|thumb|280px|MyModule: Put the name of the module here]]
 
−
|align="left" rowspan="2"|
 
−
* Author1: Steve Pieper, Isomics (replace this with your name and affiliation)
 
−
* Contributor1: Nicole Aucoin, Surgical Planning Laboratory, BWH, HMS  (replace this with your name and affiliation)
 
−
* Contributor2: Name, Affiliation
 
−
* Contact: name, email: '''This is required'''
 
−
|align="right"|[[image:Logo-isomics.png|150px|right|thumb|Replace this logo with yours]]
 
−
|-
 
−
|align="right"|[[image:Logo-splnew.jpg|150px|right|thumb|Replace this logo with yours]]
 
−
|-
 
−
|}
 
  
−
==Module Description==
+
{{documentation/{{documentation/version}}/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.
+
-->
  
 +
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 +
N/A
  
−
==Use Cases==
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 +
N/A
  
−
This module is especially appropriate for these use cases:
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 +
N/A
 +
<!--
 +
{{documentation/{{documentation/version}}/module-parametersdescription}}
 +
-->
  
−
* Use Case 1:
+
<!-- ---------------------------- -->
−
* Use Case 2:
+
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 +
N/A
  
−
Examples of the module in use:
+
<!-- ---------------------------- -->
 +
{{documentation/{{documentation/version}}/module-section|References}}
 +
N/A
  
−
* Example 1
+
<!-- ---------------------------- -->
−
* Example 2
+
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 +
{{documentation/{{documentation/version}}/module-developerinfo}}
  
−
==Tutorials==
 
−
Links to tutorials that use this module
 
  
−
==Panels and their use==
+
<!-- ---------------------------- -->
−
 
+
{{documentation/{{documentation/version}}/module-footer}}
−
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
+
<!-- ---------------------------- -->
−
 
 
−
{|style="width: 75%"
 
−
|
 
−
* 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]]
 
−
|}
 
−
 
 
−
==Similar Modules==
 
−
* Point to other modules that have similar functionality
 
−
 
 
−
==References==
 
−
Publications related to this module go here. Links to pdfs would be useful.
 
−
 
 
−
= Information for Developers =
 
−
===Module Type & Category===
 
−
 
 
−
Type: Interactive or CLI
 
−
 
 
−
Category: Base or (Filtering, Registration, ''etc.'')
 
−
===Notes from the Developer(s)===
 
−
 
 
−
Algorithms used, library classes depended upon, use cases, etc.
 
−
 
 
−
===Dependencies===
 
−
 
 
−
Other modules or packages that are required for this module's use.
 
−
 
 
−
===Tests===
 
−
 
 
−
On the [http://cdash.org/slicer4 Slicer4 Dashboard], these tests verify that the module is working on various platforms:
 
−
 
 
−
* MyModuleTest1 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest1.cxx]
 
−
* MyModuleTest2 [http://viewvc.slicer.org/viewcvs.cgi/trunk MyModuleTest2.cxx]
 
−
 
 
−
===Source code & documentation===
 
−
 
 
−
Links to the module's source code:
 
−
 
 
−
Source code:
 
−
*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.cxx ]
 
−
*[http://viewvc.slicer.org/viewcvs.cgi/trunk file.h ]
 
−
 
−
Doxygen documentation:
 
−
*[http://www.na-mic.org/Slicer/Documentation/Slicer3-doc/html/classes.html class1]
 

Latest revision as of 07:28, 14 June 2013

Home < Documentation < 4.0 < Modules < YOURMODULENAME


For the latest Slicer documentation, visit the read-the-docs.



Introduction and Acknowledgements

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: FIRSTNAME LASTNAME, <email>john@doe.org</email>

Isomics, Inc. <- Replace this logo with yours  
Surgical Planning Laboratory (SPL) <-Replace this logo with yours  

Module Description

N/A

Use Cases

N/A

Tutorials

N/A

Panels and their use

N/A

Similar Modules

N/A

References

N/A

Information for Developers

Work in progress
 Section under construction.


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