https://www.slicer.org/w/index.php?action=history&feed=atom&title=Documentation%2FNightly%2FDevelopers%2FFAQ%2FWritingDocumentation 2026-05-04T02:13:05Z Revision history for this page on the wiki MediaWiki 1.33.0 https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/FAQ/WritingDocumentation&diff=62628&oldid=prev 2019-11-27T13:20:35Z

<p>Text replacement - &quot;https?:\/\/(?:www|wiki)\.slicer\.org\/slicerWiki\/index\.php\/([^ ]+) &quot; to &quot;https://www.slicer.org/wiki/$1 &quot;</p> <table class="diff diff-contentalign-left" data-mw="interface"> <col class="diff-marker" /> <col class="diff-content" /> <col class="diff-marker" /> <col class="diff-content" /> <tr class="diff-title" lang="en"> <td colspan="2" style="background-color: #fff; color: #222; text-align: center;">← Older revision</td> <td colspan="2" style="background-color: #fff; color: #222; text-align: center;">Revision as of 13:20, 27 November 2019</td> </tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l9" >Line 9:</td> <td colspan="2" class="diff-lineno">Line 9:</td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The URL including the &lt;code&gt;Nightly&lt;/code&gt; namespace should be used.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>The URL including the &lt;code&gt;Nightly&lt;/code&gt; namespace should be used.</div></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>Good: <del class="diffchange diffchange-inline">http</del>://<del class="diffchange diffchange-inline">wiki</del>.slicer.org/<del class="diffchange diffchange-inline">slicerWiki/index.php</del>/Documentation/Nightly/Modules/GaussianBlurImageFilter</div></td><td class='diff-marker'>+</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div>Good: <ins class="diffchange diffchange-inline">https</ins>://<ins class="diffchange diffchange-inline">www</ins>.slicer.org/<ins class="diffchange diffchange-inline">wiki</ins>/Documentation/Nightly/Modules/GaussianBlurImageFilter Poor: <ins class="diffchange diffchange-inline">https</ins>://<ins class="diffchange diffchange-inline">www</ins>.slicer.org/<ins class="diffchange diffchange-inline">wiki</ins>/Documentation/4.4/Modules/GaussianBlurImageFilter References to documentation hosted on the wiki usually occurs when:</div></td></tr> <tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr> <tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>Poor: <del class="diffchange diffchange-inline">http</del>://<del class="diffchange diffchange-inline">wiki</del>.slicer.org/<del class="diffchange diffchange-inline">slicerWiki/index.php</del>/Documentation/4.4/Modules/GaussianBlurImageFilter</div></td><td colspan="2"> </td></tr> <tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div> </div></td><td colspan="2"> </td></tr> <tr><td class='diff-marker'>−</td><td style="color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #ffe49c; vertical-align: top; white-space: pre-wrap;"><div>References to documentation hosted on the wiki usually occurs when:</div></td><td colspan="2"> </td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* writing module or extension description</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* writing module or extension description</div></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* setting the documentation URL in &lt;code&gt;CMakeLists.txt&lt;/code&gt;, cpp or python source files.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>* setting the documentation URL in &lt;code&gt;CMakeLists.txt&lt;/code&gt;, cpp or python source files.</div></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"></td></tr> <tr><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Rational: This will facilitate maintenance and avoid to update source files after each release.</div></td><td class='diff-marker'> </td><td style="background-color: #f8f9fa; color: #222; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>Rational: This will facilitate maintenance and avoid to update source files after each release.</div></td></tr> </table>

Grundlett https://www.slicer.org/w/index.php?title=Documentation/Nightly/Developers/FAQ/WritingDocumentation&diff=42185&oldid=prev 2015-07-15T16:38:05Z

<p>Created page with &#039;&lt;noinclude&gt;{{documentation/versioncheck}}&lt;/noinclude&gt; &lt;noinclude&gt;__TOC__ ={{#titleparts: {{PAGENAME}} | | -1 }}=&lt;/noinclude&gt;&lt;includeonly&gt; =&#039;&#039;&#039;Developer FAQ: {{{1}}}&#039;&#039;&#039;= &lt;/include…&#039;</p> <p><b>New page</b></p><div>&lt;noinclude&gt;{{documentation/versioncheck}}&lt;/noinclude&gt;<br /> &lt;noinclude&gt;__TOC__<br /> ={{#titleparts: {{PAGENAME}} | | -1 }}=&lt;/noinclude&gt;&lt;includeonly&gt;<br /> ='''Developer FAQ: {{{1}}}'''=<br /> &lt;/includeonly&gt;<br /> <br /> == How to reference module or extension documentation hosted on the Slicer wiki ? ==<br /> <br /> The URL including the &lt;code&gt;Nightly&lt;/code&gt; namespace should be used.<br /> <br /> Good: http://wiki.slicer.org/slicerWiki/index.php/Documentation/Nightly/Modules/GaussianBlurImageFilter<br /> <br /> Poor: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.4/Modules/GaussianBlurImageFilter<br /> <br /> References to documentation hosted on the wiki usually occurs when:<br /> * writing module or extension description<br /> * setting the documentation URL in &lt;code&gt;CMakeLists.txt&lt;/code&gt;, cpp or python source files.<br /> <br /> Rational: This will facilitate maintenance and avoid to update source files after each release.</div>

JChris.FillionR