diff --git a/Plugins/org.mitk.gui.qt.matchpoint.algorithm.browser/documentation/UserManual/Manual.dox b/Plugins/org.mitk.gui.qt.matchpoint.algorithm.browser/documentation/UserManual/Manual.dox index 336b706c50..cd82a1d22d 100644 --- a/Plugins/org.mitk.gui.qt.matchpoint.algorithm.browser/documentation/UserManual/Manual.dox +++ b/Plugins/org.mitk.gui.qt.matchpoint.algorithm.browser/documentation/UserManual/Manual.dox @@ -1,46 +1,69 @@ /** \page org_mitk_views_matchpoint_algorithm_browser The MatchPoint Algorithm Browser View \imageMacro{map_icon_browser_doc.svg, "Icon of the MatchPoint Algorithm Browser", 3} \tableofcontents \section MAP_BROWSER_Introduction Introduction This view offers the user a way to search for available registration algorithms and select them for -further usage by other views (e.g. MatchPoint Algorithm Control \ref org_mitk_gui_qt_algorithm_control). +further usage by other views (e.g. \ref org_mitk_views_matchpoint_algorithm_control). \section MAP_BROWSER_Usage Usage -\remark If you see no algorithms available by the browser, please check the search paths which can be configured at the MatchPoint preference page (Ctrl+P). +\remark If you see no algorithms available by the browser, please check the search path which can be configured at the MatchPoint preference page (Ctrl+P). +As default it is set to MITK-build-directory\ep\deployed\MatchPoint-0.13. +\imageMacro{map_browser_preferencesPath.png, "Matchpoint preferences",14} -The basic idea of the browser is that you can use this view as central place to search for suitable algorithms. If you select an algorithm you can see its profile in the lower part of the view. -If a algorithm is selected all other views (e.g. \ref org_mitk_gui_qt_algorithm_control) which use registration algorithms will be notified and allow to choose the selected algorithm for usage. -\imageMacro{map_browser.png, "View of the browser with the list of available algorithm and the profile area",14} +The basic idea of the browser is that you can use this view as central place to search for suitable registration algorithms. +If an algorithm is selected, all other views (e.g. \ref org_mitk_views_matchpoint_algorithm_control) which use registration algorithms will be notified and allow to choose the selected algorithm for usage. +If you select an algorithm you can see its profile in the lower part of the view. +\imageMacro{map_browser_viewScreenshot.png, "View of the browser with the list of available algorithms and the profile area",14} \section MAP_BROWSER_Profile Profile info -In the following a short information about the different properties classified in the profile.\n +In the following, a short description of the properties classified in the profile is given.\n +\subsection MAP_BROWSER_Profile_Identification Identification +\subsection MAP_BROWSER_Profile_Description Description +A short description of the chosen registration algorithm. + +\subsection MAP_BROWSER_Profile_Keywords Keywords +Typical keywords associated with the selected algorithm. They can i.e. be used in the search field. + +\subsection MAP_BROWSER_Profile_Characteristics Characteristics + + +\subsection MAP_BROWSER_Profile_ContactAndUsage Contact & Usage + */ + +