[logback-dev] svn commit: r1364 - in logback/trunk/logback-site/src/site/resources: . css manual templates
noreply.ceki at qos.ch
noreply.ceki at qos.ch
Tue Feb 27 21:17:11 CET 2007
Author: ceki
Date: Tue Feb 27 21:17:11 2007
New Revision: 1364
Modified:
logback/trunk/logback-site/src/site/resources/bridge.html
logback/trunk/logback-site/src/site/resources/css/print.css
logback/trunk/logback-site/src/site/resources/css/site.css
logback/trunk/logback-site/src/site/resources/download.html
logback/trunk/logback-site/src/site/resources/manual/layouts.html
logback/trunk/logback-site/src/site/resources/news.html
logback/trunk/logback-site/src/site/resources/templates/left.js
logback/trunk/logback-site/src/site/resources/templates/right.js
Log:
doc improvements
Modified: logback/trunk/logback-site/src/site/resources/bridge.html
==============================================================================
--- logback/trunk/logback-site/src/site/resources/bridge.html (original)
+++ logback/trunk/logback-site/src/site/resources/bridge.html Tue Feb 27 21:17:11 2007
@@ -4,6 +4,8 @@
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>Log4j Bridge</title>
<link rel="stylesheet" type="text/css" media="screen" href="css/site.css" />
+<link rel="stylesheet" type="text/css" media="print" href="css/print.css" />
+
</head>
<body>
<script>
Modified: logback/trunk/logback-site/src/site/resources/css/print.css
==============================================================================
--- logback/trunk/logback-site/src/site/resources/css/print.css (original)
+++ logback/trunk/logback-site/src/site/resources/css/print.css Tue Feb 27 21:17:11 2007
@@ -9,7 +9,7 @@
font-size: 12px;
}
-#leftColumn {
+#left, #right {
width: 0px;
height: 0px;
visibility:hidden;
Modified: logback/trunk/logback-site/src/site/resources/css/site.css
==============================================================================
--- logback/trunk/logback-site/src/site/resources/css/site.css (original)
+++ logback/trunk/logback-site/src/site/resources/css/site.css Tue Feb 27 21:17:11 2007
@@ -1,29 +1,18 @@
html {
- padding:0px;
- margin:0px;
+/* padding:0px;
+ margin:0px; */
}
body {
background-color: #fff;
font-family: Verdana, Arial, SunSans-Regular, Sans-Serif;
color: #000;
- padding:0px;
- margin:0px;
- font-size: small;
-}
-
-p, pre {
- margin: 0px;
- padding-top: 0px;
- padding-bottom: 0px;
- /*padding-left: 1ex;*/
- /*padding: 5px 20px 5px 20px; */
+ padding: 0px;
+ margin: 0px;
}
-
a {
color: #0000CC;
- /*font-size: smaller;*/
background-color:transparent;
text-decoration: none;
}
@@ -32,6 +21,9 @@
text-decoration: underline;
}
+div.source {
+ margin-top: 1em;
+}
.source {
border-top: 1px solid #DDDDDD;
border-bottom: 1px solid #DDDDDD;
@@ -40,10 +32,12 @@
padding-bottom: 0.5ex;
padding-top: 0.5ex;
padding-left: 1ex;
- /*white-space: pre;*/
+ white-space: pre;
}
pre {
+ padding: 0px;
+ margin: 0px;
background-color:transparent;
font-family: Courier, Monaco, Monospace;
}
@@ -92,6 +86,16 @@
}
+p.menu {
+ padding-top: 0px;
+ padding-bottom: 0px;
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+.small {
+ font-size: smaller;
+}
strong {
/*font-size: 13px;*/
@@ -119,9 +123,7 @@
color: #564b47;
margin: 4px 0px 0px 4px;
padding: 0px;
- /* background-color: #ffffff; */
border: 1px solid #cccccc;
- /* background-color: #ffcc99; */
background-color: #ffffff;
}
@@ -146,10 +148,15 @@
#left a:hover, #right a:hover {
border: solid 1px #FFFFFF;
- background-color: #3333CC;
+ background-color: #3333CC;
color: #ffffff;
}
+#left a:hover.x {
+ background-color: #fff;
+}
+
+
#content {
margin: 0px 17em 0px 17em;
padding: 0px;
@@ -253,7 +260,7 @@
}
.highlight {
- width: 300px;
+ width: 300px;
float: right;
display: inline;
font-weight: bolder;
Modified: logback/trunk/logback-site/src/site/resources/download.html
==============================================================================
--- logback/trunk/logback-site/src/site/resources/download.html (original)
+++ logback/trunk/logback-site/src/site/resources/download.html Tue Feb 27 21:17:11 2007
@@ -31,13 +31,13 @@
<ul>
<p>
- <a href="dist/logback-${pom.version}.zip">
- logback-${pom.version}.zip
+ <a href="dist/logback-0.9.1.zip">
+ logback-0.9.1.zip
</a>
</p>
<p>
- <a href="dist/logback-${pom.version}.tar.gz">
- logback-${pom.version}.tar.gz
+ <a href="dist/logback-0.9.1.tar.gz">
+ logback-0.9.1.tar.gz
</a>
</p>
</ul>
Modified: logback/trunk/logback-site/src/site/resources/manual/layouts.html
==============================================================================
--- logback/trunk/logback-site/src/site/resources/manual/layouts.html (original)
+++ logback/trunk/logback-site/src/site/resources/manual/layouts.html Tue Feb 27 21:17:11 2007
@@ -4,6 +4,8 @@
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>Chapter 5: Layouts</title>
<link rel="stylesheet" type="text/css" media="screen" href="../css/site.css" />
+<link rel="stylesheet" type="text/css" media="print" href="../css/print.css" />
+
</head>
<body>
<script>
@@ -24,29 +26,30 @@
</div>
- <table>
- <tr>
- <td valign="top" align="top">
- <a rel="license"
- href="http://creativecommons.org/licenses/by-nc-sa/2.5/">
- <img alt="Creative Commons License"
- style="border-width: 0"
- src="http://creativecommons.org/images/public/somerights20.png" />
- </a>
+ <table cellpadding="10">
+
+ <tr>
+ <td>
+ <a rel="license"
+ href="http://creativecommons.org/licenses/by-nc-sa/2.5/">
+ <img alt="Creative Commons License"
+ style="border-width: 0"
+ src="http://creativecommons.org/images/public/somerights20.png" />
+ </a>
</td>
<td>
<p>Copyright © 2000-2006, QOS.ch</p>
<p>
<!--Creative Commons License-->
- This work is licensed under a
+ This document is licensed under a
<a rel="license"
href="http://creativecommons.org/licenses/by-nc-sa/2.5/">
Creative Commons
Attribution-NonCommercial-ShareAlike 2.5
License
</a>
- .
+
<!--/Creative Commons License-->
</p>
</td>
@@ -54,67 +57,68 @@
</table>
<div class="highlight">
- <p>
- In order to run the examples in this chapter, you need
- to make sure that certain jar files are present on the
- classpath.
- Please refer to the <a href="../setup.html">setup page</a>
- for further details.
+
+ <p>In order to run the examples in this chapter, you need to make
+ sure that certain jar files are present on the classpath. Please
+ refer to the <a href="../setup.html">setup page</a> for further
+ details.
</p>
</div>
<h2>What is a layout</h2>
- <p>
- While appenders are responsible for writing logging output
- to an appender dependent device, layouts are responsible for
- the format of the output. In case you were wondering,
- layouts have nothing to do with large estates in Florida.
- The
- <code>format()</code>
- method in the
- <a href="../xref/ch/qos/logback/core/Layout.html"><code>Layout</code></a>
- interface takes an object that represents
- an event (of any type) and returns a String. A synopsis of the
- <code>Layout</code> interface is shown below.
+
+ <p>While appenders are responsible for writing logging output to
+ an appender dependent device, layouts are responsible for the
+ format of the output. In case you were wondering, layouts have
+ nothing to do with large estates in Florida. The
+ <code>format()</code> method in the <a
+ href="../xref/ch/qos/logback/core/Layout.html"><code>Layout</code></a>
+ interface takes an object that represents an event (of any type)
+ and returns a String. A synopsis of the <code>Layout</code>
+ interface is shown below.
</p>
- <div class="source"><pre>public interface Layout<E> extends ContextAware, LifeCycle {
+
+ <div class="source">public interface Layout<E> extends ContextAware, LifeCycle {
String doLayout(E event);
String getHeader();
String getFooter();
String getContentType();
-}</pre></div>
- <p>
- This interface is rather simple and yet is sufficent for
- many formatting needs. The Texan developer from Texas,
- who you might know from Joseph Heller's <em>Catch-22</em>,
- might exclaim:
- it just takes two methods to implement a layout!!?
+}</div>
+
+ <p>This interface is rather simple and yet is sufficent for many
+ formatting needs. The Texan developer from Texas, who you might
+ know from Joseph Heller's <em>Catch-22</em>, might exclaim: it
+ just takes five methods to implement a layout!!?
</p>
- <h2>Logback classic</h2>
+ <h2>Logback-classic</h2>
- <p>
- Logback classic only processes events of type
+ <p>Logback-classic is wired to processes only events of type
<a href="../xref/ch/qos/logback/classic/spi/LoggingEvent.html">
- <code>ch.qos.logback.classic.spi.LoggingEvent</code></a>.
+ <code>ch.qos.logback.classic.spi.LoggingEvent</code></a>. This
+ fact will apparent for the remaining of this section.
</p>
<h3>Writing your own Layout</h3>
+
<p>
- Let us implement a simple and functional layout for the
- classic module which prints the time elapsed since the start
- of the application, the level of the logging event, the
+ Let us implement a simple yet functional layout for the
+ logback-classic module that prints the time elapsed since the
+ start of the application, the level of the logging event, the
caller thread between brackets, its logger name, a dash followed
by the event message and a new line.
</p>
+
<p>Sample output might look like:</p>
+
<div class="source">10489 DEBUG [main] com.marsupial.Pouch - Hello world.</div>
<p>Here is a possible implementation, authored by the Texan developer:</p>
<em>Example 5.0: Sample implementation of a Layout
<a href="../xref/chapter5/MySampleLayout.html">
(logback-examples/src/main/java/chapter5/MySampleLayout.java)</a></em>
+
<div class="source"><pre>package chapter5;
import ch.qos.logback.classic.spi.LoggingEvent;
Modified: logback/trunk/logback-site/src/site/resources/news.html
==============================================================================
--- logback/trunk/logback-site/src/site/resources/news.html (original)
+++ logback/trunk/logback-site/src/site/resources/news.html Tue Feb 27 21:17:11 2007
@@ -19,10 +19,21 @@
</div>
<div id="content">
- <h2>Logback News</h2>
+ <h2>Logback News</h2>
+
+ <p>You can receive logback-related announcements by subscribing to
+ the <a
+ href="http://www.qos.ch/mailman/listinfo/logback-announce">logback
+ announce</a> mailing list.</p>
- <p>Here are the latest news about logback.</p>
- <h3>MMMM ddd, 2007 - Release of version 0.9.x</h3>
+ <hr width="80%" align="center" />
+
+ <h3>MMMM ddd, 2007 - Release of version 0.9.1</h3>
+
+ <p>Logback-class now depends on SLF4J version 1.3.0 instead of
+ 1.2.</p>
+
+ <p>Numerous improvements to the documentation.</p>
<p><a href="http://bugzilla.qos.ch/show_bug.cgi?id=46">Bug #46</a>
reported by Mark Renyolds has been fixed. The
@@ -35,31 +46,41 @@
passing an <code>Object</code> to the printing methods using the
log4j-bridge module. </p>
+ <hr width="80%" align="center" />
+
<h3>January 31st, 2007 - Release of version 0.9</h3>
<p>
- This version contains a new component, namely the <code>ContextSelector</code>,
- that provides context separation and management when logback is used
- by several web-apps running under the same server. A
- <a href="manual/contextSelector.html">new chapter</a> was added to the logback manual to detail
- the use of the <code>ContextSelector</code>, along with its associated components.
+ This version contains a new component, namely the
+ <code>ContextSelector</code>, that provides context separation
+ and management when logback is used by several web-apps running
+ under the same server. A <a
+ href="manual/contextSelector.html">new chapter</a> was added to
+ the logback manual to detail the use of the
+ <code>ContextSelector</code>, along with its associated
+ components.
</p>
<p>
- The <code>JMXConfigurator</code> has been improved. It now shows the context's
- Status objects, which lets users check the internal state of logback.
+ The <code>JMXConfigurator</code> has been improved. It now shows
+ the context's Status objects, which lets users check the
+ internal state of logback.
</p>
<p>
- The logback manual's chapter 2, about <a href="manual/architecture.html">logback's architecture</a>,
- has been updated with two sections: Under the hood and Performance.
+ The logback manual's chapter 2, about <a
+ href="manual/architecture.html">logback's architecture</a>, has
+ been updated with two sections: Under the hood and Performance.
</p>
+ <hr width="80%" align="center" />
+
<h3>January 23th, 2007 - Release of version 0.8.1</h3>
<p>
- This version contains new components in the Access module, allowing users
- to display the full HttpServletRequest or HttpServletResponse of an access event.
+ This version contains new components in the Access module,
+ allowing users to display the full HttpServletRequest or
+ HttpServletResponse of an access event.
</p>
<p>
@@ -68,56 +89,60 @@
Appenders and Layouts have been updated to document new components of logback.
</p>
- <p>
- A demonstration webApp presenting logback's major components is available.
- A document explains how to run it, and provides a step-by-step visit of the
- demo.
+ <p>A demonstration webApp presenting logback's major components is
+ available. A document explains how to run it, and provides a
+ step-by-step visit of the demo.
</p>
- <p>
- A first translation of logback jars to JDK1.4 is present in this release.
+ <p>A first translation of logback jars to JDK1.4 is present in
+ this release.
</p>
+ <hr width="80%" align="center" />
+
<h3>January 12th, 2007 - Release of version 0.8</h3>
- <p>
- This version contains a whole new chapter, namely Chapter 3, about logback
- configuration. Several other documentation pages have been improved.
+ <p>This version contains a whole new chapter, namely Chapter 3,
+ about logback configuration. Several other documentation pages
+ have been improved.
</p>
- <p>
- Logback now uses Generics in many components.
+ <p>Logback now uses Generics in many components.
</p>
- <p>
- Several new components have been added to logback. A JMX Configurator now allows
- users to see and modify loggers or reload configuration among other possibilities.
- A <a href="jmxConfig.html">document</a>
- about this configurator is available in the <a href="documentation.html">corresponding section</a>
- of the site. We'd like to thank Sebastian Davids for his ideas and contributions to this
- component.
+ <p>Several new components have been added to logback. A JMX
+ Configurator now allows users to see and modify loggers or reload
+ configuration among other possibilities. A <a
+ href="jmxConfig.html">document</a> about this configurator is
+ available in the <a href="documentation.html">corresponding
+ section</a> of the site. We'd like to thank Sebastian Davids for
+ his ideas and contributions to this component.
</p>
- <p>
- A JMSTopicAppender and JMSQueueAppender are now available, as well as two new filters: LevelFilter
- and ThresholdFilter. A refactoring was done in the filters objects to ease the implementation
- of custom filters.
+ <p>A JMSTopicAppender and JMSQueueAppender are now available, as
+ well as two new filters: LevelFilter and ThresholdFilter. A
+ refactoring was done in the filters objects to ease the
+ implementation of custom filters.
</p>
+ <hr width="80%" align="center" />
+
<h3>December 19th, 2006 - Release of version 0.7.1</h3>
- <p>
- Version 0.7.1 of logback has been released.
+ <p>Version 0.7.1 of logback has been released.
</p>
- <p>
- This version contains more detailled information about logback access module, and
- its JMX components. A <a href="access.html">dedicated page</a> explains how to configure and use logback
- access in Tomcat and Jetty, and access some of its components via JMX.
+ <p>This version contains more detailled information about logback
+ access module, and its JMX components. A <a
+ href="access.html">dedicated page</a> explains how to configure
+ and use logback access in Tomcat and Jetty, and access some of its
+ components via JMX.
</p>
+ <hr width="80%" align="center" />
+
<h3>December 18th, 2006 - Release of version 0.7</h3>
<p>
@@ -136,27 +161,29 @@
namely Filters and MDC, are available in the manual section.
</p>
+ <hr width="80%" align="center" />
+
<h3>November 30th, 2006 - Release of version 0.6</h3>
- <p>
- Version 0.6 of logback has been released.
- </p>
+ <p>Version 0.6 of logback has been released.
+ </p>
- <p>
- Logback classic now supports automatic configuration, allowing test and production
- environment configuration. <code>TurboFilters</code> make their first appearance
- in a logback release. They provide ultra-fast filtering possibilities.
- The logging context now supports listeners which will be contacted each
- time the context is reset or started. <code>SMTPAppender</code>
- allows for much more flexible configuration than before.
+ <p>Logback classic now supports automatic configuration, allowing
+ test and production environment
+ configuration. <code>TurboFilters</code> make their first
+ appearance in a logback release. They provide ultra-fast filtering
+ possibilities. The logging context now supports listeners which
+ will be contacted each time the context is reset or
+ started. <code>SMTPAppender</code> allows for much more flexible
+ configuration than before.
</p>
<p>
- In logback access, new Appenders are available, namely <code>SocketAppender</code>
- and <code>DBAppender</code>.
- Logback access now supports filtering and event evaluations. A <code>CountingFilter</code>
- has been added. It provides statistical views of server access, reachable
- via JMX.
+ In logback access, new Appenders are available, namely
+ <code>SocketAppender</code> and <code>DBAppender</code>.
+ Logback access now supports filtering and event evaluations. A
+ <code>CountingFilter</code> has been added. It provides
+ statistical views of server access, reachable via JMX.
</p>
<p>
@@ -186,7 +213,7 @@
<p>
This release offers a important improvements in Joran. In
particular, Joran can now replay configuration elements.
- </p>
+ </p>
<p>
As in the previous release, a major area of work is the
Modified: logback/trunk/logback-site/src/site/resources/templates/left.js
==============================================================================
--- logback/trunk/logback-site/src/site/resources/templates/left.js (original)
+++ logback/trunk/logback-site/src/site/resources/templates/left.js Tue Feb 27 21:17:11 2007
@@ -1,16 +1,19 @@
-document.write('<p class="menu_header">Logback</p>');
-document.write('<p><a href="index.html">Introduction</a>');
-document.write('<a href="' + prefix + 'news.html">News</a>');
-document.write('<a href="' + prefix + 'download.html">Download</a>');
-document.write('<a href="' + prefix + 'documentation.html">Documentation</a>');
-document.write('<a href="' + prefix + 'mailinglist.html">Mailing Lists</a>');
-document.write('<a href="' + prefix + 'repos.html">Source Repository</a>');
-document.write('<a href="' + prefix + 'bugreport.html">Bug Report</a>');
-document.write('<a href="' + prefix + 'license.html">License</a>');
-document.write('<a href="http://logback.qos.ch/translator/">Log4j Properties Translator</a>');
-document.write('<a href="' + prefix + 'team.html">Logback Team</a>');
-document.write('<a href="http://www.qos.ch/"><img src="' + prefix + 'images/logos/qosLogo.png" /></a>');
+document.write('<p class="menu_header">Logback project</p>');
+document.write('<p class="menu"><a href="index.html">Introduction</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'news.html">News</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'download.html">Download</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'documentation.html">Documentation</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'mailinglist.html">Mailing Lists</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'repos.html">Source Repository</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'bugreport.html">Bug Report</a></p>');
+document.write('<p class="menu"><a href="' + prefix + 'license.html">License</a></p>');
+document.write('<p class="menu"><a href="http://logback.qos.ch/translator/">Log4j Properties Translator</a>');
+document.write('<p class="menu"><a href="' + prefix + 'team.html">Logback Team</a></p>');
+document.write('<p><a class="x" href="http://www.qos.ch/"><img src="' + prefix + 'images/logos/qosLogo.png" /></a></p>');
+
+document.write('<span class="small">Last updated 2007-02-27</span>');
+
document.write('</p>');
Modified: logback/trunk/logback-site/src/site/resources/templates/right.js
==============================================================================
--- logback/trunk/logback-site/src/site/resources/templates/right.js (original)
+++ logback/trunk/logback-site/src/site/resources/templates/right.js Tue Feb 27 21:17:11 2007
@@ -1,4 +1,4 @@
document.write('<p class="menu_header">New and noteworthy</p>')
-document.write('<p><a href="10reasons.ppt">10 reasons for migrating</a>')
+document.write('<p class="menu"><a href="10reasons.ppt">10 reasons for migrating</a>')
document.write('</p>')
More information about the logback-dev
mailing list