diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogView.png b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogView.png index 3719e8e35e..e23a2a63ab 100644 Binary files a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogView.png and b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogView.png differ diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogViewExplain.png b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogViewExplain.png new file mode 100644 index 0000000000..063c2a6a3f Binary files /dev/null and b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/LogViewExplain.png differ diff --git a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox index 89c0f0cbc1..fcedac60af 100644 --- a/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox +++ b/BlueBerry/Bundles/org.blueberry.ui.qt.log/documentation/UserManual/blueberrylogview.dox @@ -1,8 +1,16 @@ /** \bundlemainpage{org.berry.log} The Logging Module \image html Logging.png "Icon of the Module" -Once activated the Logging Module records all logging output of events and progress as specified in the source code with time of occurence, level of importance (Info, Warning, Error, Fatal, Debug), the message given and where it happens. The filter text field allows for searching all log events containing a certain substring. +The Plug-In "Logging Module" records all logging output of events and progress as specified in the source code with time of occurence, level of importance (Info, Warning, Error, Fatal, Debug), the message given and where it happens. The logging starts once you activate the Plug-In in your main application. A screenshot of the main view of the Logging Module is shown next. + +\image html LogView.png "Screenshot of the Logging Module" + +There are different features available in the view. The filter text field allows for searching all log events containing a certain substring. Using the button "Copy to clipboard" on the bottom right you can copy the current content of the logging view to your clipboard. This enables you to insert the logging information to any text processing application. + +You can also show more information on every logging message by activating the two checkboxes. In the simple view, leaving both checkboxes unchecked, you'll see logging messages and logging levels. A brief description of the logging levels can be found in the \ref LoggingPage "logging concept documentation". The checkbox "Category" adds a column for the category. The checkbox "Show Advanced Field" shows method, filename and linenumber where the logging message was emitted as well as the running time of the application. The next figure shows all information which can be shown in the Logging Module. + +\image html LogViewExplain.png "Details on the Vizualized Logging Information" */ \ No newline at end of file