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

From Slicer Wiki
Jump to: navigation, search
Line 29: Line 29:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{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/YOURMODULENAME#References|references]] giving more details on the algorithm.
+
{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|ImageReadDicomWrite|17347}} }}
 
 
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 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|YOURMODULENAME|SVNREVISION}}</pre>
 
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}} }}</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 52: Line 44:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
+
{{documentation/{{documentation/version}}/module-cli-parametersdescription|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|ImageReadDicomWrite|17347}} }}
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]]
 
|}
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 96: Line 57:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+
{{documentation/{{documentation/version}}/module-developerinfo|ImageReadDicomWrite|type=CLI|category=
 
+
  {{documentation/{{documentation/version}}/module-cli-category|xmlurl=
 
+
    {{documentation/{{documentation/version}}/module-cli-xmlurl|ImageReadDicomWrite|17347}}
{{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-cli-category|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|YOURMODULENAME|SVNREVISION}}</pre>
 
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}} }}</pre>
 
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{documentation/{{documentation/version}}/module-footer|category=
 +
  {{documentation/{{documentation/version}}/module-cli-category|xmlurl=
 +
    {{documentation/{{documentation/version}}/module-cli-xmlurl|ImageReadDicomWrite|17347}}
 +
  }}
 +
}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 19:05, 25 August 2011

Home < Documentation < 4.0 < Modules < CreateDICOMSeries


Introduction and Acknowledgements

Template:Documentation/4.0/module-introduction-logoTemplate:Documentation/4.0/module-introduction-logo

Note The section above is generated using the following wiki code:

{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
{{documentation/{{documentation/version}}/module-introduction-start|<Put the name of the module here>|image=screenshotBlankNotOptional.png}}
* 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: {{documentation/{{documentation/version}}/contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
{{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}}
{{documentation/{{documentation/version}}/module-introduction-end}}

Module Description

Template:Documentation/4.0/module-cli-description

Use Cases

Most frequently used for these scenarios:

  • Use Case 1:
  • Use Case 2:

Tutorials

Links to tutorials that use this module

Panels and their use

Template:Documentation/4.0/module-cli-parametersdescription

Similar Modules

  • Point to other modules that have similar functionality

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

Information for Developers