svn commit: r673735 - /logging/chainsaw/trunk/src/main/resources/org/apache/log4j/chainsaw/help/tutorial.html

Author: sdeboy
Date: Thu Jul  3 09:28:04 2008
New Revision: 673735

URL: http://svn.apache.org/viewvc?rev=673735&view=rev
Log:
Add 'search' to tutorial and reordered topics

Modified:
    logging/chainsaw/trunk/src/main/resources/org/apache/log4j/chainsaw/help/tutorial.html

Modified: logging/chainsaw/trunk/src/main/resources/org/apache/log4j/chainsaw/help/tutorial.html
URL: http://svn.apache.org/viewvc/logging/chainsaw/trunk/src/main/resources/org/apache/log4j/chainsaw/help/tutorial.html?rev=673735&r1=673734&r2=673735&view=diff
==============================================================================
--- logging/chainsaw/trunk/src/main/resources/org/apache/log4j/chainsaw/help/tutorial.html (original)
+++ logging/chainsaw/trunk/src/main/resources/org/apache/log4j/chainsaw/help/tutorial.html
Thu Jul  3 09:28:04 2008
@@ -8,8 +8,9 @@
 <p>Welcome to the Chainsaw v2 Tutorial.  Here you will learn how to effectively utilise the many features of Chainsaw.</p>
 </p>
 <p><a href="#expressions">Expressions</a>
-<p><a href="#color_filter">Color filters</a>
+<p><a href="#search">Search</a>
 <p><a href="#display_filter">Display filters</a>
+<p><a href="#color_filter">Color filters</a>
 <h2>Conventions</h2>
 <p>To assist you, the following documentation conventions will be used</p>
 <ul>
@@ -198,6 +199,33 @@
 <tr><td>To display events occurring at 23:55:12 on the 19th of June (all events generated during that
second, regardless of millisecond value)</td><td><b>TIMESTAMP == '2004/06/19 23:55:12'</b></td></tr>
 </table>

+<A NAME="search"><h3>Search</h3>
+<p>
+<b>How to search:</b></p>
+<ul>
+<li><b>Enter an expression</b> in the text field of the main Chainsaw toolbar (a log panel must be selected)</li>
+<li>Click the <b>down arrow icon</b> or press <b>F3</b> to search forward</li>
+<li>Click the <b>up arrow icon</b> or press <b>Shift+F3</b> to search backward</li>
+<li>The first matching row becomes selected, with matching rows displayed with white text on a black background</li>
+<li>Subsequent forward or backward searches will navigate to the next match</li>
+<li>To <b>clear the search highlighting</b>, clear the text field and press <b>F3</b>)</li>
+</ul>
+<p>
+<A NAME="display_filter"><h3>Display filters (refine focus)</h3>
+Events displayed in the event panel can be filtered in two ways: by focusing on a logger in the logger tree
panel and by defining display filter rules in the 'refine focus' field.  
+<p>
+<b>NOTE:</b>Display filter rules are saved. 
+<p>
+<b>Define display rules:</b></p>
+<ol>
+<li>Move the cursor to the 'refine focus on' field</li>
+<li>Enter an expression (see <a href="#expressions">Expressions</a>) (use the right-mouse click or
ctrl-space to activate a context menu which can assist in constructing expressions)</li>
+<li>Alternatively, use the context (mouse right click) menu (available when the mouse pointer is over
the events table) to modify the 'refine focus' field's expression based on the field and value under the
mouse pointer.  For example, if the mouse pointer is over the THREAD cell of an event which has a value of
Thread-1, selecting <b>set 'refine focus' field</b> will assign the expression <b>THREAD ==
'Thread-1'</b> to the refine focus field.</li>
+<li>The display will be updated automatically if the expression is valid and the contents of the 'refine
focus' field have not changed for 1 second, showing only events which match the expression</li>
+<li>If the expression entered is invalid, an error message will available as the 'refine focus on'
field's tooltip</li>
+<li>If the <b>ENTER</b> key is pressed when a valid expression is in the 'refine focus on' field, the
expression is added to the refine focus drop down list and can be recalled later in the session</li>
+</ol>
+
 <A NAME="color_filter"><h3>Color filters</h3>
 Each log panel can define color rules which can be used to colorize events in the event panel.  Color rules are
associated with each event panel and are saved when the application ends and loaded automatically when
the application starts.

@@ -215,22 +243,6 @@
 <li>Fix errors as needed, apply and close the panel</li>
 </ol>

-<A NAME="display_filter"><h3>Display filters (refine focus)</h3>
-Events displayed in the event panel can be filtered in two ways: by focusing on a logger in the logger tree
panel and by defining display filter rules in the 'refine focus' field.  
-<p>
-<b>NOTE:</b>Display filter rules are not saved. 
-
-<p>
-<b>Define display rules:</b></p>
-<ol>
-<li>Move the cursor to the 'refine focus on' field</li>
-<li>Enter an expression (see <a href="#expressions">Expressions</a>)</li>
-<li>Alternatively, use the context (mouse right click) menu (available when the mouse pointer is over
the events table) to modify the 'refine focus' field's expression based on the field and value under the
mouse pointer.  For example, if the mouse pointer is over the THREAD cell of an event which has a value of
Thread-1, selecting <b>set 'refine focus' field</b> will assign the expression <b>THREAD ==
'Thread-1'</b> to the refine focus field.</li>
-<li>The display will be updated automatically if the expression is valid and the contents of the 'refine
focus' field have not changed for 1 second, showing only events which match the expression</li>
-<li>If the expression entered is invalid, an error message will available as the 'refine focus on'
field's tooltip</li>
-<li>If the <b>ENTER</b> key is pressed when a valid expression is in the 'refine focus on' field, the
expression is added to the refine focus drop down list and can be recalled later in the session</li>
-</ol>
-
 <h2>Shutting down the Tutorial</h2>
 <p>
 When you are finished with the tutorial, you can simply shutdown all the Generator receivers: