Documentation/4.0/HowTo
From Slicer Wiki
Home < Documentation < 4.0 < HowTo
| 3D Slicer | |
|---|---|
 | |
| Description | |
| Research platform for the analysis and visualization of medical images, including image guided therapy. | |
| Free and extensible open source package. | |
| Multi-platform | Linux, MacOSX, Windows |
| Version | 4.0 |
| License | Contribution and Software License Agreement |
Overview
This document aims at describing the steps required to write Slicer user documentation.
The user documentation subpages are grouped under two sections: Slicer Application and Modules.
The 4.0 documentation framework has been redesigned keeping in mind the following principles:
- Single location for editing documentation (either the wiki or the source code), no duplicative editing.
- Smart use of mediawiki templates to enforce consistency and reduce maintenance work.
Naming conventions
- The application Slicer should be referenced with an uppercase S.
- All documentation should be added as subpages under Documentation/X.Y/ where X and Y are respectively the major and minor Slicer version.
- Documentation/4.0/SlicerApplication should be the root of all subpages specific to Slicer application.
- Documentation/4.0/Modules should be the root of all subpages specific to Slicer modules.
- Module subpage should be named after the module name used in the associated source repository. Assuming the module is named Foo, the corresponding subpage is expected to be Documentation/4.0/Modules/Foo
- Collaborator names, logos or URLs should be referenced using the convenient Collaborator template.
Category
- All subpages should be categorized. See [1]
Module subpage
- Base your work on either this Template or an existing module documentation.
- There is a python helper script for SEM compliant tools that can save a significant amount of transcription time: Slicer/Scripts/SEMToMediaWiki.py
- For CLI modules, the SVNREVISION revision number is reported on this page. The module description and the information for developers would be automatically extracted from the corresponding XML description.
For the moment it's required to update that number at multiple location within the wiki source of a given module documentation page. Soon this will be centralized.
Miscellaneous
- High resolution logos are in the Logo Gallery
- The following [Category:Documentation/4.0/Modules link] will list all modules belonging to the Documentation/4.0/Modules category.
