Difference between revisions of "Documentation/4.0/Modules/EMSegment Command-line"
Line 24: | Line 24: | ||
{{documentation/{{documentation/version}}/module-description|http://viewvc.slicer.org/viewvc.cgi/Slicer3/trunk/Modules/EMSegment/CommandLineApplication/EMSegmentCommandLine.xml?revision=16914&view=co}} | {{documentation/{{documentation/version}}/module-description|http://viewvc.slicer.org/viewvc.cgi/Slicer3/trunk/Modules/EMSegment/CommandLineApplication/EMSegmentCommandLine.xml?revision=16914&view=co}} | ||
− | {{documentation/{{documentation/version}}/module-cli-xmlurl|http://viewvc.slicer.org/viewvc.cgi/Slicer3/trunk/Modules/EMSegment/CommandLineApplication/EMSegmentCommandLine.xml?revision=16914&view=co}} | + | <!--- {{documentation/{{documentation/version}}/module-cli-xmlurl|http://viewvc.slicer.org/viewvc.cgi/Slicer3/trunk/Modules/EMSegment/CommandLineApplication/EMSegmentCommandLine.xml?revision=16914&view=co}} --> |
<!-- ----------------------------------------------------------------- --> | <!-- ----------------------------------------------------------------- --> |
Revision as of 00:38, 29 November 2011
Home < Documentation < 4.0 < Modules < EMSegment Command-line
Introduction and Acknowledgements
This work was funded by the ARRA Supplement to the Neuroimage Analysis Center (NAC), funded by the National Institutes of Health. Information on NAC can be obtained from the NAC website. | |||||
|
Module Description
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:
{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}
Using this later template, the final syntax would be:
{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}
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
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
|
|
|
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
Section under construction. |
The section above is generated using the following wiki code:
{{documentation/{{documentation/version}}/module-section|Information for Developers}} {{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
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:
{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}
Using this later template, the final syntax would be:
{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}