Difference between revisions of "Documentation/3.5"

From Slicer Wiki
Jump to: navigation, search
Line 2: Line 2:
 
*Please copy the template linked below, paste it into your page and customize it with your module's information.
 
*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|Slicer3:Module_Documentation-3.4_Template]]
 
[[Slicer3:Module_Documentation-3.4_Template|Slicer3:Module_Documentation-3.4_Template]]
*See above for info to be put into the Help and Acknowledgment Tabs
+
*See [[Documentation-3.5#Requirements for Modules|below]] for info to be put into the Help and Acknowledgment Tabs
 
*To put your lab's logo into a module, see [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|here]]
 
*To put your lab's logo into a module, see [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|here]]
  
 
Please adhere to the naming scheme for the module documentation:
 
Please adhere to the naming scheme for the module documentation:
 
*[ [Modules:MyModuleNameNoSpaces-Documentation-3.4|My Module Name With Spaces] ] (First Last Name)
 
*[ [Modules:MyModuleNameNoSpaces-Documentation-3.4|My Module Name With Spaces] ] (First Last Name)
 +
 +
= Requirements for Modules =
 +
{| border="00" cellpadding="5" cellspacing="0"
 +
|-
 +
| rowspan="2"|
 +
* The module is '''feature complete''', it does everything that it advertises it can do
 +
* The module has a '''test'''. See [http://wiki.na-mic.org/Wiki/index.php/Slicer3:Execution_Model_Testing '''here'''] for more information.
 +
* Module has '''documentation''' on the [[Documentation-3.5#Modules|Slicer wiki]]. Please use the template provided [[Documentation-3.5#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.
 +
* 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 '''Acknowledgment''' 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.
 +
** '''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.)
 +
| style="background: #e5e5e5" align="center"| Examples for the Help and
 +
Acknowledgment Panels
 +
|-
 +
| style="background: #ebeced"|[[Image:SlicerHelpExample.png|center|200px]][[Image:SlicerAcknowledgementExample.png|center|200px]]
 +
|}
  
 
=List of Modules=
 
=List of Modules=
 
* [http://wiki.na-mic.org/Wiki/index.php/Slicer3:FourDAnalysis FourDAnalysis]
 
* [http://wiki.na-mic.org/Wiki/index.php/Slicer3:FourDAnalysis FourDAnalysis]
 
* Utah Bspline
 
* Utah Bspline

Revision as of 14:35, 15 April 2009

Home < Documentation < 3.5

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 below 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.4|My Module Name With Spaces] ] (First Last Name)

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 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 Acknowledgment 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.
    • 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.)
Examples for the Help and

Acknowledgment Panels

SlicerHelpExample.png
SlicerAcknowledgementExample.png

List of Modules