Difference between revisions of "Documentation/4.8/Developers/FAQ/WritingDocumentation"

From Slicer Wiki
Jump to: navigation, search
(Nightly -> 4.8)
 
m (Text replacement - "https?:\/\/(?:www|wiki)\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) " to "https://www.slicer.org/wiki/$1 ")
 
Line 9: Line 9:
 
The URL including the <code>Nightly</code> namespace should be used.
 
The URL including the <code>Nightly</code> namespace should be used.
  
Good: http://wiki.slicer.org/slicerWiki/index.php/Documentation/Nightly/Modules/GaussianBlurImageFilter
+
Good: https://www.slicer.org/wiki/Documentation/Nightly/Modules/GaussianBlurImageFilter Poor: https://www.slicer.org/wiki/Documentation/4.4/Modules/GaussianBlurImageFilter References to documentation hosted on the wiki usually occurs when:
 
 
Poor: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.4/Modules/GaussianBlurImageFilter
 
 
 
References to documentation hosted on the wiki usually occurs when:
 
 
* writing module or extension description
 
* writing module or extension description
 
* setting the documentation URL in <code>CMakeLists.txt</code>, cpp or python source files.
 
* setting the documentation URL in <code>CMakeLists.txt</code>, cpp or python source files.
  
 
Rational: This will facilitate maintenance and avoid to update source files after each release.
 
Rational: This will facilitate maintenance and avoid to update source files after each release.

Latest revision as of 13:16, 27 November 2019

Home < Documentation < 4.8 < Developers < FAQ < WritingDocumentation


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


WritingDocumentation

How to reference module or extension documentation hosted on the Slicer wiki ?

The URL including the Nightly namespace should be used.

Good: https://www.slicer.org/wiki/Documentation/Nightly/Modules/GaussianBlurImageFilter Poor: https://www.slicer.org/wiki/Documentation/4.4/Modules/GaussianBlurImageFilter References to documentation hosted on the wiki usually occurs when:

  • writing module or extension description
  • setting the documentation URL in CMakeLists.txt, cpp or python source files.

Rational: This will facilitate maintenance and avoid to update source files after each release.