Difference between revisions of "Slicer4:Extensions"
From Slicer Wiki
(Redirected page to Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions) |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | #REDIRECT [[Documentation/Nightly/Developers/Tutorials/BuildTestPackageDistributeExtensions]] | ||
| + | |||
| + | <!-- | ||
| + | |||
This page is a place holder right now and will be populated eventually. | This page is a place holder right now and will be populated eventually. | ||
| Line 35: | Line 39: | ||
== Version 4.0 == | == Version 4.0 == | ||
| + | =Documentation Guidelines= | ||
| + | This section is intended primarily for the developers. However, improvements from the community are very welcome and encouraged. | ||
| + | |||
| + | ==Module documentation on the Slicer wiki== | ||
| + | *Please copy the template linked below, paste it into your page and customize it with your module's information. | ||
| + | [[Slicer4:Module_Documentation-4.0_Template|Slicer4:Module_Documentation-4.0_Template]] | ||
| + | * Please adhere to the naming scheme for the module documentation: [ [Modules:MyModuleNameNoSpaces-Documentation-3.7|My Module Name With Spaces] ] (First Last Name) | ||
| + | * You can use the following python script to automatically generate some of the wiki documentation from your module's .xml file: [[SEMToMediaWiki.py |SEMToMediaWiki.py]] | ||
| + | |||
| + | ==Documentation in the module== | ||
| + | [[Image:Slicer4HelpExample.png|right|200px]][[Image:Slicer4AcknowledgementExample.png|right|200px]] | ||
| + | *Short help file in the help section of the module. Keep in mind that our users are not computer scientists with a background in computer vision. | ||
| + | *Please add a pointer to the documentation on the Slicer wiki to the the '''Help''' tab of the module. See the '''Models module''' for an example in C++ and '''Editor module''' for an example in python. | ||
| + | * Acknowledgements: | ||
| + | ** The contributor (and their manager/advisor), the lab (with labs/institution logo) and the funding source (with grant number, logo optional) are listed in the '''Acknowledegment''' tab of the module. Please see the '''Models module''' for an example. The people listed in the acknowledgement will be the primary people for support and maintenance relative of the module. [[Slicer3:Execution_Model_Documentation#Adding_Module_Logos_to_Slicer3|See here for more information.]] | ||
| + | ** '''Style Guide:''' All acknowledgment icons should be 100x100 pixels, preferably in png format. | ||
| + | ** '''Accessing logos:''' Icons for BIRN, NAC, NA-MIC and IGT are included in <code>qSlicerLogos.qrc</code> and resources for them are in <code>Slicer4\Resources\Logos</code>. | ||
| + | ** '''Adding logos:''' Please add additional image resources and logo icons to these files as required in order to promote shared use (and to prevent duplication in the code.) | ||
| + | |||
| + | --> | ||
