Author: ceki
Date: Fri Mar 2 22:31:46 2007
New Revision: 1386
Modified:
logback/trunk/logback-site/src/site/pages/manual/index_menu.js
logback/trunk/logback-site/src/site/pages/manual/layouts.html
Log:
ongoing work
Modified: logback/trunk/logback-site/src/site/pages/manual/index_menu.js
==============================================================================
--- logback/trunk/logback-site/src/site/pages/manual/index_menu.js
(original)
+++ logback/trunk/logback-site/src/site/pages/manual/index_menu.js Fri Mar
2 22:31:46 2007
@@ -1,5 +1,5 @@
-document.write('<p class="menu_header">Manual</p>')
+document.write('<p class="menu_header">Chapter Index</p>')
document.write('<p class="menu"><a href="introduction.html"><b>Ch1:
Introduction to logback</b></a></p>');
document.write('<p class="menu"><a href="architecture.html"><b>Ch2:
Architecture</b></a>');
document.write('<p class="menu"><a href="joran.html"><b>Ch3: Logback
configuration with Joran</b></a>');
Modified: logback/trunk/logback-site/src/site/pages/manual/layouts.html
==============================================================================
--- logback/trunk/logback-site/src/site/pages/manual/layouts.html
(original)
+++ logback/trunk/logback-site/src/site/pages/manual/layouts.html Fri Mar
2 22:31:46 2007
@@ -248,8 +248,6 @@
}</pre></div>
- <!-- ====================== XXXXXXXXXXXXx -->
-
<p>The addition of the corresponding setter method is all that is
needed to enable the configuration of an option. Note that the
<code>PrintThreadName</code> option is boolean and not
@@ -702,27 +700,18 @@
context) associated with the
thread that
generated the logging event.
</p>
- <p>
- If
- <b>mdc</b>
- conversion word is followed by
a key
- between braces, as in
<b>%mdc{clientNumber}</b>,
- then the value in the MDC
corresponding
- to the key will be output.
+
+ <p>If <b>mdc</b> conversion word is
followed by a key
+ between braces, as in
<b>%mdc{clientNumber}</b>, then the
+ value in the MDC corresponding to the
key will be output.
</p>
- <p>
- If no option is given, then
- the entire content of the MDC
will be output in the format
- "key1=val1, key2=val2".
+
+ <p>If no option is given, then the
entire content of the MDC
+ will be output in the format
"key1=val1, key2=val2".
</p>
- <p>
- See
- <a
-
href="http://logback.qos.ch/apidocs/ch/qos/logback/classic/MDC.html";>
- MDC
- </a>
- class for more details.
+ <p>See <a href="mdc.html">Chapter 7</a>
for more details on
+ the MDC.
</p>
</td>
@@ -752,12 +741,12 @@
<p>Here are some examples:</p>
- <table BORDER="1" CELLPADDING="8">
+ <table class="bodyTable" CELLPADDING="8">
<tr class="a">
<th>Conversion
Pattern</th>
<th>Result</th>
</tr>
- <tr class="a">
+ <tr class="b">
<td>%ex</td>
<td><pre>mainPackage.foo.bar.TestException: Houston we have a problem
at mainPackage.foo.bar.TestThrower.fire(TestThrower.java:22)
@@ -769,7 +758,7 @@
<td><pre>mainPackage.foo.bar.TestException: Houston we have a problem
at mainPackage.foo.bar.TestThrower.fire(TestThrower.java:22)</pre></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td>%ex{full}</td>
<td><pre>mainPackage.foo.bar.TestException: Houston we have a problem
at mainPackage.foo.bar.TestThrower.fire(TestThrower.java:22)
@@ -790,7 +779,7 @@
using <b>%ex{full,
EX_DISPLAY_EVAL}</b> will display the full
stacktrace of the exception,
only if the evaluator called <em>EX_DISPLAY_EVAL</em>
returns a <b>negative</b>
answer. Evaluators are described
- further down this document.
+ further down in this document.
</p>
</td>
</tr>
@@ -801,9 +790,10 @@
</td>
<td>
- <p>
- Used to output the marker associated with the logger request.
+ <p>Used to output the marker associated with the logger
+ request.
</p>
+
<p>
If there is a single marker available, its name is displayed.
In case the marker has children markers, the converter displays
@@ -824,58 +814,55 @@
</tr>
</table>
- <p>
- By default the relevant information is output as is.
- However, with the aid of format modifiers it is
possible to
- change the minimum field width, the maximum field width
and
- justification.
- </p>
- <p>
- The optional format modifier is placed between the
percent
- sign and the conversion character or word.
- </p>
- <p>
- The first optional format modifier is the
- <em>left justification flag</em>
- which is just the minus (-) character. Then comes the
- optional
- <em>minimum field width</em>
- modifier. This is a decimal constant that represents the
- minimum number of characters to output. If the data item
- contains fewer characters, it is padded on either the
left
- or the right until the minimum width is reached. The
default
- is to pad on the left (right justify) but you can
specify
- right padding with the left justification flag. The
padding
- character is space. If the data item is larger than the
- minimum field width, the field is expanded to
accommodate
- the data. The value is never truncated.
- </p>
- <p>
- This behavior can be changed using the
- <em>maximum field width</em>
- modifier which is designated by a period followed by a
- decimal constant. If the data item is longer than the
- maximum field, then the extra characters are removed
from
- the <em>beginning</em>
- of the data item. For example, if the
- maximum field width is eight and the data item is ten
- characters long, then the first two characters of the
data
- item are dropped. This behavior deviates from the printf
- function in C where truncation is done from the end.
- </p>
- <p>
- Truncation from the end is possible by appending a minus
- character right after the period. In that case, if the
- maximum field width is eight and the data item is ten
- characters long, then the last two characters of the
data
- item are dropped.
+
+
+ <h2>Format modifiers</h2>
+
+ <p>By default the relevant information is output as is.
However,
+ with the aid of format modifiers it is possible to change the
+ minimum field width, the maximum field width as well as
+ justification.
</p>
- <p>
- Below are various format modifier examples for the
logger
- conversion specifier.
+
+ <p>The optional format modifier is placed between the percent
sign
+ and the conversion character or word.
+ </p>
+
+ <p>The first optional format modifier is the <em>left
+ justification flag</em> which is just the minus (-)
+ character. Then comes the optional <em>minimum field width</em>
+ modifier. This is a decimal constant that represents the minimum
+ number of characters to output. If the data item contains fewer
+ characters, it is padded on either the left or the right until
the
+ minimum width is reached. The default is to pad on the left
(right
+ justify) but you can specify right padding with the left
+ justification flag. The padding character is space. If the data
+ item is larger than the minimum field width, the field is
expanded
+ to accommodate the data. The value is never truncated.
</p>
- <table BORDER="1" CELLPADDING="8">
+ <p>This behavior can be changed using the <em>maximum field
+ width</em> modifier which is designated by a period followed by
a
+ decimal constant. If the data item is longer than the maximum
+ field, then the extra characters are removed from the
+ <em>beginning</em> of the data item. For example, if the maximum
+ field width is eight and the data item is ten characters long,
+ then the first two characters of the data item are dropped. This
+ behavior deviates from the printf function in C where truncation
+ is done from the end.
+ </p>
+
+ <p>Truncation from the end is possible by appending a minus
+ character right after the period. In that case, if the maximum
+ field width is eight and the data item is ten characters long,
+ then the last two characters of the data item are dropped.
+ </p>
+
+ <p>Below are various format modifier examples for the logger
+ conversion specifier.
+ </p>
+
+ <table class="bodyTable" BORDER="0" CELLPADDING="8">
<th>Format modifier</th>
<th>Left justify</th>
<th>Minimum width</th>
@@ -892,7 +879,7 @@
than 20 characters long.
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center">%-20logger</td>
<td align="center">true</td>
<td align="center">20</td>
@@ -912,7 +899,7 @@
longer than 30 characters.
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center">%20.30logger</td>
<td align="center">false</td>
<td align="center">20</td>
@@ -936,7 +923,7 @@
<em>beginning</em>.
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center">%.-30logger</td>
<td align="center">NA</td>
<td align="center">none</td>
@@ -951,7 +938,7 @@
<p>Here are some examples of the format modifier truncation:</p>
- <table BORDER="1" CELLPADDING="8">
+ <table class="bodyTable" BORDER="0" CELLPADDING="8">
<th>Format modifier</th>
<th>Logger name</th>
<th>Result</th>
@@ -960,7 +947,7 @@
<td align="center">main.Name</td>
<td align="center"><pre>[main.Name
]</pre></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center">[%20.-20logger]</td>
<td align="center">main.Name</td>
<td align="center"><pre>[
main.Name]</pre></td>
@@ -970,7 +957,7 @@
<td align="center">main.foo.foo.bar.Name</td>
<td align="center"><pre>[o.bar.Name]</pre></td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center">[%10.-10logger]</td>
<td align="center">main.foo.foo.bar.Name</td>
<td align="center"><pre>[main.foo.f]</pre></td>
@@ -1451,7 +1438,7 @@
<p>Here are the conversion specifier one can use with logback
access
<code>PatternLayout</code>.</p>
- <table border="1" CELLPADDING="8">
+ <table class="bodyTable" border="0" CELLPADDING="8">
<th align="center">Conversion Word</th>
<th align="center">Effect</th>
@@ -1463,7 +1450,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>A / localIP</b></td>
<td>
<p>
@@ -1479,7 +1466,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>h / clientHost</b></td>
<td>
<p>
@@ -1495,7 +1482,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>l</b></td>
<td>
<p>
@@ -1517,7 +1504,7 @@
displays the corresponding parameter.</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>i{header} /
header{header}</b></td>
<td>
<p>
@@ -1539,7 +1526,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>r / requestURL</b></td>
<td>
<p>
@@ -1555,7 +1542,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>t / date</b></td>
<td>
<p>
@@ -1594,7 +1581,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>U / requestURI</b></td>
<td>
<p>
@@ -1610,7 +1597,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>localPort</b></td>
<td>
<p>
@@ -1630,7 +1617,7 @@
displays the corresponding attribute.</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>reqCookie{cookie}</b></td>
<td>
<p>
@@ -1652,7 +1639,7 @@
<p><b>%header{Referer}</b> displays the referer
of the response.</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>requestContent</b></td>
<td>
<p>
@@ -1677,7 +1664,7 @@
</p>
</td>
</tr>
- <tr class="a">
+ <tr class="b">
<td align="center"><b>responseContent</b></td>
<td>
<p>
_______________________________________________
logback-dev mailing list
[email protected]
http://qos.ch/mailman/listinfo/logback-dev
