diff --git a/Documentation/Doxygen/DeveloperManual/DeveloperManualPortal.dox b/Documentation/Doxygen/DeveloperManual/DeveloperManualPortal.dox index aa9276cf30..7ad07afc68 100644 --- a/Documentation/Doxygen/DeveloperManual/DeveloperManualPortal.dox +++ b/Documentation/Doxygen/DeveloperManual/DeveloperManualPortal.dox @@ -1,31 +1,31 @@ /** \page DeveloperManualPortal MITK: Developer Manual -Development with MITK can happen under several disctinct conditions. Depending on whether you are using the Toolkit or the entire application, different sections may apply to you. In case you are unsure about what you need, please refer to \link Architecture The Architecture of MITK text\endlink. An extensive Introduction to MITK is available under \link StartingDevelopment Starting your MITK Development\endlink. +Development with MITK can happen under several conditions. Depending on whether you are using the Toolkit or the entire application, different sections may apply to you. In case you are unsure about what you need, please refer to \link Architecture The Architecture of MITK text\endlink. An extensive Introduction to MITK is available under \link StartingDevelopment Starting your MITK Development\endlink. Depending on whether you are working with the \link DevelopmentToolkit Toolkit\endlink or the \link DevelopmentApplication Application\endlink, you can refer to their respective pages. Generated API-Documentation can be found \link DevelopmentAPI here\endlink. \section DeveloperManualStarting Starting your MITK Development */ diff --git a/Documentation/Doxygen/DeveloperManual/Starting/FirstSteps/FirstSteps.dox b/Documentation/Doxygen/DeveloperManual/Starting/FirstSteps/FirstSteps.dox index 72d5728de0..c447f4c886 100644 --- a/Documentation/Doxygen/DeveloperManual/Starting/FirstSteps/FirstSteps.dox +++ b/Documentation/Doxygen/DeveloperManual/Starting/FirstSteps/FirstSteps.dox @@ -1,13 +1,13 @@ /** \page FirstSteps First steps in Development -TODO +This section will show you how to extend MITK for your own project. */ diff --git a/Documentation/Doxygen/DeveloperManual/Starting/GettingToKnow/GettingToKnowMITK.dox b/Documentation/Doxygen/DeveloperManual/Starting/GettingToKnow/GettingToKnowMITK.dox index e418a0b301..898696a69a 100644 --- a/Documentation/Doxygen/DeveloperManual/Starting/GettingToKnow/GettingToKnowMITK.dox +++ b/Documentation/Doxygen/DeveloperManual/Starting/GettingToKnow/GettingToKnowMITK.dox @@ -1,14 +1,15 @@ /** \page GettingToKnowMITK Getting to know MITK -TODO +This section will show you around MITK and acquaint you with the basic concepts. + */ diff --git a/Documentation/Doxygen/DeveloperManual/Starting/SettingUpMITK/SettingUpMITK.dox b/Documentation/Doxygen/DeveloperManual/Starting/SettingUpMITK/SettingUpMITK.dox index 5b67763c66..8bfd90a9a2 100644 --- a/Documentation/Doxygen/DeveloperManual/Starting/SettingUpMITK/SettingUpMITK.dox +++ b/Documentation/Doxygen/DeveloperManual/Starting/SettingUpMITK/SettingUpMITK.dox @@ -1,14 +1,14 @@ /** \page SettingUpMITK Setting Up Mitk -TODO +This section will get you started with your MITK Development environment. */ diff --git a/Documentation/Doxygen/DeveloperManual/Starting/Starting.dox b/Documentation/Doxygen/DeveloperManual/Starting/Starting.dox index fa78a1bb8d..e0a56cddbb 100644 --- a/Documentation/Doxygen/DeveloperManual/Starting/Starting.dox +++ b/Documentation/Doxygen/DeveloperManual/Starting/Starting.dox @@ -1,37 +1,44 @@ /** \page StartingDevelopment Starting your MITK Development -This Introduction will acquaint you with the most important workflows to get you started with your MITK Development. +This Introduction will acquaint you with the most important work flows to get you started with your MITK Development. +First, \ref Architecture will explain the difference between the application and the toolkit. +\ref SettingUpMITK will get you started with a working MITK Development environment. \GettingToKnowMITK will walk you trough the folder structure and the module and plugin system. This chapter also contains an extensive tutorial on how to work with MITK. +The \ref FirstSteps section will then show you how to extend MITK for your own project. + + + */ diff --git a/Documentation/Doxygen/DeveloperManual/Toolkit/DevelopmentToolkit.dox b/Documentation/Doxygen/DeveloperManual/Toolkit/DevelopmentToolkit.dox index ae77b729ea..19ed8049b3 100644 --- a/Documentation/Doxygen/DeveloperManual/Toolkit/DevelopmentToolkit.dox +++ b/Documentation/Doxygen/DeveloperManual/Toolkit/DevelopmentToolkit.dox @@ -1,13 +1,15 @@ /** \page DevelopmentToolkit Developing with the MITK Toolkit -Todo +Two major sections are available for your reference. \ref Concepts will explain several core concepts of MITK on a more abstract level. +We advise to read this section and to understand the available concepts, as this will prevent you from reimplementing functionality. +\ref MITKModuleManualsListPage shows a list of the available module manuals for in depth advice on how to use each module. */ diff --git a/Documentation/Doxygen/MainPage.dox.in b/Documentation/Doxygen/MainPage.dox.in deleted file mode 100644 index ed93fcfd62..0000000000 --- a/Documentation/Doxygen/MainPage.dox.in +++ /dev/null @@ -1,17 +0,0 @@ -/** - -\mainpage Medical Imaging Interaction Toolkit - Documentation Portal - -\image html mitkLogo.jpg - -This page acts as a portal to the three different parts of the MITK-Documentation. - -If this is your first time around here and you are interested in learning more about MITK, please read \subpage Overview - -If you are a MITK end-user, please refer to the \subpage UserManualPortal - -If you are a developer looking for a developer's guide, please see \subpage DeveloperManualPortal - -*/ - - diff --git a/Documentation/Doxygen/Overview/Overview.dox b/Documentation/Doxygen/Overview/Overview.dox index 565f32e6f2..5427954822 100644 --- a/Documentation/Doxygen/Overview/Overview.dox +++ b/Documentation/Doxygen/Overview/Overview.dox @@ -1,29 +1,31 @@ /** \page Overview MITK: An Overview -The Medical Imaging Interaction Toolkit (MITK) can be used in several different ways. If you are a new user to MITK the first question is in what manner you intend to use it. The following options are simplified and condensed versions of the most common usage scenarios. +The Medical Imaging Interaction Toolkit (MITK) is a powerful application and can also be used as either a framework or a toolkiit for Software development. The following options are the most common usage scenarios. -\tableofcontents -\section ShortIntroductionToMITKAsToolkit I want to develop my own software framework, but use some of MITK's data structures and algorithms + + + + I want to use MITK as an application + +You will use the MITK Workbench as an end user and will find user manuals in \ref UserManualPortal and \ref PluginListPage. + + I want to develop my own software framework, and use some of MITK's data structures and algorithms You will use MITK as a toolkit and probably benefit most from the \ref BuildInstructionsPage and MITK API Documentation. -\section ShortIntroductionToMITKAsFramework I want to use the MITK and BlueBerry software framework to develop my own software +I want to use the MITK and BlueBerry software framework to develop my own software Here you have again two options. -\subsection ShortIntroductionToMITKAsFrameworkExtendingWorkbench I want use the MITK Workbench and extend its capabilities +I want use the MITK Workbench and extend its capabilities You are using MITK as software framework and writing your own modules and plugins for MITK. You want to read the \ref BuildInstructionsPage and further on \ref Development. Also you might want to take a look at our \ref CMAKE_FAQ. -\subsection ShortIntroductionToMITKAsFrameworkExternalProject I want to create my own application based on MITK but with major customizations and changes +I want to create my own application based on MITK This is probably the most common way to use MITK. You are using MITK as software framework and building your own project and application using MITK. You want to read \ref HowToNewProject and the general information in \ref Development. Also you might want to take a look at our \ref CMAKE_FAQ. -\section ShortIntroductionToMITKAsFrameworkEndUser I want to use the MITK Workbench to do image processing - -You are using MITK and the MITK Workbench as an end user and will find user manuals in \ref MITKUserManualPage and \ref PluginListPage. - */ \ No newline at end of file diff --git a/Documentation/Doxygen/UserManual/Applications.dox b/Documentation/Doxygen/UserManual/Applications.dox index 7620fc8046..68ee016c23 100644 --- a/Documentation/Doxygen/UserManual/Applications.dox +++ b/Documentation/Doxygen/UserManual/Applications.dox @@ -1,30 +1,27 @@ /** \page ApplicationsPage Using MITK and Applications -Available sections: - - \ref ApplicationsPageUsingMITK - - \ref ApplicationsPageApplications - - \ref ApplicationsPageApplicationsList +\tableofcontents \section ApplicationsPageUsingMITK Using MITK Many of the applications created with the use of MITK share common basic functionalities. Due to this, there is one manual which explains the basic usage of MITK. For more information on the use of the advanced features of an application please take a look the \ref ApplicationsPageApplicationsList , whereas if you are interested in a certain view further information can be found in \ref PluginListPage . The basic usage information on MITK can be found in \ref MITKUserManualPage . \section ApplicationsPageApplications What are Applications? Applications are executables, which contain a certain configuration of views and perspectives. Usually they are aimed at a selective audience or solving a particular problem. As such they focus on certain capabilities of MITK, while ignoring others. The main reason for this is to supply the users of the application with the power of MITK for solving their tasks, without daunting them with an overwhelming number of menus and options. At the same time, this allows, together with the use of perspectives, the creation of sleek and elegant workflows, which are easily comprehensible. A typical example of this would be an application which contains only views related to the analysis of the human brain (particular question) or one which contains only what is necessary for displaying medical data in the classroom (specific audience). \section ApplicationsPageApplicationsList List of Applications If you are interested in using a specific application, currently developed by the MITK team you might want to take a look first at the \ref MITKUserManualPage . Further information on any application can be found here: */ \ No newline at end of file diff --git a/Documentation/Doxygen/UserManual/UserManualPortal.dox b/Documentation/Doxygen/UserManual/UserManualPortal.dox index bca8c867fe..5892a8147d 100644 --- a/Documentation/Doxygen/UserManual/UserManualPortal.dox +++ b/Documentation/Doxygen/UserManual/UserManualPortal.dox @@ -1,14 +1,15 @@ /** \page UserManualPortal MITK: User Manual -Due to the modular architecture of MITK the user documentation is split in different parts. You can find a short description of the intended purpose and audience of MITK based applications developed by us at \ref ApplicationsPage. To get an introduction into the usage of any MITK based application please read \ref MITKUserManualPage. It will give you an overview of most of the common questions, such as how to load or save data or navigate within it. +To get an introduction into the usage of any MITK based application please read \ref MITKUserManualPage. It will give you an overview of most of the common questions, such as how to load or save data or navigate within it. You can find a short description of the intended purpose and audience of MITK based applications developed by us at \ref ApplicationsPage. +For more specific questions regarding the usage of a certain plugin (like e.g. the segmentation view) you can refer to a list of \ref PluginListPage -For any more specific documentation of how a plugin operates you can find the plugin documentation in \ref PluginListPage. Depending on the application you are using you might have only some or all of the listed plugins available. +For more specific information on how a plugin operates you can find the plugin documentation in \ref PluginListPage. Depending on the application you are using you might have only some or all of the listed plugins available. \section UserManualPortalTopics List of topics */ \ No newline at end of file