Documentation/Nightly/Developers/FAQ/WritingDocumentation
From Slicer Wiki
Revision as of 16:38, 15 July 2015 by JChris.FillionR (talk | contribs) (Created page with '<noinclude>{{documentation/versioncheck}}</noinclude> <noinclude>__TOC__ ={{#titleparts: {{PAGENAME}} | | -1 }}=</noinclude><includeonly> ='''Developer FAQ: {{{1}}}'''= </include…')
Home < Documentation < Nightly < 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/slicerWiki/index.php/Documentation/Nightly/Modules/GaussianBlurImageFilter
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
- 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.
