Author: seb Date: Fri Oct 27 16:08:14 2006 New Revision: 805 Modified: logback/trunk/logback-site/src/site/xdocTemplates/joran.xml logback/trunk/logback-site/src/site/xdocTemplates/manual/layouts.xml logback/trunk/logback-site/src/site/xdocTemplates/shortIntro.xml Log: modified documents to display correct paths to example files Modified: logback/trunk/logback-site/src/site/xdocTemplates/joran.xml ============================================================================== --- logback/trunk/logback-site/src/site/xdocTemplates/joran.xml (original) +++ logback/trunk/logback-site/src/site/xdocTemplates/joran.xml Fri Oct 27 16:08:14 2006 @@ -28,7 +28,7 @@ </p> <p>The examples for this tutorial can be found under -<em>LOGBACK_HOME/logback-core/examples/src/joran</em>. +<em>LOGBACK_HOME/logback-examples/src/main/java/joran</em>. </p> <p>To install joran, simply <a href="download.html">download</a> @@ -166,7 +166,7 @@ <a name="helloWorld" /> <h3>A hello world example</h3> -<p>The <em>examples/src/joran/helloWorld/</em> directory includes a +<p>The <em>logback-examples/src/main/java/joran/helloWorld/</em> directory includes a trivial action and Joran interpreter setup which just diaplays "Hello World" when a <hello-world> element is encountered in an XML file. It also includes the basic steps which are @@ -210,7 +210,7 @@ <a name="calculator" /> <h3>Collaborating actions</h3> <p> -The examples/src/joran/calculator/ directory includes several actions +The logback-examples/src/main/java/joran/calculator/ directory includes several actions which collaborate together through the common object stack in order to accomplish simple computations. </p> @@ -285,7 +285,7 @@ <h3>New-rule action</h3> <p>Joran includes an action which allows the Joran interpreter to lean new rules on the fly while interpreting the XML file containing the -new rules. See the <em>logback-core/examples/src/joran/newRule/</em> +new rules. See the <em>logback-examples/src/main/java/joran/newRule/</em> directory for sample code. </p> <p>In this package, the <code>NewRuleCalculator</code> class contains @@ -377,7 +377,7 @@ <code>ch.qos.logback.core.joran.action</code> package. </p> -<p>Refer to the <em>logback-core/examples/src/joran/implicit</em> +<p>Refer to the <em>logback-examples/src/main/java/joran/implicit</em> directory for an example of an implicit action. </p> 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 Oct 27 16:08:14 2006 @@ -102,7 +102,7 @@ <p>Here is a possible implementation, authored by the Texan developer:</p> <em>Example 5.0: Sample implementation of a Layout - (examples/chapter5/MySampleLayout.java)</em> + (logback-examples/src/main/java/chapter5/MySampleLayout.java)</em> <div class="source"><pre>package chapter5; import ch.qos.logback.classic.ClassicLayout; @@ -174,7 +174,7 @@ <p>Custom layouts are configured as any other layout, as shown below:</p> <em>Example 5.0: Configuration of MySampleLayout - (examples/chapter5/sampleLayoutConfig.xml)</em> + (logback-examples/src/main/java/chapter5/sampleLayoutConfig.xml)</em> <div class="source"><pre><configuration> <appender name="STDOUT" @@ -289,7 +289,7 @@ </p> - <a name="AccessPatternLayout" /> + <a name="ClassicPatternLayout" /> <h3>PatternLayout</h3> <p> @@ -322,7 +322,7 @@ </p> <em> Example 5.1: Sample usage of a PatternLayout - (examples/chapter5/PatternSample.java) + (logback-examples/src/main/java/chapter5/PatternSample.java) </em> <div class="source"><pre>package chapter5; @@ -1015,7 +1015,7 @@ </p> <em> Example 5.2: Sample usage of EventEvaluators - (examples/chapter5/callerEvaluatorConfig.xml) + (logback-examples/src/main/java/chapter5/callerEvaluatorConfig.xml) </em> <div class="source"><pre><configuration> <b><evaluator name="DISP_CALLER_EVAL"> @@ -1040,7 +1040,7 @@ <p>Let us test this configuration with the following code.</p> <em> Example 5.2: Sample usage of EventEvaluators - (examples/chapter5/EventEvaluatorExample.java) + (logback-examples/src/main/java/chapter5/EventEvaluatorExample.java) </em> <div class="source"><pre>public class CallerEvaluatorExample { @@ -1135,7 +1135,7 @@ <p>The following configuration will allow that.</p> <em> Example 5.3: Sample usage of EventEvaluators - (examples/chapter5/exceptionEvaluatorConfig.xml) + (logback-examples/src/main/java/chapter5/exceptionEvaluatorConfig.xml) </em> <div class="source"><pre><configuration> @@ -1182,6 +1182,7 @@ <p>Let us say that our customized <code>Converter</code> will output the level of the logging event, colored following ANSI rules. Here is the necessary implementation:</p> +<em> Example 5.4: Sample Converter Example (examples/chapter5/MySampleConverter.java)</em> <div class="source"><pre>package chapter5; import ch.qos.logback.classic.Level; @@ -1231,9 +1232,11 @@ the new <code>Converter</code>. For this task, we just need to declare the new conversion word in the configuration file, as shown below:</p> +<em> Example 5.4: Sample Converter Example (examples/chapter5/mySampleConverterConfig.xml)</em> <div class="source"><pre><configuration> - <b><conversionRule conversionWord="sample" converterClass="chapter5.MySampleConverter" /></b> + <b><conversionRule conversionWord="sample" converterClass="chapter5. \ + MySampleConverter" /></b> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 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 Oct 27 16:08:14 2006 @@ -96,7 +96,7 @@ to your classpath, you can begin experimenting with logback. </p> -<em>Example 1.1: Basic template for logging (examples/chapter1/HelloWorld1.java)</em> +<em>Example 1.1: Basic template for logging (logback-examples/src/main/java/chapter1/HelloWorld1.java)</em> <div class="source"><pre>package chapter1; import org.slf4j.Logger; @@ -144,7 +144,7 @@ <p> - Once you're in the <em>examples/classes</em> directory of the logback distribution, you can run this class with the command: + Once you're in the <em>logback-examples/classes</em> directory of the logback distribution, you can run this class with the command: </p> <div class="source"><pre>java chapter1.HelloWorld1</pre></div> @@ -166,7 +166,7 @@ class. </p> -<em>Example 1.2: Printing Logger Status (examples/chapter1/HelloWorld2.java)</em> +<em>Example 1.2: Printing Logger Status (logback-examples/src/main/java/chapter1/HelloWorld2.java)</em> <div class="source"><pre>package chapter1; import org.slf4j.Logger; @@ -206,7 +206,7 @@ simplest but least flexible way is by calling the <code>BasicConfigurator</code> class, like in the following code snippet. </p> - <em>Example 1.3: Configuring before logging (examples/chapter1/HelloWorld3.java)</em> + <em>Example 1.3: Configuring before logging (logback-examples/src/main/java/chapter1/HelloWorld3.java)</em> <div class="source"><pre>package chapter1; import org.slf4j.Logger; @@ -991,7 +991,7 @@ Let us give a taste of how logback configuration is done with the help of an imaginary application MyApp that uses logback. </p> - <em>Example 1.4: Basic configuration (examples/chapter1/MyApp.java)</em> + <em>Example 1.4: Basic configuration (logback-examples/src/main/java/chapter1/MyApp.java)</em> <div class="source"><pre>package chapter1; // Import SLF4J classes. @@ -1019,7 +1019,7 @@ This class defines a logger instance variable with the name MyApp. It then uses the Bar class, defined as shown below: </p> - <em>Example 1.4: Basic configuration (examples/chapter1/Bar.java)</em> + <em>Example 1.4: Basic configuration (logback-examples/src/main/java/chapter1/Bar.java)</em> <div class="source"><pre>class Bar { Logger logger = LoggerFactory.getLogger(Bar.class); @@ -1044,7 +1044,7 @@ <p>Let's configure logback to do exactly the same output, this time with an XML configuration file.</p> - <em>Example 1.4: Basic configuration (examples/chapter1/sample-config-1.xml)</em> + <em>Example 1.4: Basic configuration (logback-examples/src/main/java/chapter1/sample-config-1.xml)</em> <div class="source"><pre><?xml version="1.0" encoding="UTF-8" ?> <configuration> @@ -1077,7 +1077,7 @@ <p>The console output will be exactly the same as before. However, this time, we didn't need to import and call the BasicConfigurator class, as you can see in the following code section: </p> - <em>Example 1.5: Logback configuration from file (examples/chapter1/MyAppWithConfigFile.java)</em> + <em>Example 1.5: Logback configuration from file (logback-examples/src/main/java/chapter1/MyAppWithConfigFile.java)</em> <div class="source"><pre>package chapter1; //Import SLF4J classes. @@ -1118,7 +1118,7 @@ <p>Logging to the console is a rather simple example. Let's now configure logback so that it logs to the console, but also to a custom file.</p> -<em>Example 1.5: Logback configuration from file (examples/chapter1/sample-config-2.xml)</em> +<em>Example 1.5: Logback configuration from file (logback-examples/src/main/java/chapter1/sample-config-2.xml)</em> <div class="source"><pre><?xml version="1.0" encoding="UTF-8" ?> <configuration> @@ -1157,7 +1157,7 @@ <p>Suppose that we do not want to see the DEBUG level statements in the chapter1 package anymore. This is done by adding the following xml snippet to the configuration file, right before the <code><root></code> element.</p> -<em>Example 1.5: Logback configuration from file (examples/chapter1/sample-config-3.xml)</em> +<em>Example 1.5: Logback configuration from file (logback-examples/src/main/java/chapter1/sample-config-3.xml)</em> <div class="source"><pre><?xml version="1.0" encoding="UTF-8" ?> <configuration>