Difference between revisions of "Documentation/4.0"

From Slicer Wiki
Jump to: navigation, search
Line 3: Line 3:
  
 
Slicer4 is moving towards release. This page contains both the guidelines and the documentation for Slicer {{documentation/version}}.
 
Slicer4 is moving towards release. This page contains both the guidelines and the documentation for Slicer {{documentation/version}}.
 +
 +
 +
== Documentation ==
 +
{| border="0" align="center" width="98%" valign="top" cellspacing="7" cellpadding="2"
 +
|-
 +
! width="33%"|
 +
! |
 +
! width="33%"|
 +
! |
 +
! width="33%"|
 +
|-
 +
|valign="top"|
 +
 +
===Compile/Install===
 +
----
 +
<!--
 +
* [[VolView4/Git| Git Instructions]]
 +
: Git is the revision control system that VolView4 uses. If you would like to have the bleeding edge version of VolView4, or you would like to contribute code, this link describes the method you must use to get the code.
 +
-->
 +
* [[VolView4:Build And Install|Building and Installation instructions]]
 +
: Compiling and installing VolView4 from source.
 +
 +
===Mailing List===
 +
----
 +
:The developers mailing list is here: ???
 +
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
 +
===Design & Implementation===
 +
----
 +
* [[Object model]]
 +
: Objects and their organization
 +
 +
 +
|bgcolor="#CCCCCC"|
 +
|valign="top"|
 +
 +
===Miscellaneous===
 +
----
 +
* [[Documentation/{{documentation/version}}/ImageGallery Image gallery]]
 +
: Set of screenshots showing Slicer4 in action.
 +
 +
* [[Documentation/{{documentation/version}}/Sandbox MediaWiki Extension test]]
 +
: This page serves as a MediaWiki sandbox
 +
 +
<!--
 +
* [[Documents and links]]
 +
: Set of presentations made on Slicer4 and document talking about it.
 +
 +
* [[FAQ]]
 +
: Set of common questions/answer on Slicer4 goal and possibility
 +
-->
 +
 +
===Developers Corner===
 +
----
 +
====Mailing List====
 +
The developers mailing list is here: http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel
 +
This should be used for questions about modifying the Paraview code, not using Paraview.
 +
 +
====Handy Developer Info====
 +
* [[Documentation/{{documentation/version}}/Developers | Developer Information]]
 +
 +
|}
 +
  
 
=Requirements for Modules=
 
=Requirements for Modules=

Revision as of 06:55, 21 October 2011

Home < Documentation < 4.0

Introduction

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


Documentation

Compile/Install


Compiling and installing VolView4 from source.

Mailing List


The developers mailing list is here: ???

Design & Implementation


Objects and their organization


Miscellaneous


Set of screenshots showing Slicer4 in action.
This page serves as a MediaWiki sandbox


Developers Corner


Mailing List

The developers mailing list is here: http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel This should be used for questions about modifying the Paraview code, not using Paraview.

Handy Developer Info


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 here for the end-user documentation template.
  • The module complies with Rons rules for tool and the style guide lines, including color palette.

Main GUI

Modules by Category

Core

Filtering

Registration

Segmentation

Converters

Endoscopy

Quantification

Developer Tools

Extensions

Introduction

  • Slicer Extensions are the "on-ramp" to the Slicer "highway". What they provide is a mechanism for anybody, including third parties, to provide modules which extend the functionality of 3d Slicer.
  • 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. See here for the end-user documentation template.
  • In Slicer 4, all new modules will begin as "Immature Extensions". They will progress to the status of "Mature Extensions", when they meet all the criteria listed below. In order to become part of the main Slicer distribution a discussion with the Slicer core team will have to be initiated after reaching the mature extension status.

Collections

Collections are groups of extensions that can be downloaded in a single operation. You can think of them as the equivalent to a playlist.

id Thumbnail Name Short Description Maturity Slicer License Search terms Contact Information
1 Replace the image with your image, replace the generic documentation link with a link to your documentation MyCollection This is a collection of extensions that will do something miraculous with your images StableExtensionIcon.png SlicerLicenseIcon.png segmentation, level set my-email at mit.edu



Table Of Extensions

id Thumbnail Name Short Description Maturity Slicer License Search terms Contact Information
1 Replace the image with your image, replace the generic documentation linke with a link to your documentation MyExtension This is an extension that will do something wonderful with your data ExperimentalExtensionIcon.png NoSlicerLicenseIcon.png filter, anisotropic my-email at gmail.com
2 Replace the image with your image, replace the generic documentation linke with a link to your documentation MyExtension This is an extension that will do something miraculous with your images StableExtensionIcon.png SlicerLicenseIcon.png segmentation, level set my-email at mit.edu


Caption for the table of extensions