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 @@

Welcome to the Chainsaw v2 Tutorial. Here you will learn how to effectively utilise the many features of Chainsaw.

Display filters +

Color filters

Conventions

To assist you, the following documentation conventions will be used

TIMESTAMP == '2004/06/19 23:55:12'

Search

+How to search:

Enter an expression in the text field of the main Chainsaw toolbar (a log panel must be selected)
Click the down arrow icon or press F3 to search forward
Click the up arrow icon or press Shift+F3 to search backward
The first matching row becomes selected, with matching rows displayed with white text on a black background
Subsequent forward or backward searches will navigate to the next match
To clear the search highlighting, clear the text field and press F3)

Display filters (refine focus)

+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. +

+NOTE:Display filter rules are saved. +

+Define display rules:

Move the cursor to the 'refine focus on' field

Enter an expression (see Expressions) (use the right-mouse click or ctrl-space to activate a context menu which can assist in constructing expressions)
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 set 'refine focus' field will assign the expression THREAD == 'Thread-1' to the refine focus field.
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
If the expression entered is invalid, an error message will available as the 'refine focus on' field's tooltip
If the ENTER 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

Color filters

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 @@

Fix errors as needed, apply and close the panel

Display filters (refine focus)

-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. -

-NOTE:Display filter rules are not saved. - -

-Define display rules:

Move the cursor to the 'refine focus on' field

Enter an expression (see Expressions)
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 set 'refine focus' field will assign the expression THREAD == 'Thread-1' to the refine focus field.
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
If the expression entered is invalid, an error message will available as the 'refine focus on' field's tooltip
If the ENTER 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

Shutting down the Tutorial

When you are finished with the tutorial, you can simply shutdown all the Generator receivers: