Difference between revisions of "Documentation/4.0"
From Slicer Wiki
Line 1: | Line 1: | ||
+ | =Documentation Guidelines= | ||
'''Modules''' | '''Modules''' | ||
*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. | ||
Line 23: | Line 24: | ||
** '''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.) | ** '''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.) | ||
* Many modules are better suited to be [[Documentation-3.7#Extensions_for_Downloading|downloadable extensions]]. The same module creation guidelines apply, but the actual implementation is done outside of the slicer source code repository. | * Many modules are better suited to be [[Documentation-3.7#Extensions_for_Downloading|downloadable extensions]]. The same module creation guidelines apply, but the actual implementation is done outside of the slicer source code repository. | ||
− | * Follow [[Documentation | + | * Follow [[Documentation-Rons-Rules-For-Tools|'''Ron's rules for tools''']] |
| style="background: #e5e5e5" align="center"| Examples for the Help and | | style="background: #e5e5e5" align="center"| Examples for the Help and | ||
Acknowledgment Panels | Acknowledgment Panels |
Revision as of 12:28, 13 June 2010
Home < Documentation < 4.0Documentation 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 Draft notes
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.