Difference between revisions of "Modules:Editor-Documentation-3.6"

From Slicer Wiki
Jump to: navigation, search
(Created page with 'http://www.slicer.org/slicerWiki/index.php/Modules:Editor-Documentation')
 
Line 1: Line 1:
 
http://www.slicer.org/slicerWiki/index.php/Modules:Editor-Documentation
 
http://www.slicer.org/slicerWiki/index.php/Modules:Editor-Documentation
 +
 +
[[Documentation-3.6|Return to Slicer 3.6 Documentation]]
 +
 +
[[Announcements:Slicer3.6#Highlights|Gallery of New Features]]
 +
 +
__NOTOC__
 +
===Module Name===
 +
MyModule
 +
 +
{|
 +
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
 +
|[[Image:screenshotBlank.png|thumb|280px|Output]]
 +
|[[Image:screenshotBlank.png|thumb|280px|Caption]]
 +
|}
 +
 +
== General Information ==
 +
===Module Type & Category===
 +
 +
Type: Interactive Scripted
 +
 +
Category: Base
 +
 +
===Authors, Collaborators & Contact===
 +
* Author1: Affiliation & logo, if desired
 +
* Contributor1: Affiliation & logo, if desired
 +
* Contributor2: Affiliation & logo, if desired
 +
* Contact: name, email
 +
 +
===Module Description===
 +
Overview of what the module does goes here.
 +
 +
== Usage ==
 +
 +
===Use Cases, Examples===
 +
 +
This module is especially appropriate for these use cases:
 +
 +
* Use Case 1:
 +
* Use Case 2:
 +
 +
Examples of the module in use:
 +
 +
* Example 1
 +
* Example 2
 +
 +
===Tutorials===
 +
 +
Links to tutorials explaining how to use this module:
 +
 +
* Tutorial 1
 +
** Data Set 1
 +
 +
===Quick Tour of Features and Use===
 +
 +
A list panels in the interface, their features, what they mean, and how to use them. For instance:
 +
 +
{|
 +
|
 +
* '''Input panel:'''
 +
** '''First input'''
 +
** '''Second input'''
 +
* '''Parameters panel:'''
 +
** '''First parameter'''
 +
** '''Second parameter'''
 +
* '''Output panel:'''
 +
** '''First output'''
 +
** '''Second output'''
 +
* '''Viewing panel:'''
 +
|[[Image:screenshotBlankNotOptional.png|thumb|280px|User Interface]]
 +
|}
 +
 +
== Development ==
 +
 +
===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://www.cdash.org/CDash/index.php?project=Slicer3 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]
 +
 +
===Known bugs===
 +
 +
Links to known bugs in the Slicer3 bug tracker
 +
 +
* [http://www.na-mic.org/Bug/view.php?id=000 Bug 000: description]
 +
 +
 +
===Usability issues===
 +
 +
Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker. Please select the '''usability issue category''' when browsing or contributing.
 +
 +
===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]
 +
 +
== More Information ==
 +
 +
===Acknowledgment===
 +
Include funding and other support here.
 +
 +
===References===
 +
Publications related to this module go here. Links to pdfs would be useful.

Revision as of 16:36, 30 April 2010

Home < Modules:Editor-Documentation-3.6

http://www.slicer.org/slicerWiki/index.php/Modules:Editor-Documentation

Return to Slicer 3.6 Documentation

Gallery of New Features


Module Name

MyModule

User Interface
Output
Caption

General Information

Module Type & Category

Type: Interactive Scripted

Category: Base

Authors, Collaborators & Contact

  • Author1: Affiliation & logo, if desired
  • Contributor1: Affiliation & logo, if desired
  • Contributor2: Affiliation & logo, if desired
  • Contact: name, email

Module Description

Overview of what the module does goes here.

Usage

Use Cases, Examples

This module is especially appropriate for these use cases:

  • Use Case 1:
  • Use Case 2:

Examples of the module in use:

  • Example 1
  • Example 2

Tutorials

Links to tutorials explaining how to use this module:

  • Tutorial 1
    • Data Set 1

Quick Tour of Features and Use

A list panels in the interface, their features, what they mean, and how to use them. For instance:

  • Input panel:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
User Interface

Development

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 Dashboard, these tests verify that the module is working on various platforms:

Known bugs

Links to known bugs in the Slicer3 bug tracker


Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

Source code & documentation

Links to the module's source code:

Source code:

Doxygen documentation:

More Information

Acknowledgment

Include funding and other support here.

References

Publications related to this module go here. Links to pdfs would be useful.

Retrieved from "https://www.slicer.org/w/index.php?title=Modules:Editor-Documentation-3.6&oldid=14994"