doc: Update user guide for collapsible event table header bar
authorPatrick Tasse <patrick.tasse@gmail.com>
Tue, 15 Mar 2016 22:50:14 +0000 (18:50 -0400)
committerPatrick Tasse <patrick.tasse@gmail.com>
Fri, 18 Mar 2016 12:04:17 +0000 (08:04 -0400)
Change-Id: I45dfb1828398728bc85cdb0befa2bdf51b4b14db
Signed-off-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-on: https://git.eclipse.org/r/68496
Reviewed-by: Hudson CI
doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki
doc/org.eclipse.tracecompass.doc.user/doc/images/TablePostCollapse.png
doc/org.eclipse.tracecompass.doc.user/doc/images/TraceEditor-Filter.png
doc/org.eclipse.tracecompass.doc.user/doc/images/TraceEditor-Search.png
doc/org.eclipse.tracecompass.doc.user/doc/images/collapsed_ovr.gif [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/delete_button.gif [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/expanded_ovr.gif [new file with mode: 0644]
doc/org.eclipse.tracecompass.doc.user/doc/images/filter_add.gif [new file with mode: 0644]

index 90bce496f1c499914be844166e584198554c1474..8c79eef4c3d382b9555b95b982c361c0cfef18fb 100644 (file)
@@ -574,7 +574,7 @@ The header displays the current trace (or experiment) name.
 The columns of the table are defined by the fields (aspects) of the specific trace type. These are the defaults:
 
 * '''Timestamp''': the event timestamp
-* '''Type''': the event type
+* '''Event Type''': the event type
 * '''Contents''': the fields (or payload) of this event
 
 The first row of the table is the header row a.k.a. the Search and Filter row.
@@ -591,13 +591,15 @@ The Events editor can be closed, disposing a trace. When this is done, all the v
 
 Searching and filtering of events in the table can be performed by entering matching conditions in one or multiple columns in the header row (the first row below the column header).
 
-To toggle between searching and filtering, click on the 'search' ([[Image:images/TmfEventSearch.gif]]) or 'filter' ([[Image:images/TmfEventFilter.gif]]) icon in the header row's left margin, or right-click on the header row and select '''Show Filter Bar''' or '''Show Search Bar''' in the context menu.
+To apply a matching condition to a specific column, click on the column's header row cell, type in a [http://download.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html regular expression]. You can also enter a simple text string and it will be automatically be replaced with a 'contains' regular expression.
 
-To apply a matching condition to a specific column, click on the column's header row cell, type in a [http://download.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html regular expression] and press the '''ENTER''' key. You can also enter a simple text string and it will be automatically be replaced with a 'contains' regular expression.
+Press the '''Enter''' key to apply the condition as a search condition. It will be added to any existing search conditions.
+
+Press the '''Ctrl+Enter''' key to immediately add the condition (and any other existing search conditions) as a filter instead.
 
 When matching conditions are applied to two or more columns, all conditions must be met for the event to match (i.e. 'and' behavior).
 
-To clear all matching conditions in the header row, press the '''DEL''' key.
+A preset filter created in the [[#Filters_View | Filters]] view can also be applied by right-clicking on the table and selecting '''Apply preset filter...''' > ''filter name''
 
 ==== Searching ====
 
@@ -607,25 +609,33 @@ All matching events will have a 'search match' icon in their left margin. Non-ma
 
 [[Image:images/TraceEditor-Search.png]]
 
-Pressing the '''ENTER''' key will search and select the next matching event. Pressing the '''SHIFT-ENTER''' key will search and select the previous matching event. Wrapping will occur in both directions.
+Pressing the '''Enter''' key will search and select the next matching event. Pressing the '''Shift+Enter''' key will search and select the previous matching event. Wrapping will occur in both directions.
+
+Press '''Esc''' to cancel an ongoing search.
 
-Press '''ESC''' to cancel an ongoing search.
+To add the currently applied search condition(s) as filter(s), click the '''Add as Filter''' [[Image:images/filter_add.gif]] button in the header row margin, or press the '''Ctrl+Enter''' key.
 
-Press '''DEL''' to clear the header row and reset all events to normal.
+Press '''Delete''' to clear the header row and reset all events to normal.
 
 ==== Filtering ====
 
-When a filtering condition is entered in the head row, the table will clear all events and fill itself with matching events as they are found from the beginning of the trace. The characters in each column which match the regular expression will be highlighted.
+When a new filter is applied, the table will clear all events and fill itself with matching events as they are found from the beginning of the trace. The characters in each column which match the regular expression will be highlighted.
 
 A status row will be displayed before and after the matching events, dynamically showing how many matching events were found and how many events were processed so far. Once the filtering is completed, the status row icon in the left margin will change from a 'stop' to a 'filter' icon.
 
 [[Image:images/TraceEditor-Filter.png]]
 
-Press '''ESC''' to stop an ongoing filtering. In this case the status row icon will remain as a 'stop' icon to indicate that not all events were processed.
+Press '''Esc''' to stop an ongoing filtering. In this case the status row icon will remain as a 'stop' icon to indicate that not all events were processed.
+
+The header bar will be displayed above the table and will show a label for each applied filter. Clicking on a label will highlight the matching strings in the events that correspond to this filter condition. Pressing the '''Delete''' key will clear this highlighting.
 
-Press '''DEL''' or right-click on the table and select '''Clear Filters''' from the context menu to clear the header row and remove the filtering. All trace events will be now shown in the table. Note that the currently selected event will remain selected even after the filter is removed.
+To remove a specific filter, click on the [[Image:images/delete_button.gif]] icon on its label in the header bar. The table will be updated with the events matching the remaining filters.
 
-You can also search on the subset of filtered events by toggling the header row to the Search Bar while a filter is applied. Searching and filtering conditions are independent of each other.
+The header bar can be collapsed and expanded by clicking on the [[Image:images/expanded_ovr.gif]][[Image:images/collapsed_ovr.gif]] icons in the top-left corner or on its background. In collapsed mode, a minimized version of the filter labels will be shown that can also be used to highlight or remove the corresponding filter.
+
+Right-click on the table and select '''Clear Filters''' from the context menu to remove all filters. All trace events will be now shown in the table. Note that the currently selected event will remain selected even after the filters are removed.
+
+You can also search on the subset of filtered events by entering a search condition in the header row while a filter is applied. Searching and filtering conditions are independent of each other.
 
 ==== Bookmarking ====
 
@@ -664,6 +674,7 @@ It is possible to export the content of the trace to a text file based on the co
 ''Note'':  The columns in the text file are separated by tabs.
 
 === Refreshing of Trace ===
+
 It's possible to refresh the content of the trace and resume indexing in case the current open trace was updated on the media. To refresh the trace, right-click into the table and select menu item '''Refresh'''. Alternatively, press key '''F5'''.
 
 === Collapsing of Repetitive Events ===
@@ -678,7 +689,7 @@ A status row will be displayed before and after the events, dynamically showing
 
 [[Image:images/TablePostCollapse.png]]
 
-To clear collapsing, press the right mouse button in the table and select menu item '''Clear Filters''' in the context sensitive menu. ''Note'' that collapsing is also removed when another filter is applied to the table.
+To remove the collapse filter, press the ([[Image:images/delete_button.gif]]) icon on the '''Collapse''' label in the header bar, or press the right mouse button in the table and select menu item '''Clear Filters''' in the context sensitive menu (this will also remove any other filters).
 
 === Customization ===
 
index bfc8c2f29619aeb77599eb90553ac8c7ba4a7ba5..3131c2fa73233b26c2826918cc0cbfd389f27fdb 100644 (file)
Binary files a/doc/org.eclipse.tracecompass.doc.user/doc/images/TablePostCollapse.png and b/doc/org.eclipse.tracecompass.doc.user/doc/images/TablePostCollapse.png differ
index 5e8c47f9377790468de70fe970e047ae51c885bc..39ee39eee5884781c21f6ee7e8075a4d3cb93585 100644 (file)
Binary files a/doc/org.eclipse.tracecompass.doc.user/doc/images/TraceEditor-Filter.png and b/doc/org.eclipse.tracecompass.doc.user/doc/images/TraceEditor-Filter.png differ
index eb1c89acd29a4e8eae568f33151b877f737f3864..709b02be40742a9371e0689be6305ec36596853f 100644 (file)
Binary files a/doc/org.eclipse.tracecompass.doc.user/doc/images/TraceEditor-Search.png and b/doc/org.eclipse.tracecompass.doc.user/doc/images/TraceEditor-Search.png differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/collapsed_ovr.gif b/doc/org.eclipse.tracecompass.doc.user/doc/images/collapsed_ovr.gif
new file mode 100644 (file)
index 0000000..07d47a2
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/collapsed_ovr.gif differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/delete_button.gif b/doc/org.eclipse.tracecompass.doc.user/doc/images/delete_button.gif
new file mode 100644 (file)
index 0000000..6bc0689
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/delete_button.gif differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/expanded_ovr.gif b/doc/org.eclipse.tracecompass.doc.user/doc/images/expanded_ovr.gif
new file mode 100644 (file)
index 0000000..f278950
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/expanded_ovr.gif differ
diff --git a/doc/org.eclipse.tracecompass.doc.user/doc/images/filter_add.gif b/doc/org.eclipse.tracecompass.doc.user/doc/images/filter_add.gif
new file mode 100644 (file)
index 0000000..a881036
Binary files /dev/null and b/doc/org.eclipse.tracecompass.doc.user/doc/images/filter_add.gif differ
This page took 0.037457 seconds and 5 git commands to generate.