Difference between revisions of "Documentation/4.0"
Line 59: | Line 59: | ||
=Extensions= | =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. | ||
+ | *'''While the Slicer license is suggested, it is not required for extensions. 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. | ||
+ | * The version that is available through the extension manager is chosen by the developer of that extension | ||
+ | * Not all extensions are available on all platforms. See here for the [[Documentation-3.6:ExtensionStatus|extension status]]. | ||
+ | * In case of problems with extensions, please talk directly to the developers of the extensions. | ||
+ | * Information for developers can be found [[Slicer4:Extensions|here]]. |
Revision as of 15:12, 30 May 2011
Home < Documentation < 4.0Contents
Introduction
Slicer is undergoing a facelift with the transition from KW widgets to Qt widgets. This will take a while. During this time, some of the documentation on this page will be changing.
Documentation Guidelines
This section is intended primarily for the developers. However, improvements from the community are very welcome and encouraged.
Modules
- Please copy the template linked below, paste it into your page and customize it with your module's information.
Slicer4:Module_Documentation-4-alpha_Template
- See Requirements for Modules 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.7|My Module Name With Spaces] ] (First Last Name)
- You can use the following python script to automatically generate some of the wiki documentation from your module's .xml file: SEMToMediaWiki.py
Requirements for Modules
|
Examples for the Help and
Acknowledgment Panels |
Please adhere to the naming scheme for the module documentation:
- [[Modules:MyModuleNameNoSpaces-Documentation-4-alpha|My Module Name With Spaces] ] (First Last Name)
Documentation Quality
Key for flagged modules below:
: Missing or stale link to 3.7 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 3.7 Documentation
Main GUI
Core Modules
Modules by Category
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.
- While the Slicer license is suggested, it is not required for extensions. 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.
- The version that is available through the extension manager is chosen by the developer of that extension
- Not all extensions are available on all platforms. See here for the extension status.
- In case of problems with extensions, please talk directly to the developers of the extensions.
- Information for developers can be found here.