Difference between revisions of "Documentation"

From mitk.org
Jump to navigation Jump to search
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
= Documentation on MITK =
 
= Documentation on MITK =
 
 
== General information ==
 
== General information ==
 
 
* Getting started with the demo application: [http://mint-medical.de/wp-content/mitk3m3_documentation/index.html MITK 3M3 introduction] , a bit outdated:  [[Media:Documentation$MITK-MainApp-Getting-Started.pdf]]
 
* Getting started with the demo application: [http://mint-medical.de/wp-content/mitk3m3_documentation/index.html MITK 3M3 introduction] , a bit outdated:  [[Media:Documentation$MITK-MainApp-Getting-Started.pdf]]
 
* [[Interaction_concept|Interaction]] concept of MITK
 
* [[Interaction_concept|Interaction]] concept of MITK
Line 11: Line 9:
  
 
== Nightly generated documentation ==
 
== Nightly generated documentation ==
 
 
Documentation is generated nightly by Doxygen from the MITK subversion repository:
 
Documentation is generated nightly by Doxygen from the MITK subversion repository:
  
 
* [http://docs.mitk.org/nightly-qt4/ Documentation (MITK with Qt4)]
 
* [http://docs.mitk.org/nightly-qt4/ Documentation (MITK with Qt4)]
* [http://docs.mitk.org/nightly-qt4/TutorialPage.html Tutorial]  
+
* [http://docs.mitk.org/nightly-qt4/TutorialPage.html Tutorial]
 
* ''Deprecated'': [http://docs.mitk.org/nightly/ Documentation (MITK with Qt3)]
 
* ''Deprecated'': [http://docs.mitk.org/nightly/ Documentation (MITK with Qt3)]
  
 
== Documentation for released versions ==
 
== Documentation for released versions ==
 
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
| '''Version'''  
+
| '''Version'''  
| '''Release date'''  
+
| '''Release date'''  
| '''Download link'''  
+
| '''Download link'''  
| '''Documentation'''  
+
| '''Documentation'''  
| '''Tutorial'''  
+
| '''Tutorial'''  
 
|-
 
|-
| '''0.99.3'''  
+
| '''0.99.3'''  
| 15-Dec-2010  
+
| 15-Dec-2010  
| only online  
+
| only online  
| [http://docs.mitk.org/0.99.3/ Documentation]  
+
| [http://docs.mitk.org/0.99.3/ Documentation]  
| [http://docs.mitk.org/0.99.3/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.99.3/TutorialPage.html Tutorial]  
 
|-
 
|-
| '''0.14'''  
+
| '''0.14'''  
| 22-Dec-2009  
+
| 22-Dec-2009  
| only online  
+
| only online  
| [http://docs.mitk.org/0.14/ Documentation]  
+
| [http://docs.mitk.org/0.14/ Documentation]  
| [http://docs.mitk.org/0.14/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.14/TutorialPage.html Tutorial]  
 
|-
 
|-
| 0.12.2  
+
| 0.12.2  
| 12-Jun-2009  
+
| 12-Jun-2009  
| [http://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=688539 Download]  
+
| [http://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=688539 Download]  
| [http://docs.mitk.org/0.12/ Documentation]  
+
| [http://docs.mitk.org/0.12/ Documentation]  
| [http://docs.mitk.org/0.12/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.12/TutorialPage.html Tutorial]  
 
|-
 
|-
| 0.12  
+
| 0.12  
| 07-May-2009  
+
| 07-May-2009  
| [http://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=681022 Download]  
+
| [http://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=681022 Download]  
| [http://docs.mitk.org/0.12/ Documentation]  
+
| [http://docs.mitk.org/0.12/ Documentation]  
| [http://docs.mitk.org/0.12/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.12/TutorialPage.html Tutorial]  
 
|-
 
|-
| 0.10  
+
| 0.10  
| 21-Nov-2008  
+
| 21-Nov-2008  
| [http://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=633472 Download]  
+
| [http://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=633472 Download]  
| [http://docs.mitk.org/0.10/ Documentation]  
+
| [http://docs.mitk.org/0.10/ Documentation]  
| [http://docs.mitk.org/0.10/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.10/TutorialPage.html Tutorial]  
 
|-
 
|-
|   0.8  
+
| 0.8  
| 19-Dec-2007
+
| 19-Dec-2007  
| [https://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=562760 Download]  
+
| [https://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=562760 Download]  
| [http://docs.mitk.org/0.8/ Documentation]  
+
| [http://docs.mitk.org/0.8/ Documentation]  
| [http://docs.mitk.org/0.8/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.8/TutorialPage.html Tutorial]  
 
|-
 
|-
|   0.6  
+
| 0.6  
| 27-Jun-2006  
+
| 27-Jun-2006  
| [https://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=427988 Download]  
+
| [https://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=427988 Download]  
| [http://docs.mitk.org/0.6/ Documentation]  
+
| [http://docs.mitk.org/0.6/ Documentation]  
| [http://docs.mitk.org/0.6/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.6/TutorialPage.html Tutorial]  
 
|-
 
|-
|   0.4  
+
| 0.4  
| 21-Oct-2005  
+
| 21-Oct-2005  
| [https://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=365046 Download]  
+
| [https://sourceforge.net/project/showfiles.php?group_id=147803&package_id=162973&release_id=365046 Download]  
| [http://docs.mitk.org/0.4/ Documentation]  
+
| [http://docs.mitk.org/0.4/ Documentation]  
| [http://docs.mitk.org/0.4/TutorialPage.html Tutorial]  
+
| [http://docs.mitk.org/0.4/TutorialPage.html Tutorial]  
 
|}
 
|}
  
 
== Qt4 and [[BlueBerry]] documentation ==
 
== Qt4 and [[BlueBerry]] documentation ==
 
 
The [[BlueBerry]] framework has its own doxygen documentation [http://docs.mitk.org/nightly-qt4/BlueBerry/reference/api/html/index.html here].
 
The [[BlueBerry]] framework has its own doxygen documentation [http://docs.mitk.org/nightly-qt4/BlueBerry/reference/api/html/index.html here].
  
To get started read [[SetupMitkQt4BlueBerry]].
+
To get started read [[SetupAMitkBasedProject]].
  
 
Porting existing Qt3/MITK code to Qt4 is documented here (currently German only): [[PortingMitkQt4]], [[PortingMitkQt4UiFiles]]
 
Porting existing Qt3/MITK code to Qt4 is documented here (currently German only): [[PortingMitkQt4]], [[PortingMitkQt4UiFiles]]
Line 87: Line 82:
  
 
== Bug Squashing Seminars ==
 
== Bug Squashing Seminars ==
 
 
Once a week we start our bug squashing party with a short talk about some MITK or software related topicv. The seminar slides are collected on [[BugSquashingSeminars]].
 
Once a week we start our bug squashing party with a short talk about some MITK or software related topicv. The seminar slides are collected on [[BugSquashingSeminars]].
  
 
== MITK workshop at the BVM Conference 2010 ==
 
== MITK workshop at the BVM Conference 2010 ==
 
+
In March 2010 we held another tutorial on MITK during the conference [http://www.bvm-workshop.org/ BVM]. Here are the slides (some are only in German):
In March 2010 we held another tutorial on MITK during the conference [http://www.bvm-workshop.org/ BVM].
 
Here are the slides (some are only in German):
 
  
 
MITK: [[Media:Documentation$MITK-BVM10.pdf]]
 
MITK: [[Media:Documentation$MITK-BVM10.pdf]]
Line 102: Line 94:
  
 
== MITK workshop at the BVM Conference 2009 ==
 
== MITK workshop at the BVM Conference 2009 ==
 
+
In March 2009 we held a tutorial on MITK during the conference [http://www.bvm-workshop.org/ BVM]. Here are the slides:
In March 2009 we held a tutorial on MITK during the conference [http://www.bvm-workshop.org/ BVM].
 
Here are the slides:
 
  
 
Data management in MITK: [[Media:Documentation$MITK-DataManagement-bvm09.pdf]]
 
Data management in MITK: [[Media:Documentation$MITK-DataManagement-bvm09.pdf]]

Revision as of 00:43, 6 July 2011

Documentation on MITK

General information

Nightly generated documentation

Documentation is generated nightly by Doxygen from the MITK subversion repository:

Documentation for released versions

Version Release date Download link Documentation Tutorial
0.99.3 15-Dec-2010 only online Documentation Tutorial
0.14 22-Dec-2009 only online Documentation Tutorial
0.12.2 12-Jun-2009 Download Documentation Tutorial
0.12 07-May-2009 Download Documentation Tutorial
0.10 21-Nov-2008 Download Documentation Tutorial
0.8 19-Dec-2007 Download Documentation Tutorial
0.6 27-Jun-2006 Download Documentation Tutorial
0.4 21-Oct-2005 Download Documentation Tutorial

Qt4 and BlueBerry documentation

The BlueBerry framework has its own doxygen documentation here.

To get started read SetupAMitkBasedProject.

Porting existing Qt3/MITK code to Qt4 is documented here (currently German only): PortingMitkQt4, PortingMitkQt4UiFiles

Read the MITK PluginStyleGuide for more information about the structure and content of a MITK Plug-in.

Bug Squashing Seminars

Once a week we start our bug squashing party with a short talk about some MITK or software related topicv. The seminar slides are collected on BugSquashingSeminars.

MITK workshop at the BVM Conference 2010

In March 2010 we held another tutorial on MITK during the conference BVM. Here are the slides (some are only in German):

MITK: Media:Documentation$MITK-BVM10.pdf

BlueBerry framework: Media:Documentation$BlueBerry-BVM10.pdf

MITK-IGT: Media:Documentation$MITK-IGT-BVM10.pdf

MITK workshop at the BVM Conference 2009

In March 2009 we held a tutorial on MITK during the conference BVM. Here are the slides:

Data management in MITK: Media:Documentation$MITK-DataManagement-bvm09.pdf

Introduction to MITK-IGT: Media:Documentation$MITK-IGT-BVM09.pdf

Introduction to openCherry: Media:Documentation$openCherry-BVM09.pdf

Mailinglist

We maintain a Mailinglist for MITK. Searching the archives with GMane could help to find answers to your questions. Of course, posting your questions to the mailing list will get you an answer too.