Documentation/4.10/Developers/FAQ/WritingDocumentation

From Slicer Wiki
Revision as of 17:04, 21 November 2019 by Grundlett (talk | contribs) (Text replacement - "slicerWiki/index.php" to "wiki")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Home < Documentation < 4.10 < 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: http://wiki.slicer.org/wiki/Documentation/Nightly/Modules/GaussianBlurImageFilter

Poor: http://wiki.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.