Difference between revisions of "Documentation"
Jump to navigation
Jump to search
MarcoNolden (talk | contribs) |
MarcoNolden (talk | contribs) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
= Documentation on MITK = | = Documentation on MITK = | ||
| − | == | + | |
| + | === Latest release: MITK 2012-06 === | ||
| + | |||
| + | * [[MITK-ReleaseNotes-2012-06| Release notes]] | ||
* [http://docs.mitk.org/2012.06/MITKUserManualPage.html User Manual] | * [http://docs.mitk.org/2012.06/MITKUserManualPage.html User Manual] | ||
| + | * [http://docs.mitk.org/2012.06/ API documentation and concepts] | ||
| + | * [http://docs.mitk.org/2012.06/TutorialPage.html Tutorial] | ||
| + | |||
| + | Older version are [[#Documentation for all released versions|further down]] on this page. | ||
| + | |||
| + | === Nightly generated documentation === | ||
| + | |||
| + | * [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] | ||
| + | |||
| + | Documentation is also generated nightly by Doxygen from the MITK Git repository: | ||
| + | |||
| + | == 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 [[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. | ||
| + | |||
| + | == 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]] | * 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 9: | Line 36: | ||
* [[Interactive_segmentation|Interactive segmentation]] is a program module of the MITK application | * [[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 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]] | |
| − | + | ||
| + | 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 [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. | ||
| − | == Documentation for released versions == | + | == Documentation for all released versions == |
{| border="1" cellpadding="2" cellspacing="0" | {| border="1" cellpadding="2" cellspacing="0" | ||
| '''Version''' | | '''Version''' | ||
| Line 90: | Line 135: | ||
| [http://docs.mitk.org/0.4/ API] | | [http://docs.mitk.org/0.4/ API] | ||
| [http://docs.mitk.org/0.4/TutorialPage.html Tutorial] | | [http://docs.mitk.org/0.4/TutorialPage.html Tutorial] | ||
| − | | | + | | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 09:36, 20 June 2012
Documentation on MITK
Latest release: MITK 2012-06
Older version are further down on this page.
Nightly generated documentation
Documentation is also generated nightly by Doxygen from the MITK Git repository:
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.
Other documentation
- Getting started with the demo application: MITK 3M3 introduction , a bit outdated: Media:Documentation$MITK-MainApp-Getting-Started.pdf
- Interaction concept of MITK
- Undo/Redo concept of MITK
- PPT-slide on Interaction and Undo in MITK (from MITK seminar 2010): Media:Documentation$MITK-InteractionAndUndo.pdf
- 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 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.
Documentation for all released versions
| Version | Release date | Download link | Documentation | ||
| 2012.06.00 | 15.06.2012 | only online | API | Tutorial | User Manual |
| 2012.02.00 | 07.02.2012 | only online | API | Tutorial | User Manual |
| 0.99.3 | 15-Dec-2010 | only online | API | Tutorial | |
| 0.14 | 22-Dec-2009 | only online | API | Tutorial | |
| 0.12.2 | 12-Jun-2009 | Download | API | Tutorial | |
| 0.12 | 07-May-2009 | Download | API | Tutorial | |
| 0.10 | 21-Nov-2008 | Download | API | Tutorial | |
| 0.8 | 19-Dec-2007 | Download | API | Tutorial | |
| 0.6 | 27-Jun-2006 | Download | API | Tutorial | |
| 0.4 | 21-Oct-2005 | Download | API | Tutorial | |