Difference between revisions of "Documentation"
CasparGoch (talk | contribs) (Down with the brackets) |
|||
(37 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
− | + | __TOC__ | |
− | |||
− | |||
− | * [[ | + | == Latest release: MITK 2018.04.2 == |
− | * [http://docs.mitk.org/ | + | |
− | * [http://docs.mitk.org/ | + | * [[MITK_ReleaseNotes_2018.04.2| Release notes]] |
− | * [http://docs.mitk.org/ | + | * [http://docs.mitk.org/2018.04/MITKUserManualPage.html User Manual] |
+ | * [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. | Older version are [[#Documentation for all released versions|further down]] on this page. | ||
− | + | == Nightly generated documentation == | |
− | |||
Documentation is also generated nightly by Doxygen from the MITK Git repository: | Documentation is also generated nightly by Doxygen from the MITK Git repository: | ||
− | * [ | + | * [https://docs.mitk.org/nightly/ API Documentation] |
− | * [ | + | * [https://docs.mitk.org/nightly/TutorialPage.html Tutorial] |
− | * [ | + | * [https://docs.mitk.org/nightly/UserManualPortal.html User Manual] |
− | == | + | == BlueBerry documentation == |
− | The | + | The BlueBerry framework has its own doxygen documentation [http://docs.mitk.org/nightly/BlueBerryIntro.html here]. |
− | To get started read http://docs.mitk.org/nightly | + | To get started read [http://docs.mitk.org/nightly/HowToNewProject.html HowToNewProject]. |
− | + | Read the MITK [[PluginStyleGuide| Plugin Style Guide]] for more information about the structure and content of a MITK Plug-in. | |
− | |||
== Other documentation == | == Other documentation == | ||
− | |||
− | |||
* [[Interaction_concept|Interaction]] concept of MITK | * [[Interaction_concept|Interaction]] concept of MITK | ||
* [[Undo_concept|Undo/Redo]] 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]] | + | * 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 | * [[Interactive_segmentation|Interactive segmentation]] is a program module of the MITK application | ||
Line 39: | Line 35: | ||
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 | + | |
+ | <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 BVM 2010]] | ||
− | + | MITK-IGT: [[Media:Documentation$MITK-IGT-BVM10.pdf| MITK IGT BVM 2010]] | |
− | |||
− | + | '''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> | ||
− | |||
− | |||
== 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 == | == Documentation for all released versions == | ||
− | {| | + | |
+ | {| class="wikitable" width=100% style="background-color:#ffffff;" | ||
| '''Version''' | | '''Version''' | ||
| '''Release date''' | | '''Release date''' | ||
− | |||
|colspan=3 align="center" | '''Documentation''' | |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 | | 25.09.2012 | ||
− | |||
| [http://docs.mitk.org/2012.09/ API] | | [http://docs.mitk.org/2012.09/ API] | ||
| [http://docs.mitk.org/2012.09/TutorialPage.html Tutorial] | | [http://docs.mitk.org/2012.09/TutorialPage.html Tutorial] | ||
Line 76: | Line 148: | ||
| 2012.06.00 | | 2012.06.00 | ||
| 15.06.2012 | | 15.06.2012 | ||
− | |||
| [http://docs.mitk.org/2012.06/ API] | | [http://docs.mitk.org/2012.06/ API] | ||
| [http://docs.mitk.org/2012.06/TutorialPage.html Tutorial] | | [http://docs.mitk.org/2012.06/TutorialPage.html Tutorial] | ||
Line 83: | Line 154: | ||
| 2012.02.00 | | 2012.02.00 | ||
| 07.02.2012 | | 07.02.2012 | ||
− | |||
| [http://docs.mitk.org/2012.02.0/ API] | | [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/TutorialPage.html Tutorial] | ||
| [http://docs.mitk.org/2012.02.0/MITKManualMainPage.html User Manual] | | [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
- Interaction concept of MITK
- Undo/Redo concept of MITK
- PPT-slide on Interaction and Undo in MITK (from MITK seminar 2010): MITK Interaction and Undo 2010
- 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
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 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 |