Difference between revisions of "Documentation"

From mitk.org
Jump to navigation Jump to search
 
(56 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
+
__TOC__
= Documentation on MITK =
 
  
== General information ==
+
== Latest stable release: MITK 2023.12 ==
  
* 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]]
+
* [https://phabricator.mitk.org/w/mitk/changelog/release-v2023.12/ Changelog]
* [[Interaction_concept|Interaction]] concept of MITK
+
* [https://docs.mitk.org/2023.12/UserManualPortal.html User Manual]
* [[Undo_concept|Undo/Redo]] concept of MITK
+
* [https://docs.mitk.org/2023.12/ API documentation and concepts]
* [[Interactive_segmentation|Interactive segmentation]] is a program module of the MITK application
+
* [https://docs.mitk.org/2023.12/TutorialPage.html Tutorial]
 +
 
 +
== Mailinglist ==
 +
We have a [[Mailinglist]] for MITK. Searching the archives could help to find answers to your questions. Of course, posting your questions to the mailing list will get you an answer, too.
  
 
== Nightly generated documentation ==
 
== Nightly generated documentation ==
 +
Documentation is also generated nightly from the MITK Git repository:
  
Documentation is generated nightly by Doxygen from the MITK subversion repository:
+
* [https://docs.mitk.org/nightly/UserManualPortal.html User Manual]
 
+
* [https://docs.mitk.org/nightly/ API documentation and concepts]
* [http://docs.mitk.org/nightly-qt4/ Documentation (MITK with Qt4)]
 
* [http://docs.mitk.org/nightly-qt4/TutorialPage.html Tutorial]  
 
* ''Deprecated'': [http://docs.mitk.org/nightly/ Documentation (MITK with Qt3)]
 
 
 
== Documentation for released versions ==
 
 
 
{| border="1" cellpadding="2" cellspacing="0"
 
|  '''Version'''
 
|  '''Release date'''
 
|  '''Download link'''
 
|  '''Documentation'''
 
|  '''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 ==
 
 
 
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]].
 
 
 
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 ==
+
== BlueBerry documentation ==
 +
The BlueBerry framework has its own doxygen documentation [http://docs.mitk.org/nightly/BlueBerryIntro.html here].
  
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]].
+
== Documentation of old MITK releases ==
  
== MITK workshop at the BVM Conference 2010 ==
+
[https://docs.mitk.org/ docs.mitk.org]
 
 
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 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:
 
 
 
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. [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.
 

Latest revision as of 18:16, 30 November 2023

Latest stable release: MITK 2023.12

Mailinglist

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

Nightly generated documentation

Documentation is also generated nightly from the MITK Git repository:

BlueBerry documentation

The BlueBerry framework has its own doxygen documentation here.

Documentation of old MITK releases

docs.mitk.org