Author: seb Date: Fri Jan 5 14:16:52 2007 New Revision: 1161 Added: logback/trunk/logback-site/src/site/xdocTemplates/setup.xml Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/joran.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Log: Added setup page and links from the doc Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/appenders.xml Fri Jan 5 14:16:52 2007 @@ -41,9 +41,21 @@ </td> </tr> </table> - + + <div class="highlight"> + <p> + Running the examples provided with + the complete logback manual only requires + a few steps. + </p> + <p> + To set you up quickly, please visit + the <a href="../setup.html">dedicated page</a>. + </p> + </div> + <h2>What is an Appender</h2> - + <p> Logback delegates the task of writing a logging event to appenders. Appenders must implement the @@ -302,7 +314,7 @@ logger.debug("Hello world."); } }</pre></div> - + <p> This example creates a <code>WriterAppender</code> that uses an <code>OutputStreamWriter</code> @@ -322,7 +334,7 @@ <code>ExitWoes2</code> class uses this statement and outputs a logging request. </p> - + <p> The <code>WriterAppender</code> is the super class of four other appenders, namely <code>ConsoleAppender</code>, <code>FileAppender</code> which in turn is @@ -393,10 +405,8 @@ </configuration></pre></div> <p> - To run this example, as well as others in this - chapter, please run the script provided in the <em>logback-examples</em> directory. - Then, use the <code>ConfigurationTester</code> by - issuing the following command, once in the <em>logback-examples</em> directory: + To run this example, just issue the following command, + once in the <em>logback-examples</em> directory: </p> <div class="source"><pre>java chapter4.ConfigurationTester src/main/java/chapter4/conf/logback-Console.xml</pre></div> Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/filters.xml Fri Jan 5 14:16:52 2007 @@ -50,7 +50,19 @@ Logback filters are based on ternary logic allowing them to be assembled or chained together to compose an arbitrarily complex filtering policy. </p> - + + <div class="highlight"> + <p> + Running the examples provided with + the complete logback manual only requires + a few steps. + </p> + <p> + To set you up quickly, please visit + the <a href="../setup.html">dedicated page</a>. + </p> + </div> + <p> There are two main types of filters, namely <code>Filter</code> and <code>TurboFilter</code>. Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/joran.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/joran.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/joran.xml Fri Jan 5 14:16:52 2007 @@ -42,7 +42,18 @@ </tr> </table> - + <div class="highlight"> + <p> + Running the examples provided with + the complete logback manual only requires + a few steps. + </p> + <p> + To set you up quickly, please visit + the <a href="../setup.html">dedicated page</a>. + </p> + </div> + <p>Joran stands for a cold north-west wind which, every now and then, blows force-fully on Lake Leman, a.k.a lake Geneva. Located right in the middle of Europe, the Leman happens to be the continent's largest Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml Fri Jan 5 14:16:52 2007 @@ -44,8 +44,19 @@ </tr> </table> + <div class="highlight"> + <p> + Running the examples provided with + the complete logback manual only requires + a few steps. + </p> + <p> + To set you up quickly, please visit + the <a href="../setup.html">dedicated page</a>. + </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 Modified: logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/manual/mdc.xml Fri Jan 5 14:16:52 2007 @@ -50,6 +50,18 @@ This technique promotes the proliferation of loggers and considerably increases their management overhead. </p> + <div class="highlight"> + <p> + Running the examples provided with + the complete logback manual only requires + a few steps. + </p> + <p> + To set you up quickly, please visit + the <a href="../setup.html">dedicated page</a>. + </p> + </div> + <p> A lighter technique consists of uniquely stamping each log request servicing a given client. Neil Harrison described this method in the book Added: logback/trunk/logback-site/src/site/xdocTemplates/setup.xml ============================================================================== --- (empty file) +++ logback/trunk/logback-site/src/site/xdocTemplates/setup.xml Fri Jan 5 14:16:52 2007 @@ -0,0 +1,76 @@ +<?xml version="1.0"?> +<document> + + <properties> + <author email="ceki at qos ddoott ch ">Ceki Gulcu</author> + <author email="sebastien at qos ddoott ch ">Sebastien Pennec</author> + <title>Logback Examples</title> + </properties> + + <body> + +<h2>Classpath Setup</h2> + +<p> +Setting up an environment to run the logback examples mainly consists +of putting a few jars in your classpath. For most examples, these are: +</p> + +<ul> + <p>logback-core-${version}.jar</p> + <p>logback-classic-${version}.jar</p> + <p>logback-examples-${version}.jar</p> + <p>slf4j-api-${slf4j.version}.jar</p> +</ul> + +<p> +Assuming your current directory is +<em>$LOGBACK_HOME/logback-examples</em>, where <em>$LOGBACK_HOME</em> is the +directory you've installed logback, you can launch the first +sample application, +<em>chapter1.HelloWord1</em> +with the command: +</p> + +<div class="source"><pre>java -cp + lib/slf4j-api-${slf4j.version}.jar;../logback-core-${version}.jar;\ + ../logback-classic-${version}.jar;logback-examples-${version}.jar\ + chapter1.HelloWorld1</pre></div> + +<p> +Having to include the jars in each command you run is not practical, +to say the least. Two scripts are available to help you setup the jars +in your system's classpath. They are located in +<em>$LOGBACK_HOME/logback-examples</em>. +</p> + +<p> +To run these scripts, you need to edit them and set the variable called +<em>LB_HOME</em> to the directory where you've installed logback. +</p> + +<p> +Unless specified differently, running the examples by using the command +provided in the manual will work if it is run from the +<em>$LOGBACK_HOME/logback-examples</em> directory. +</p> + + + + + + + + + + + + + + + + + + + </body> +</document> \ No newline at end of file Modified: logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Fri Jan 5 14:16:52 2007 @@ -154,17 +154,10 @@ </p> - <p>In order to facilitate running the the examples in this - introduction, we have placed the required slf4j-api.jar file in - the <em>$LOGBACK_HOME/logback-examples/lib</em> - directory. Assuming your current directory is - $LOGBACK_HOME/logback-examples, where $LOGBACK_HOME is the - directory you've installed logback, you can launch the first + <p>You can launch the first sample application, <em>chapter1.HelloWord1</em> with the command: </p> - <div class="source"><pre>java -cp lib/slf4j-api-1.1.0-beta0.jar;../logback-core-${version}.jar;\ - ../logback-classic-${version}.jar;logback-examples-${version}.jar\ - chapter1.HelloWorld1</pre></div> + <div class="source"><pre>java chapter1.HelloWorld1</pre></div> <p> Launching the <code>HelloWorld1</code> @@ -211,8 +204,8 @@ <p> - Logback explains it configured itself using its default - configuration, which is a basic <code>ConsoleAppender</code>. + Logback explains that it configured itself using its default + policy, which is a basic <code>ConsoleAppender</code>. An <code>Appender</code> is a class that can be seen as an output destination. Appenders exist for many different destinations including the console, files, Syslog, Socket, JMS and