diff --git a/Documentation/Doxygen/2-UserManual/MITKPluginGeneralManualsList.dox b/Documentation/Doxygen/2-UserManual/MITKPluginGeneralManualsList.dox index 6b2c2bf2e7..3295abd838 100644 --- a/Documentation/Doxygen/2-UserManual/MITKPluginGeneralManualsList.dox +++ b/Documentation/Doxygen/2-UserManual/MITKPluginGeneralManualsList.dox @@ -1,31 +1,32 @@ /** \page PluginListGeneralPage List of General Purpose Plugins \li \subpage org_mitk_views_basicimageprocessing \li \subpage org_mitk_views_datamanager + \li \subpage org_mitk_views_properties \li \subpage org_mitk_gui_qt_dicom \li \subpage org_mitk_gui_qt_dicominspector \li \subpage org_mitk_gui_qt_imagecropper \li \subpage org_mitk_views_imagenavigator \li \subpage org_blueberry_ui_qt_log \li \subpage org_mitk_gui_qt_matchpoint_algorithm_batch \li \subpage org_mitk_gui_qt_matchpoint_algorithm_browser \li \subpage org_mitk_gui_qt_matchpoint_algorithm_control \li \subpage org_mitk_gui_qt_matchpoint_evaluator \li \subpage org_mitk_gui_qt_matchpoint_framereg \li \subpage org_mitk_gui_qt_matchpoint_manipulator \li \subpage org_mitk_gui_qt_matchpoint_mapper \li \subpage org_mitk_gui_qt_matchpoint_visualizer \li \subpage org_mitk_gui_qt_measurementtoolbox \li \subpage org_mitk_gui_qt_moviemaker \li \subpage org_mitk_views_multilabelsegmentation \li \subpage org_mitk_views_pointsetinteraction \li \subpage org_mitk_gui_qt_python \li \subpage org_mitk_gui_qt_remeshing \li \subpage org_mitk_views_screenshotmaker \li \subpage org_mitk_views_segmentation \li \subpage org_mitk_gui_qt_flow_segmentation \li \subpage org_mitk_gui_qt_viewnavigator \li \subpage org_mitk_views_volumevisualization */ diff --git a/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox b/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox index 4fef22951f..e0e332d746 100644 --- a/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox +++ b/Documentation/Doxygen/2-UserManual/MITKPluginManualsList.dox @@ -1,83 +1,84 @@ /** \page PluginListPage MITK Plugin Manuals The plugins and bundles provide much of the extended functionality of MITK. Each encapsulates a solution to a problem and associated features. This way one can easily assemble the necessary capabilites for a workflow without adding a lot of bloat, by combining plugins as needed. \subpage PluginListGeneralPage \subpage PluginListSpecificPage */ diff --git a/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox new file mode 100644 index 0000000000..e22620785d --- /dev/null +++ b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/PropertiesView.dox @@ -0,0 +1,57 @@ +/** +\page org_mitk_views_properties The Properties + +\imageMacro{icon.svg,"Icon of the Properties View.",2.00} + +\tableofcontents + +\section org_mitk_views_propertiesOverview Overview + +The Properties View allows you to inspect and change properties of a selected data node and its attached data. +This View is only for advanced users and developers, as it is easy to alter the program state in unexpected ways. +It can be considered as a complete exposure of parts of the backend that are usually supposed to be accessed only through dedicated frontend components like the color or opacity widgets in the context menu of a data node in the Data Manager View. + +\section org_mitk_views_propertiesUsage Usage + +\imageMacro{view.png,"The Properties View.",12.00} + +\subsection org_mitk_views_propertiesUsagePropertyListTypes Property list types + +After you selected a data node, the Property View allows you to switch between several property lists that are attached to the selected data node and its actual data. +By default, you see the common data node property list. + +There are two types of property lists: data node property lists and data property lists. + +Data node property lists consist of properties that the application attaches mainly for rendering settings. +They are not intrinsically part of the actual data and are only persisted when saving the MITK scene as a whole. +A typical example of such a property is "visible", which decides if the data should be rendered or hidden. + +The common data node property list is applied to all render windows but there are also render window specific data node property lists. +Any property that is found in both the common list and a render window specific list is overriden by the latter one. +For example, if you want to hide an image only in the 3d render window but show it in all other render windows, you check "visible" in the common list, add the same property to the 3d render window specific list, and uncheck it there. + +There is only a single data property list. +It represents the true metadata of the selected data like DICOM tags of a DICOM image. +When saving specific data, most data properties are written to the data file, as long as the selected file format supports metadata. +A popular example is the NRRD image format that allows to save custom key value pairs in text format in the file header. +Not all data properties are meant for persistence, though. +To check if a certain data property will be written to a metadata-enabled file format, click on in the properties tree view and check if there is a save icon at the bottom in the additional property info box. + +\subsection org_mitk_views_propertiesUsageFilter Filter + +Property lists can be quite large and complex, shown as a tree structure in the Properties View. +To quickly find properties of interest you can use the filter text box, which will filter the properties while you type. + +\subsection org_mitk_views_propertiesUsageEditProperties Edit properties + +Most property value types like numbers, strings, boolean values, or colors can be edited by either clicking or double-clicking in the Value column. +For example, to edit color properties, double-click on the colored Value cell. +You can either enter a color by name like "yellow", in hex notation like "#ffff00" (or abbreviated "#ff0"), or click on the "..." button to open a color picker dialog. + +\subsection org_mitk_views_propertiesUsagePropertyInfos Additional property information + +Some properties have additional information attached like a description, aliases, or a persistence flag. +This information is shown at the bottom of the Properties View. +When no additional information is available, the additional property info box is hidden. + +*/ diff --git a/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/icon.svg b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/icon.svg new file mode 100644 index 0000000000..fe51cf0228 --- /dev/null +++ b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/icon.svg @@ -0,0 +1,54 @@ + + + + + + image/svg+xml + + + + + + + + diff --git a/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/view.png b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/view.png new file mode 100644 index 0000000000..7ee5ca2b1a Binary files /dev/null and b/Plugins/org.mitk.gui.qt.properties/documentation/UserManual/view.png differ