Difference between revisions of "Documentation/3.4"

From Slicer Wiki
Jump to: navigation, search
Line 18: Line 18:
 
** Module has documentation on the [[Documentation-3.4#Modules|Slicer wiki]]. Please use the template provided [[Documentation-3.4#Modules|here]] to structure your page.  
 
** Module has documentation on the [[Documentation-3.4#Modules|Slicer wiki]]. Please use the template provided [[Documentation-3.4#Modules|here]] to structure your page.  
 
**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.
 
**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, lab and funding source) are listed in the Acknowledgement tab of the module. Please see the '''Models module''' for and example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module.
+
** 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 Acknowledgement tab of the module. Please see the '''Models module''' for and example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module.
 
* If your module has [[Documentation-3.2|documentation in Slicer 3.2]], please copy/paste/update into the 3.4 version
 
* If your module has [[Documentation-3.2|documentation in Slicer 3.2]], please copy/paste/update into the 3.4 version
  

Revision as of 13:19, 5 February 2009

Home < Documentation < 3.4

Note: This page is currently under construction

Introduction

This page is a portal for documentation about Slicer 3.4. For information for software developers, please go to the Developers page (see link in navigation box to the left).

How-To Tutorials

Slicer3 tutorial page

Feature Request and Problem Reports

We have an issues tracker for Slicer 3. You need to create an account for filing reports. We keep track of both feature requests and bug reports. Make sure to use the pull-down in the upper right to select Slicer 3.

List of Modules in need of documentation

  • Requirements for modules to be added to the release:
    • The module is feature complete for the tasks advertised on 2-4-2009
    • 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 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 Acknowledgement tab of the module. Please see the Models module for and example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module.
  • If your module has documentation in Slicer 3.2, please copy/paste/update into the 3.4 version

Main GUI

Modules

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

Slicer3:Module_Documentation-3.4_Template

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

Core and Loadable Modules

CLI Modules

Documented Modules

Main GUI

Modules

Core and Loadable Modules

CLI Modules

Modules on NITRC

Slicer on NITRC

We are using NITRC as a repository for contributed modules. As a general rule, we do not test them ourselves, it is the downloaders job to ensure that they do what they want them to do.

Click here to see a listing of Slicer 3 modules on NITRC.

This is how to get modules from NITRC into Slicer 3.4