Difference between revisions of "Documentation/Nightly/HowTo"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
 
(One intermediate revision by the same user not shown)
Line 34: Line 34:
 
|data6  = [http://www.slicer.org/pages/LicenseText Contribution and Software License Agreement]
 
|data6  = [http://www.slicer.org/pages/LicenseText Contribution and Software License Agreement]
 
}}
 
}}
 
= Overview =
 
 
This document aims at describing the principle and guidelines to consider when writing Slicer user documentation.
 
 
The documentation framework has been designed keep keeping in mind the following principles:
 
* Keep documentation at the same place as the source code to make it possible to keep the documentation always in sync with the software implementation.
 
* Allow anyone to make changes or propose changes to the documentation.
 
* Follow common documentation conventions (formats, rendering tools, and services)
 
 
 
__TOC__
 
  
 
= Module page =
 
= Module page =
Line 54: Line 42:
  
 
This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
 
This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
 
= Miscellaneous =
 
* High resolution logos are in the [[Logo_Gallery|Logo Gallery]]
 
* There is a python helper script for SEM compliant tools that can save a significant amount of transcription time:  Slicer/Utilities/Scripts/SEMToMediaWiki.py
 
**To use it run "python Slicer/Utilities/Scripts/SEMToMediaWiki.py -x XMLFILE.xml -o OUTPUT.txt" and the mediawiki content will be in OUTPUT.txt
 

Latest revision as of 20:34, 8 June 2020

Home < Documentation < Nightly < HowTo


For the latest Slicer documentation, visit the read-the-docs.



3D Slicer
3D Slicer Nightly
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 Nightly
License Contribution and Software License Agreement
v · d · e

Module page

This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation

Extension page

This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation