Difference between revisions of "Documentation"

From mitk.org
Jump to navigation Jump to search
(Added 2012.06 release)
(44 intermediate revisions by 8 users not shown)
Line 1: Line 1:
−
__NOTOC__
+
__TOC__
−
= Documentation on MITK =
+
 
−
== 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]]
+
== Latest release: MITK 2018.04.2 ==
−
* [[Interaction_concept|Interaction]] concept of MITK
+
 
−
* [[Undo_concept|Undo/Redo]] concept of MITK
+
* [[MITK_ReleaseNotes_2018.04.2| Release notes]]
−
* PPT-slide on Interaction and Undo in MITK (from MITK seminar 2010): [[Media:Documentation$MITK-InteractionAndUndo.pdf]]
+
* [http://docs.mitk.org/2018.04/MITKUserManualPage.html User Manual]
−
* [[Interactive_segmentation|Interactive segmentation]] is a program module of the MITK application
+
* [http://docs.mitk.org/2018.04/ API documentation and concepts]
 +
* [http://docs.mitk.org/2018.04/TutorialPage.html Tutorial]
 +
 
 +
Older version are [[#Documentation for all released versions|further down]] on this page.
  
 
== Nightly generated documentation ==
 
== Nightly generated documentation ==
−
Documentation is generated nightly by Doxygen from the MITK Git repository:
+
Documentation is also generated nightly by Doxygen from the MITK Git repository:
  
−
* [http://docs.mitk.org/nightly-qt4/ Documentation (MITK with Qt4)]
+
* [https://docs.mitk.org/nightly/ API Documentation]
−
* [http://docs.mitk.org/nightly-qt4/TutorialPage.html Tutorial]
+
* [https://docs.mitk.org/nightly/TutorialPage.html Tutorial]
 +
* [https://docs.mitk.org/nightly/UserManualPortal.html User Manual]
  
−
== Documentation for released versions ==
+
== BlueBerry documentation ==
−
{| border="1" cellpadding="2" cellspacing="0"
+
The BlueBerry framework has its own doxygen documentation [http://docs.mitk.org/nightly/BlueBerryIntro.html here].
−
| '''Version'''
 
−
| '''Release date'''
 
−
| '''Download link'''
 
−
| '''Documentation'''
 
−
| '''Tutorial'''
 
−
|-
 
−
| '''2012.06.00'''
 
−
| 15.06.2012
 
−
| only online
 
−
| [http://docs.mitk.org/2012.06/ Documentation]
 
−
|  [http://docs.mitk.org/2012.06/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.99.3
 
−
| 15-Dec-2010
 
−
| only online
 
−
| [http://docs.mitk.org/0.99.3/ Documentation]
 
−
| [http://docs.mitk.org/0.99.3/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.14
 
−
| 22-Dec-2009
 
−
| only online
 
−
| [http://docs.mitk.org/0.14/ Documentation]
 
−
| [http://docs.mitk.org/0.14/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.12.2
 
−
| 12-Jun-2009
 
−
| [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/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.12
 
−
| 07-May-2009
 
−
| [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/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.10
 
−
| 21-Nov-2008
 
−
| [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/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.8
 
−
| 19-Dec-2007
 
−
| [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/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.6
 
−
| 27-Jun-2006
 
−
| [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/TutorialPage.html Tutorial]
 
−
|-
 
−
| 0.4
 
−
| 21-Oct-2005
 
−
| [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/TutorialPage.html Tutorial]
 
−
|}
 
  
−
== Qt4 and [[BlueBerry]] documentation ==
+
To get started read [http://docs.mitk.org/nightly/HowToNewProject.html HowToNewProject].
−
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 [[SetupAMitkBasedProject]].
+
Read the MITK [[PluginStyleGuide| Plugin Style Guide]] for more information about the structure and content of a MITK Plug-in.
  
−
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.
+
== Other documentation ==
 +
* [[Interaction_concept|Interaction]] concept of MITK
 +
* [[Undo_concept|Undo/Redo]] concept of MITK
 +
* PPT-slide on Interaction and Undo in MITK (from MITK seminar 2010): [[Media:Documentation$MITK-InteractionAndUndo.pdf|MITK Interaction and Undo 2010]]
 +
* [[Interactive_segmentation|Interactive segmentation]] is a program module of the MITK application
  
 
== 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 ==
+
 
 +
<div class="mw-collapsible mw-collapsed">
 +
== MITK workshop at the BVM Conference ==
 +
 
 +
 
 +
<div class="mw-collapsible-content">
 +
'''MITK workshop at the BVM Conference  2013'''
 +
In March 2013 we held yet another tutorial on MITK during the conference [http://www.bvm-workshop.org/ BVM]. Here are the slides:
 +
 
 +
[[Media:Documentation$MITK-Tutorial-BVM-2013.pdf| MITK Tutorial BVM 2013]]
 +
 
 +
 
 +
'''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| MITK Tutorial BVM 2010]]
  
−
[[BlueBerry]] framework: [[Media:Documentation$BlueBerry-BVM10.pdf]]
+
BlueBerry framework: [[Media:Documentation$BlueBerry-BVM10.pdf| BlueBerry BVM 2010]]
  
−
MITK-IGT: [[Media:Documentation$MITK-IGT-BVM10.pdf]]
+
MITK-IGT: [[Media:Documentation$MITK-IGT-BVM10.pdf| MITK IGT BVM 2010]]
  
−
== 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|DataManagement BVM 2009]]
 +
 
 +
Introduction to MITK-IGT: [[Media:Documentation$MITK-IGT-BVM09.pdf|MITK IGT BVM 2009]]
 +
 
 +
Introduction to openCherry: [[Media:Documentation$openCherry-BVM09.pdf|openCherry BVM 2009]]
 +
</div></div>
  
−
Introduction to MITK-IGT: [[Media:Documentation$MITK-IGT-BVM09.pdf]]
 
  
−
Introduction to openCherry: [[Media:Documentation$openCherry-BVM09.pdf]]
 
  
 
== Mailinglist ==
 
== Mailinglist ==
 
We maintain a [[Mailinglist]] for MITK. [http://dir.gmane.org/gmane.comp.lib.mitk.user 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.
 
We maintain a [[Mailinglist]] for MITK. [http://dir.gmane.org/gmane.comp.lib.mitk.user 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.
 +
 +
 +
== Documentation for all released versions ==
 +
 +
{| class="wikitable" width=100% style="background-color:#ffffff;"
 +
| '''Version'''
 +
| '''Release date'''
 +
|colspan=3 align="center" | '''Documentation'''
 +
|-
 +
| 2018.04.00
 +
| 03.12.2018
 +
| [http://docs.mitk.org/2018.04/ API]
 +
|  [http://docs.mitk.org/2018.04/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2018.04/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2016.11.00
 +
| 03.02.2017
 +
| [http://docs.mitk.org/2016.11/ API]
 +
|  [http://docs.mitk.org/2016.11/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2016.11/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2016.03.00
 +
| 15.04.2016
 +
| [http://docs.mitk.org/2016.03/ API]
 +
|  [http://docs.mitk.org/2016.03/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2016.03/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2015.05.00
 +
| 18.06.2015
 +
| [http://docs.mitk.org/2015.05/ API]
 +
|  [http://docs.mitk.org/2015.05/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2015.05/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2014.03.00
 +
| 15.04.2014
 +
| [http://docs.mitk.org/2014.03/ API]
 +
|  [http://docs.mitk.org/2014.03/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2014.03/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2013.12.00
 +
| 09.12.2013
 +
| [http://docs.mitk.org/2013.12/ API]
 +
|  [http://docs.mitk.org/2013.12/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2013.12/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2013.09.00
 +
| 07.10.2013
 +
| [http://docs.mitk.org/2013.09/ API]
 +
|  [http://docs.mitk.org/2013.09/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2013.09/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2013.06.00
 +
| 28.06.2013
 +
| [http://docs.mitk.org/2013.06/ API]
 +
|  [http://docs.mitk.org/2013.06/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2013.06/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2013.03.00
 +
| 31.03.2013
 +
| [http://docs.mitk.org/2013.03/ API]
 +
|  [http://docs.mitk.org/2013.03/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2013.03/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2012.12.00
 +
| 20.12.2012
 +
| [http://docs.mitk.org/2012.12/ API]
 +
|  [http://docs.mitk.org/2012.12/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2012.12/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2012.09.00
 +
| 25.09.2012
 +
| [http://docs.mitk.org/2012.09/ API]
 +
|  [http://docs.mitk.org/2012.09/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2012.09/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2012.06.00
 +
| 15.06.2012
 +
| [http://docs.mitk.org/2012.06/ API]
 +
|  [http://docs.mitk.org/2012.06/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2012.06/MITKUserManualPage.html User Manual]
 +
|-
 +
| 2012.02.00
 +
| 07.02.2012
 +
| [http://docs.mitk.org/2012.02.0/ API]
 +
|  [http://docs.mitk.org/2012.02.0/TutorialPage.html Tutorial]
 +
|  [http://docs.mitk.org/2012.02.0/MITKManualMainPage.html User Manual]
 +
|}

Revision as of 13:08, 23 October 2020


Latest release: MITK 2018.04.2

Older version are further down on this page.

Nightly generated documentation

Documentation is also generated nightly by Doxygen from the MITK Git repository:

BlueBerry documentation

The BlueBerry framework has its own doxygen documentation here.

To get started read HowToNewProject.

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


Other documentation

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

MITK workshop at the BVM Conference 2013 In March 2013 we held yet another tutorial on MITK during the conference BVM. Here are the slides:

MITK Tutorial BVM 2013


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: MITK Tutorial BVM 2010

BlueBerry framework: BlueBerry BVM 2010

MITK-IGT: MITK IGT BVM 2010


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: DataManagement BVM 2009

Introduction to MITK-IGT: MITK IGT BVM 2009

Introduction to openCherry: openCherry BVM 2009


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.


Documentation for all released versions

Version Release date Documentation
2018.04.00 03.12.2018 API Tutorial User Manual
2016.11.00 03.02.2017 API Tutorial User Manual
2016.03.00 15.04.2016 API Tutorial User Manual
2015.05.00 18.06.2015 API Tutorial User Manual
2014.03.00 15.04.2014 API Tutorial User Manual
2013.12.00 09.12.2013 API Tutorial User Manual
2013.09.00 07.10.2013 API Tutorial User Manual
2013.06.00 28.06.2013 API Tutorial User Manual
2013.03.00 31.03.2013 API Tutorial User Manual
2012.12.00 20.12.2012 API Tutorial User Manual
2012.09.00 25.09.2012 API Tutorial User Manual
2012.06.00 15.06.2012 API Tutorial User Manual
2012.02.00 07.02.2012 API Tutorial User Manual
Retrieved from "http://mitk.org/w/index.php?title=Documentation&oldid=3584"