Documentation/Nightly/HowTo - Revision history

Lasso: /* Overview */

2020-06-08T20:34:25Z

Overview

2020-06-08T20:34:04Z

Miscellaneous: not relevant anymore

2020-06-08T20:21:26Z

Extension page

2020-06-08T20:20:40Z

Module page

2020-06-08T20:18:54Z

SlicerApplication page: not applicable to Slicer5 readthedocs-based documentation

2020-06-08T20:18:36Z

Category: not applicable to Slicer5 readthedocs-based documentation

2020-06-08T20:18:17Z

Documentation version: not applicable to Slicer5 readthedocs-based documentation

2020-06-08T20:17:42Z

Naming conventions: not applicable to Slicer5 readthedocs-based documentation

2020-06-08T18:11:47Z

Overview

2019-11-27T13:19:02Z

Text replacement - "https?:\/\/(?:www|wiki)\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) " to "https://www.slicer.org/wiki/$1 "

@@ Line 34: / Line 34: @@
 |data6   = [http://www.slicer.org/pages/LicenseText Contribution and Software License Agreement]
 }}
 = Module page =

← Older revision		Revision as of 20:34, 8 June 2020
Line 54:		Line 54:

	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

@@ Line 52: / Line 52: @@
 = Extension page =
+This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
 = Miscellaneous =

@@ Line 48: / Line 48: @@
 = Module page =
-== Documentation for a CLI module ==
+This section has moved to https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html#documentation
 = Extension page =

← Older revision		Revision as of 20:18, 8 June 2020
Line 46:		Line 46:

	__TOC__		__TOC__
−
−	~~= SlicerApplication page =~~
−	# [[Template:Documentation/{{documentation/version}}/slicerapplication-header\|slicerapplication-header]] and [[Template:Documentation/{{documentation/version}}/slicerapplication-footer\|slicerapplication-footer]] templates should be respectively used at the top and the bottom of the page.

	= Module page =		= Module page =

← Older revision		Revision as of 20:17, 8 June 2020
Line 46:		Line 46:

	__TOC__		__TOC__
−
−	~~= 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.~~
−	~~# Version of Slicer should NOT be written in plain text, {{[[Template:Documentation/version\|documentation/version]]}} template should be used instead.~~
−	~~# [[Documentation/{{documentation/version}}/SlicerApplication]] should be the root of all subpages specific to Slicer application.~~
−	~~# [[Documentation/{{documentation/version}}/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/{{documentation/version}}/Modules/Foo'''
−	~~# Collaborator names, logos or URLs should be referenced using the convenient [[Template:Collaborator\|Collaborator]] template.~~
−	~~## For example: <nowiki>''{{collaborator\|longname\|namic}}''</nowiki> generates ''{{collaborator\|longname\|namic}}''~~
−	~~# Email addresses must be wrapped with the '''<nowiki><email></email></nowiki>''' tags~~

	= Documentation version =		= Documentation version =

@@ Line 39: / Line 39: @@
 This document aims at describing the principle and guidelines to consider when writing Slicer user documentation.
-The documentation framework has been designed keeping in mind the following principles:
+The documentation framework has been designed keep keeping in mind the following principles:
-* Single location for editing documentation (either the wiki or the source code), no duplicative editing.
+* 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.
-* Smart use of mediawiki templates to enforce consistency and reduce maintenance work.
+* Allow anyone to make changes or propose changes to the documentation.

@@ Line 61: / Line 61: @@
 In addition to the wiki documentation specific to each release 4.0, 4.1 ... there is also a namespace named "Nightly".
-See http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly
+See https://www.slicer.org/wiki/Documentation/Nightly * This set of documentation pages applies to the nightly build of Slicer.
 * Documentation associated with new features, new modules, new extensions etc .. should be added into the Nightly set.