Difference between revisions of "Documentation/Nightly/HowTo"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
 
(2 intermediate revisions 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 52: Line 40:
  
 
= Extension page =
 
= Extension page =
# Create an extension page
 
## [[Template:Documentation/{{documentation/version}}/extension-footer|extension-footer]] template should be at the bottom of the page. Except for page doing a REDIRECT.
 
## If the extension bundles exactly [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension#Extension_bundles_1_module|one]] module, use [{{fullurl:Documentation/{{documentation/version}}/Extensions/SkullStripper|redirect=no}} this template]
 
## If the extension bundles [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension#Extension_bundles_N_modules|more]] than one module, use [[Documentation/{{documentation/version}}/Extensions/Plastimatch|this template]].
 
# Add an extension entry in [[Documentation/{{documentation/version}}/Extensions#Extension_Categories]]
 
# The extension should now be listed on [[Documentation/{{documentation/version}}]].
 
# Create a [[#Module_page|regular wiki page]] for each module of the extension using the [[Documentation/{{documentation/version}}/Modules/YOURMODULENAME|template]] page. The URLs of the extension modules are the same than the built-in modules.
 
  
 
+
This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
 
 
== Remarks ==
 
 
 
=== Actively maintained and developed extension ===
 
 
 
* If the extension is actively developed and maintained so that the code of the nightly extension is the same as the extension associated with a specific slicer release (i.e {{documentation/currentversion}}), a different approach could be considered.
 
 
 
==== Extension bundles ONE module ====
 
 
 
* In addition to create the following pages:
 
 
 
Documentation/Nightly/Extensions/YOURMODULENAME
 
Documentation/{{documentation/currentversion}}/Extensions/YOURMODULENAME
 
Documentation/Nightly/Modules/YOURMODULENAME
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME
 
 
 
* ... and setup the following [http://www.mediawiki.org/wiki/Help:Redirects redirect]:
 
 
 
Documentation/Nightly/Extensions/YOURMODULENAME  ->  Documentation/Nightly/Modules/YOURMODULENAME
 
 
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME  ->  Documentation/Nightly/Modules/YOURMODULENAME
 
 
 
Documentation/{{documentation/currentversion}}/Extensions/YOURMODULENAME  ->  Documentation/Nightly/Modules/YOURMODULENAME  # Since [http://www.mediawiki.org/wiki/Help:Redirects#Double_redirects double redirect are not supported]. Version specific extension page redirects to Nightly module page.
 
 
 
* The only page that would be updated would be the Nightly one:
 
 
 
Documentation/Nightly/Modules/YOURMODULENAME
 
 
 
 
 
==== Extension bundles N modules ====
 
 
 
In addition to create the following pages:
 
 
 
Documentation/Nightly/Modules/YOURMODULENAME_0
 
Documentation/Nightly/Modules/YOURMODULENAME_1
 
[...]
 
Documentation/Nightly/Modules/YOURMODULENAME_N
 
 
Documentation/Nightly/Extensions/YOUREXTENSIONNAME
 
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME_0
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME_1
 
[...]
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME_N
 
 
Documentation/{{documentation/currentversion}}/Extensions/YOUREXTENSIONNAME
 
 
 
* ... and setup the following [http://www.mediawiki.org/wiki/Help:Redirects redirect]:
 
 
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME_0 -> Documentation/Nightly/Modules/YOURMODULENAME_0
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME_1 -> Documentation/Nightly/Modules/YOURMODULENAME_1
 
[...]
 
Documentation/{{documentation/currentversion}}/Modules/YOURMODULENAME_N -> Documentation/Nightly/Modules/YOURMODULENAME_N
 
 
 
Documentation/{{documentation/currentversion}}/Extensions/YOUREXTENSIONNAME -> Documentation/Nightly/Extensions/YOUREXTENSIONNAME
 
 
 
 
 
* The only page(s) that would be updated would be the Nightly ones:
 
 
 
Documentation/Nightly/Modules/YOURMODULENAME_0
 
Documentation/Nightly/Modules/YOURMODULENAME_1
 
[...]
 
Documentation/Nightly/Modules/YOURMODULENAME_N
 
 
Documentation/Nightly/Extensions/YOUREXTENSIONNAME
 
 
 
 
 
==== Case where a version specific documentation page diverges from the Nightly one ====
 
 
 
* If for some reason the documentation associated with the version specific extension is going to diverge from the Nightly one. Before modifying the Nightly page, *MAKE SURE* to create the associated version-ed page(s) by copying the content of the Nighty module page(s) into their own page(s).
 
 
 
= 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