Difference between revisions of "Documentation/4.0"
From Slicer Wiki
Line 44: | Line 44: | ||
[[Image:WeakDoc.png]]: Weak or Incomplete 3.7 Documentation | [[Image:WeakDoc.png]]: Weak or Incomplete 3.7 Documentation | ||
+ | |||
+ | =Main GUI= | ||
+ | |||
+ | =Core Modules= | ||
+ | |||
+ | =Modules by Category= |
Revision as of 12:38, 13 June 2010
Home < Documentation < 4.0Contents
Documentation Guidelines
Modules
- Please copy the template linked below, paste it into your page and customize it with your module's information.
Slicer3:Module_Documentation-3.7_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-3.7|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