Documentation/4.0

Modules

• Please copy the template linked below, paste it into your page and customize it with your module's information.

Slicer3:Module_Documentation-3.7_Template

• See Requirements for Modules for info to be put into the Help and Acknowledgment Tabs
• To put your lab's logo into a module, see here

Please adhere to the naming scheme for the module documentation:

• [ [Modules:MyModuleNameNoSpaces-Documentation-3.7|My Module Name With Spaces] ] (First Last Name)

• You can use the following python script to automatically generate some of the wiki documentation from your module's .xml file: SEMToMediaWiki.py

Requirements for Modules

The module is feature complete, it does everything that it advertises it can do The module has a test. See here for more information. Module has documentation on the Slicer wiki. Please use the template provided here to structure your page. Please keep in mind that our users are not computer scientists with a background in computer vision. Please add a pointer to the documentation on the Slicer wiki to the the Help tab of the module. See the Editor module in Slicer for an example. The contributor (and their manager/advisor), the lab (with labs/institution logo) and the funding source (with grant number, logo optional) are listed in the Acknowledegment tab of the module. Please see the Models module for an example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module. See here for more information. Style Guide: All acknowledgment icons should be 100x100 pixels, preferably in png format. Accessing logos: Icons for BIRN, NAC, NA-MIC and IGT are included in Slicer3/Base/GUI//vtkSlicerBaseAcknowledgementLogoIcons.cxx/h and resources for them are in Slicer3/Base/GUI/Resources/vtkSlicerBaseAcknowledgementLogos_ImageData.h. The API for vtkSlicerModuleGUI provides access to these icons. Adding logos: Please add additional image resources and logo icons to these files as required in order to promote shared use (and to prevent duplication in the code.) Many modules are better suited to be downloadable extensions. The same module creation guidelines apply, but the actual implementation is done outside of the slicer source code repository. Follow Ron's rules for tools

Examples for the Help and Acknowledgment Panels

Please adhere to the naming scheme for the module documentation:

• [[Modules:MyModuleNameNoSpaces-Documentation-3.7|My Module Name With Spaces] ] (First Last Name)

Documentation Draft notes

Key for flagged modules below:

: No 3.7 Documentation

: Missing or stale link to 3.7 Documentation from Help Panel in software module. If you're not sure how/where to add the link and module description:

• for command line modules, see other xml files (such as that for the GradientAnisotropicDiffusion Module) for an example of how to add documentation and links to wiki help.
• for interactive modules, see other modules in Base/GUI for an example.

: Weak or Incomplete 3.7 Documentation