Difference between revisions of "Documentation/4.6/Developers/FAQ/WritingDocumentation"
From Slicer Wiki
(Nightly -> 4.6) |
m (Text replacement - "slicerWiki/index.php" to "wiki") |
||
| 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/ | + | Good: http://wiki.slicer.org/wiki/Documentation/Nightly/Modules/GaussianBlurImageFilter |
| − | Poor: http://wiki.slicer.org/ | + | Poor: http://wiki.slicer.org/wiki/Documentation/4.4/Modules/GaussianBlurImageFilter |
References to documentation hosted on the wiki usually occurs when: | References to documentation hosted on the wiki usually occurs when: | ||
Latest revision as of 17:34, 21 November 2019
Home < Documentation < 4.6 < Developers < FAQ < WritingDocumentation
|
For the latest Slicer documentation, visit the read-the-docs. |
Contents
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.
