Difference between revisions of "Documentation"

From mitk.org
Jump to navigation Jump to search
 
(36 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
+
__TOC__
= Documentation on MITK =
 
  
=== Latest release: MITK 2013-12-0 ===
+
== Latest stable release: MITK 2023.12 ==
  
* [[MITK-ReleaseNotes-2013-12| Release notes]]
+
* [https://phabricator.mitk.org/w/mitk/changelog/release-v2023.12/ Changelog]
* [http://docs.mitk.org/2013.12/MITKUserManualPage.html User Manual]
+
* [https://docs.mitk.org/2023.12/UserManualPortal.html User Manual]
* [http://docs.mitk.org/2013.12/ API documentation and concepts]
+
* [https://docs.mitk.org/2023.12/ API documentation and concepts]
* [http://docs.mitk.org/2013.12/TutorialPage.html Tutorial]
+
* [https://docs.mitk.org/2023.12/TutorialPage.html Tutorial]
  
Older version are [[#Documentation for all released versions|further down]] on this page.
+
== 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 by Doxygen from the MITK Git repository:
 
 
 
* [http://docs.mitk.org/nightly-qt4/ API Documentation]
 
* [http://docs.mitk.org/nightly-qt4/TutorialPage.html Tutorial]
 
* [http://docs.mitk.org/nightly-qt4/MITKUserManualPage.html User Manual]
 
 
 
== 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 http://docs.mitk.org/nightly-qt4/HowToNewProject.html.
 
 
 
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 ==
 
 
 
* 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
 
* [[Undo_concept|Undo/Redo]] concept of MITK
 
* PPT-slide on Interaction and Undo in MITK (from MITK seminar 2010): [[Media:Documentation$MITK-InteractionAndUndo.pdf]]
 
* [[Interactive_segmentation|Interactive segmentation]] is a program module of the MITK application
 
 
 
== 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 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 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):
 
 
 
MITK: [[Media:Documentation$MITK-BVM10.pdf]]
 
  
[[BlueBerry]] framework: [[Media:Documentation$BlueBerry-BVM10.pdf]]
+
== Nightly generated documentation ==
 +
Documentation is also generated nightly from the MITK Git repository:
  
MITK-IGT: [[Media:Documentation$MITK-IGT-BVM10.pdf]]
+
* [https://docs.mitk.org/nightly/UserManualPortal.html User Manual]
 +
* [https://docs.mitk.org/nightly/ API documentation and concepts]
  
== MITK workshop at the BVM Conference 2009 ==
+
== BlueBerry documentation ==
In March 2009 we held a tutorial on MITK during the conference [http://www.bvm-workshop.org/ BVM]. Here are the slides:
+
The BlueBerry framework has its own doxygen documentation [http://docs.mitk.org/nightly/BlueBerryIntro.html here].
  
Data management in MITK: [[Media:Documentation$MITK-DataManagement-bvm09.pdf]]
+
== Documentation of old MITK releases ==
 
 
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.
 
  
== Documentation for all released versions ==
+
[https://docs.mitk.org/ docs.mitk.org]
{| border="1" cellpadding="2" cellspacing="0"
 
| '''Version'''
 
| '''Release date'''
 
| '''Download link'''
 
|colspan=3 align="center" | '''Documentation'''
 
|-
 
| '''2013.12.00'''
 
| 09.12.2013
 
| only online
 
| [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
 
| only online
 
| [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
 
| only online
 
| [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
 
| only online
 
| [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
 
| only online
 
| [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
 
| only online
 
| [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
 
| only online
 
| [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
 
| only online
 
| [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]
 
|-
 
| 0.99.3
 
| 15-Dec-2010
 
| only online
 
| [http://docs.mitk.org/0.99.3/ API]
 
| [http://docs.mitk.org/0.99.3/TutorialPage.html Tutorial]
 
 
|-
 
| 0.14
 
| 22-Dec-2009
 
| only online
 
| [http://docs.mitk.org/0.14/ API]
 
| [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/ API]
 
| [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/ API]
 
| [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/ API]
 
| [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/ API]
 
| [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/ API]
 
| [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/ API]
 
| [http://docs.mitk.org/0.4/TutorialPage.html Tutorial]  
 
|
 

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