Documentation/4.0

Introduction

Slicer4 is moving towards release. This page contains both the guidelines and the dcoumentation for Slicer 4.0.

Requirements for Modules

• The module is feature complete, i.e. it does everything that it advertises
• The module has a test. See here for more information.
• The module is fully documented see below for more details
• The module complies with Rons rules for tool and the style guide lines, including color palette.

Main GUI

• Main Application GUI (xx)
• "Hot-keys" and Keyboard Shortcuts (xx)
• Loading Data (scenes, DICOM, volumes, models, fiducials, transforms, etc.) (xx)
• Saving Data (scenes, volumes, models, fiducials, transforms, etc.) (xx)
• Creating and Restoring Scene Snapshots (xx)
• Setting up and using stereoscopic viewing (Curt Lisle, xx)
• Extensions Management Wizard (xx)

Core Modules

• Annotations Module (xx)
• Color Module (xx)
• Data Module (xx)
• Interactive Editor (Steve Pieper)
• Sceneviews (xx)
• Slice Controls Module (x)
• Slicer Welcome Module (xx)
• Volume Rendering Module (xx)
• Volumes Module (xx)
• Transforms Module (xx)

Extensions

Introduction

• Slicer Extensions are the "on-ramp" to the Slicer "highway". They provide are a mechanism for anybody, including third parties, to provide modules which extend the functionality of 3d Slicer.
• Beginning with Slicer 4, the process for adding modules to slicer will begin with all modules as extensions. In order to become part of the main slicer distribution, extensions will have to be distributed under the slicer license, live up to the claims in the documentation, being stable on the supported platforms, well documented and supported.
• While the Slicer license is suggested for extensions, it is not required. Please review the documentation of the extension carefully.
• For a subset of extensions, you can use the extension wizard in Slicer to find their webpages and to install/uninstall individual extensions.
• In case of problems with extensions, please talk directly to the developers of the extensions.
• Information for developers can be found here.

Documentation Quality

Key for flagged modules below:

: No 4.0 Documentation

: Missing or stale link to 4.0 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 4.0 Documentation