Difference between revisions of "Modules:Welcome-Documentation-3.4"

From Slicer Wiki
Jump to: navigation, search
 
(36 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 +
 +
 
__NOTOC__
 
__NOTOC__
−
===Welcome Module===
+
===The "Welcome" Module===
−
MyModule
 
  
 
{|
 
{|
−
|[[Image:screenshotBlank.png|thumb|280px|Caption 1]]
+
|[[Image:Welcome-welcome.png|thumb|280px|User greeting screen]]
−
|[[Image:screenshotBlank.png|thumb|280px|Caption 2]]
+
|[[Image:Welcome-overview.png|thumb|280px|Overview of Slicer layout and display]]
−
|[[Image:screenshotBlank.png|thumb|280px|Caption 3]]
+
|[[Image:Welcome-config.png|thumb|280px|Configuring Slicer GUI layout and display]]
 
|}
 
|}
  
 
== General Information ==
 
== General Information ==
 +
 +
'''Background:''' this module is set as Slicer's default startup module unless a user checks the box (in the User greeting panel) to supress this behavior. If the option to show the welcome module at startup is de-selected, Slicer will display the user-specified '''Home''' module on startup. The Data Module is selected as '''Home''' unless a user explicitly chooses another module.
 +
 
===Module Type & Category===
 
===Module Type & Category===
  
−
Type: Interactive or CLI
+
Type: Interactive
  
−
Category: Base or (Filtering, Registration, ''etc.'')
+
Category: Core Module
  
 
===Authors, Collaborators & Contact===
 
===Authors, Collaborators & Contact===
−
* Author1: Affiliation & logo, if desired
+
* Wendy Plesniak, BWH
−
* Contributor1: Affiliation & logo, if desired
+
* Ron Kikinis, BWH
−
* Contributor2: Affiliation & logo, if desired
+
* Steve Pieper, Isomics
−
* Contact: name, email
+
* Sonia Pujol, BWH
 +
* Contact: Wendy Plesniak, wjp@bwh.harvard.edu
  
 
===Module Description===
 
===Module Description===
−
Overview of what the module does goes here.
+
This module is intended as a welcome screen and basic overview of the Slicer software.
−
 
 
−
== Usage ==
 
−
 
 
−
===Examples, Use Cases & Tutorials===
 
−
 
 
−
* Note use cases for which this module is especially appropriate, and/or link to examples.
 
−
* Link to examples of the module's use
 
−
* Link to any existing tutorials
 
−
 
 
−
===Quick Tour of Features and Use===
 
−
List all the panels in your interface, their features, what they mean, and how to use them. For instance:
 
−
 
 
−
* '''Input panel:'''
 
−
* '''Parameters panel:'''
 
−
* '''Output panel:'''
 
−
* '''Viewing panel:'''
 
−
 
 
−
== Development ==
 
−
 
 
−
===Dependencies===
 
−
 
 
−
Other modules or packages that are required for this module's use.
 
−
 
 
−
===Known bugs===
 
−
 
 
−
Follow this [http://na-mic.org/Mantis/main_page.php link] to the Slicer3 bug tracker.
 
−
 
 
−
 
 
−
 
 
−
===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===
 
−
 
 
−
Customize following [http://viewvc.slicer.org/viewcvs.cgi/ links] for your module.
 
−
 
 
−
[http://www.na-mic.org/Slicer/Documentation/Slicer3/html/ Links] to documentation generated by doxygen.
 
  
 +
== Detailed Description ==
  
−
== More Information ==
+
Each panel in the '''Welcome Module''' is intended to provide basic information to help new users become acquainted with Slicer. The following informational panels are provided in the module, and populate the GUI from top to bottom. They provide a brief overview of their respective topics and provide links to additional information. '''Note: we would like to sincerely thank members of the Slicer User Community for helping us to design this information overview.'''
  
−
===Acknowledgment===
+
* Welcome & About:
−
Include funding and other support here.
+
* Overview:
 +
* Basic & Extended Modules:
 +
* Loading Scenes & Data:
 +
* Saving Scenes & Data:
 +
* Adjusting Data Display:
 +
* Configuring Viewers & Layout:
 +
* Mouse Modes
 +
* Customizing Slicer
 +
* Other Useful Hints
 +
* Community
 +
* Acknowledgement
  
−
===References===
+
==Acknowledgment==
−
Publications related to this module go here. Links to pdfs would be useful.
+
NAC, NA-MIC, NCIGT, MBirn, Fbirn, CTSC

Latest revision as of 21:41, 28 April 2010

Home < Modules:Welcome-Documentation-3.4

Return to Slicer 3.4 Documentation


The "Welcome" Module

User greeting screen
Overview of Slicer layout and display
Configuring Slicer GUI layout and display

General Information

Background: this module is set as Slicer's default startup module unless a user checks the box (in the User greeting panel) to supress this behavior. If the option to show the welcome module at startup is de-selected, Slicer will display the user-specified Home module on startup. The Data Module is selected as Home unless a user explicitly chooses another module.

Module Type & Category

Type: Interactive

Category: Core Module

Authors, Collaborators & Contact

  • Wendy Plesniak, BWH
  • Ron Kikinis, BWH
  • Steve Pieper, Isomics
  • Sonia Pujol, BWH
  • Contact: Wendy Plesniak, wjp@bwh.harvard.edu

Module Description

This module is intended as a welcome screen and basic overview of the Slicer software.

Detailed Description

Each panel in the Welcome Module is intended to provide basic information to help new users become acquainted with Slicer. The following informational panels are provided in the module, and populate the GUI from top to bottom. They provide a brief overview of their respective topics and provide links to additional information. Note: we would like to sincerely thank members of the Slicer User Community for helping us to design this information overview.

  • Welcome & About:
  • Overview:
  • Basic & Extended Modules:
  • Loading Scenes & Data:
  • Saving Scenes & Data:
  • Adjusting Data Display:
  • Configuring Viewers & Layout:
  • Mouse Modes
  • Customizing Slicer
  • Other Useful Hints
  • Community
  • Acknowledgement

Acknowledgment

NAC, NA-MIC, NCIGT, MBirn, Fbirn, CTSC

Retrieved from "https://www.slicer.org/w/index.php?title=Modules:Welcome-Documentation-3.4&oldid=14706"