Difference between revisions of "Documentation/4.1/Developers"

From Slicer Wiki
Jump to: navigation, search
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(101 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
__NOTOC__
 
__NOTOC__
 +
 +
 +
<big><big>If you are a newcomer, you should probably check these '''[[{{FULLPAGENAME}}/StartHere|instructions]]''' !</big></big>
 +
*If you need to cite Slicer, please use [http://www.slicer.org/pages/UserOrientation these references].
 +
 
{| border="0" align="center" width="98%" valign="top" cellspacing="7" cellpadding="2"
 
{| border="0" align="center" width="98%" valign="top" cellspacing="7" cellpadding="2"
 
|-
 
|-
Line 9: Line 15:
 
|-  
 
|-  
 
|valign="top"|
 
|valign="top"|
 
+
----
===Introduction===
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Getting involved</span>
 
----
 
----
  
* [[Documentation/{{documentation/version}}/Developers/Overview | Overview]]
+
* [[{{FULLPAGENAME}}/Meetings|Developer meetings]]
: Overview of the development process.
+
: It is open to everyone, feel free to join.
  
=== Resources ===
+
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Developers mailing list] / [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Sign-up] / [http://slicer-devel.65872.n3.nabble.com/ Browse archives]
 +
: Intended for discussion of programming related questions
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;">Resources</span>
 
----
 
----
* [http://slicer.org/doc/html/classes.html Doxygen]
+
* [http://na-mic.org/Mantis/roadmap_page.php Roadmap]{{new}}
: Source code API documentation.
+
: What's next ? What's the plan ?
  
* [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk ViewVC] ([http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision last commit])
+
* [http://slicer.cdash.org/index.php?project=Slicer4 CDash Quality Dashboard] / [[{{FULLPAGENAME}}/Tutorials/DashboardSetup|Setup a dashboard]]
: Web-based code repository viewer.
+
: Nightly, continuous and experimental dashboards.
  
=== Getting involved ===
+
* [http://na-mic.org/Mantis Bug tracker] / [http://na-mic.org/Mantis/signup_page.php Register] / [http://na-mic.org/Mantis/bug_report_page.php Report a bug]
----
+
: Web-based bug tracking system
* [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Developers mailing list]
 
: Intended for the discussion of programming related questions.
 
  
* [http://slicer-devel.65872.n3.nabble.com/ Developers mailing list archives]
+
* [http://slicer.org/doc/html/classes.html Doxygen]
: Search for priorly posted questions and answers on nabble.com
+
: Source code API documentation.
  
* [[Developer_Meetings|Developer meetings]]
+
* [[{{FULLPAGENAME}}/Style Guide|Slicer Style Guidelines]]{{new}}
: It is open to everyone, feel free to join.
+
: Consistency and Readability for a manageable code base
  
 
* [[Slicer4:Developers|Developer Projects]]
 
* [[Slicer4:Developers|Developer Projects]]
 
: Pages for the developer projects.
 
: Pages for the developer projects.
  
===Miscellaneous===
+
* [[Release Details|Change logs and release details]]
 +
: Informations about Slicer releases
 +
 
 +
----
 +
<span style="color: #555555; font-size: 18px; font-weight: bold;">Bookmarks</span>
 
----
 
----
* [[Documentation/{{documentation/version}}/Developers/ImageGallery|Image gallery]]
+
* [http://marklodato.github.com/visual-git-guide/index-en.html A Visual Git Reference]
: Set of screenshots showing the different Slicer components.
 
 
 
* [[Documentation/{{documentation/version}}/Developers/Style Guide|Slicer Style Guidelines]]
 
: Consistency and Readability for a manageable code base
 
 
 
* [[Documentation/{{documentation/version}}/Developers/Sandbox|MediaWiki Extensions testing page]]
 
: This page serves as a MediaWiki sandbox.
 
 
 
 
 
<!--
 
* [[Documents and links]]
 
: A set of presentations made on Slicer and document talking about it.
 
  
* [[Documentation/4.0/FAQ]]
 
: A set of common questions/answer on Slicer goal and possibility.
 
-->
 
  
 
|bgcolor="#CCCCCC"|
 
|bgcolor="#CCCCCC"|
 
|valign="top"|
 
|valign="top"|
 
===Compile / Package===
 
 
----
 
----
* [https://github.com/Slicer/Slicer Git repository]
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Build instructions</span>
 +
----
 +
* [https://github.com/Slicer/Slicer Git repository] / [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk ViewVC] / [http://viewvc.slicer.org/viewvc.cgi/Slicer4?view=revision&revision last commit] / [[Documentation/{{documentation/version}}/Developers/Build_Instructions#Using_git-svn|git-svn setup]]
 
: <code>git clone git://github.com/Slicer/Slicer.git</code>
 
: <code>git clone git://github.com/Slicer/Slicer.git</code>
  
* [[Documentation/{{documentation/version}}/Developers/Build Instructions|Slicer application build instructions]]
+
* [[Documentation/{{documentation/version}}/Developers/Build Instructions|Build Slicer application]]
 
: Compiling and installing Slicer from source.
 
: Compiling and installing Slicer from source.
  
* [https://github.com/jcfr/ExtensionsIndex/tree/24-ExtensionIndex-add-readme-file#readme Slicer extensions build instructions]
+
* [[Documentation/{{documentation/version}}/Developers/Build Module|Build Module]]{{new}}
: Build, test, package and distribute extensions
+
: Compiling slicer modules outside of the slicer source tree.
  
* [http://slicer.cdash.org/index.php?project=Slicer4 CDash (Quality Dashboard)]
+
----
: Nightly, continuous and experimental dashboards.
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Design & Implementation</span>
 
 
* [[Slicer4:QtPort/Releases|Releases]]
 
: Informations of Slicer releases
 
 
 
===Design & Implementation===
 
 
----
 
----
  
* [[Documentation/{{documentation/version}}/Developers/Modules | Modules]]
+
* [[{{FULLPAGENAME}}/Modules | Modules]]{{updated}}
: Comparison between the different module types supported by Slicer
+
: Comparison between the different supported module types
  
* [[Documentation/{{documentation/version}}/Developers/MRML | Data Model - MRML]]
+
* Internals
: Objects and their organization. MRML Library provides API for managing medical image data type.
+
** [[{{FULLPAGENAME}}/MRML | Data Model / MRML]] - Objects and their organization. MRML Library provides API for managing medical image data type
 +
** [[{{FULLPAGENAME}}/Logics | Logics]] - Details the role of MRML/Slicer/Application/Modules logics and Displayable managers
 +
** [[{{FULLPAGENAME}}/IO | IO Mechanism]] - How to read or write nodes from file
  
* [[Documentation/{{documentation/version}}/Developers/Logics | Logics]]
+
* [[{{FULLPAGENAME}}/Python scripting | Python scripting]]
: Details the role of logics in Slicer and lists the different types such as [[Documentation/{{documentation/version}}/Developers/DisplayableManagers | displayable managers]].
+
: Presents the underlying infrastructure.
  
* [[Documentation/{{documentation/version}}/Developers/Python scripting | Python scripting]]
+
* [[{{FULLPAGENAME}}/Charts | Charts]]
: Presents the underlying infrastructure.
+
: Description of the Charting architecture.
  
* [[Documentation/{{documentation/version}}/Developers/Build system | Build system]]
+
* [[{{FULLPAGENAME}}/Build system | Build system]] / [[Release_Details | Release details]]
: Details how Slicer is built and packaged.
+
: Details how Slicer is built, packaged and released.
  
 
|bgcolor="#CCCCCC"|
 
|bgcolor="#CCCCCC"|
 
|valign="top"|
 
|valign="top"|
 
+
----
 
{{:{{FULLPAGENAME}}/Tutorials}}
 
{{:{{FULLPAGENAME}}/Tutorials}}
  
 
|}
 
|}
  
 +
<hr>
  
  
 
[[{{collaborator|logo|slicer4}}|x300px|center]]
 
[[{{collaborator|logo|slicer4}}|x300px|center]]

Latest revision as of 07:27, 14 June 2013

Home < Documentation < 4.1 < Developers


For the latest Slicer documentation, visit the read-the-docs.



If you are a newcomer, you should probably check these instructions !


Getting involved


It is open to everyone, feel free to join.
Intended for discussion of programming related questions

Resources


What's next ? What's the plan ?
Nightly, continuous and experimental dashboards.
Web-based bug tracking system
Source code API documentation.
Consistency and Readability for a manageable code base
Pages for the developer projects.
Informations about Slicer releases

Bookmarks




Build instructions


git clone git://github.com/Slicer/Slicer.git
Compiling and installing Slicer from source.
Compiling slicer modules outside of the slicer source tree.

Design & Implementation


Comparison between the different supported module types
  • Internals
    • Data Model / MRML - Objects and their organization. MRML Library provides API for managing medical image data type
    • Logics - Details the role of MRML/Slicer/Application/Modules logics and Displayable managers
    • IO Mechanism - How to read or write nodes from file
Presents the underlying infrastructure.
Description of the Charting architecture.
Details how Slicer is built, packaged and released.

How To










Slicer4Announcement-HiRes.png