Difference between revisions of "Documentation/4.0/HowTo"
From Slicer Wiki
| Line 5: | Line 5: | ||
This is a placeholder for guidelines on how to insert documentation into Slicer 4 source code. JC and Jim will edit this page as part of their discussions. | This is a placeholder for guidelines on how to insert documentation into Slicer 4 source code. JC and Jim will edit this page as part of their discussions. | ||
| + | |||
| + | {{Infobox | ||
| + | |name = 3D Slicer {{documentation/version}} | ||
| + | |above = 3D Slicer | ||
| + | |abovestyle = | ||
| + | |||
| + | |image = [[File:Logo-3DSlicer.png|200px|alt=3D Slicer {{documentation/version}}]] | ||
| + | |imagestyle = | ||
| + | |headerstyle = background:#E7DCC3; | ||
| + | |labelstyle = | ||
| + | |datastyle = | ||
| + | |||
| + | |header1 = Description | ||
| + | |label1 = | ||
| + | |data1 = | ||
| + | |header2 = | ||
| + | |label2 = | ||
| + | |data2 = Research platform for the analysis and visualization of medical images, including image guided therapy. | ||
| + | |header3 = | ||
| + | |label3 = | ||
| + | |data3 = Free and extensible open source package. | ||
| + | |header4 = | ||
| + | |label4 = Multi-platform | ||
| + | |data4 = Linux, MacOSX, Windows | ||
| + | |header5 = | ||
| + | |label5 = Version | ||
| + | |data5 = {{documentation/version}} | ||
| + | |header6 = | ||
| + | |label6 = License | ||
| + | |data6 = [http://www.slicer.org/pages/LicenseText Contribution and Software License Agreement] | ||
| + | }} | ||
| + | |||
| + | |||
| + | For the end user documentation use this [[Documentation/{{documentation/version}}/Modules/YOURMODULENAME|Template]] | ||
| + | |||
| + | *All module documentation page should be named according to the following pattern: '''Documentation/4.0/Modules/MODULENAME''' | ||
| + | *High resolution logos are in the [[Logo_Gallery|Logo Gallery]] | ||
| + | *Collaborators' name, logo, URL have been centralized into a convenient set of [http://wiki.slicer.org/slicerWiki/index.php/Template:Collaborator templates] | ||
| + | *The following [http://wiki.slicer.org/slicerWiki/index.php?title=Category:Documentation/4.0/Modules link] will list all modules belonging to the Documentation/4.0/Modules category. | ||
| + | *For CLI modules, the '''SVNREVISION''' revision number is reported on this [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk/Applications/CLI page]. The module description and the information for developers would be automatically extracted from the corresponding XML description. '''Note:''' for the moment it's required to update that number at multiple location within the wiki source of a given module documentation page. Soon this will be centralized. | ||
Revision as of 15:03, 8 November 2011
Home < Documentation < 4.0 < HowTo
This is a placeholder for guidelines on how to insert documentation into Slicer 4 source code. JC and Jim will edit this page as part of their discussions.
| 3D Slicer | |
|---|---|
 | |
| Description | |
| Research platform for the analysis and visualization of medical images, including image guided therapy. | |
| Free and extensible open source package. | |
| Multi-platform | Linux, MacOSX, Windows |
| Version | 4.0 |
| License | Contribution and Software License Agreement |
For the end user documentation use this Template
- All module documentation page should be named according to the following pattern: Documentation/4.0/Modules/MODULENAME
- High resolution logos are in the Logo Gallery
- Collaborators' name, logo, URL have been centralized into a convenient set of templates
- The following link will list all modules belonging to the Documentation/4.0/Modules category.
- For CLI modules, the SVNREVISION revision number is reported on this page. The module description and the information for developers would be automatically extracted from the corresponding XML description. Note: for the moment it's required to update that number at multiple location within the wiki source of a given module documentation page. Soon this will be centralized.
