[slf4j-dev] svn commit: r710 - in slf4j/trunk/slf4j-site: . src/site/resources src/site/resources/css
ceki at slf4j.org
ceki at slf4j.org
Mon Feb 5 23:37:05 CET 2007
Author: ceki
Date: Mon Feb 5 23:37:04 2007
New Revision: 710
Modified:
slf4j/trunk/slf4j-site/pom.xml
slf4j/trunk/slf4j-site/src/site/resources/css/site.css
slf4j/trunk/slf4j-site/src/site/resources/download.html
slf4j/trunk/slf4j-site/src/site/resources/index.html
slf4j/trunk/slf4j-site/src/site/resources/mailing-lists.html
slf4j/trunk/slf4j-site/src/site/resources/manual.html
slf4j/trunk/slf4j-site/src/site/resources/news.html
slf4j/trunk/slf4j-site/src/site/resources/svn.html
Log:
minor documentation improvements/fixes
Modified: slf4j/trunk/slf4j-site/pom.xml
==============================================================================
--- slf4j/trunk/slf4j-site/pom.xml (original)
+++ slf4j/trunk/slf4j-site/pom.xml Mon Feb 5 23:37:04 2007
@@ -33,7 +33,6 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<configuration>
- <xdocDirectory>src/site/xdocs</xdocDirectory>
<outputDirectory>${project.parent.basedir}/target/site</outputDirectory>
</configuration>
</plugin>
Modified: slf4j/trunk/slf4j-site/src/site/resources/css/site.css
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/css/site.css (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/css/site.css Mon Feb 5 23:37:04 2007
@@ -6,7 +6,7 @@
body {
background-color: #fff;
font-family: Verdana, Arial, SunSans-Regular, Sans-Serif;
- color:#564b47;
+ color: #000;
padding:0px;
margin:0px;
font-size: small;
@@ -22,7 +22,7 @@
a {
- color: navy;
+ color: #0000CC;
/*font-size: smaller;*/
background-color:transparent;
text-decoration: none;
@@ -40,11 +40,10 @@
padding-bottom: 0.5ex;
padding-top: 0.5ex;
padding-left: 1ex;
- /*white-space: pre;*/
+ white-space: pre;
}
pre {
- color: #564b47;
background-color:transparent;
font-family: Courier, Monaco, Monospace;
}
@@ -55,31 +54,29 @@
font-size: 10px;
}
-h1 {
+h1, h2, h3, h4 {
+ color: #333;
}
h2 {
padding-top:10px;
- color: #564b47;
background-color: transparent;
- font-weight: 900;
- font-size: x-large;
+ font-weight: 900;
+ font-size: x-large;
}
h3 {
padding-top:10px;
- color: #564b47;
- background-color: transparent;
- font-weight: normal;
- font-size: large;
+ background-color: transparent;
+ font-weight: normal;
+ font-size: large;
}
h4 {
padding-top:5px;
- color: navy;
- background-color: transparent;
- font-weight: large;
- font-size: normal;
+ background-color: transparent;
+ font-weight: large;
+ font-size: normal;
}
.footer {
@@ -90,8 +87,6 @@
margin:0px
}
-
-
strong {
/*font-size: 13px;*/
font-weight: bold;
@@ -130,7 +125,7 @@
margin: 0px;
padding: 2px;
border: solid 1px #FFFFFF;
- color: #0066cc;
+ color: #0000CC;
text-decoration: none;
}
@@ -145,7 +140,7 @@
#left a:hover, #right a:hover {
border: solid 1px #FFFFFF;
- background-color: #0066cc;
+ background-color: #3333CC;
color: #ffffff;
}
@@ -259,3 +254,11 @@
margin-left: 3em;
margin-right: 3em;
}
+
+table.bodyTable tr.a {
+ background-color: #ddd;
+}
+
+table.bodyTable tr.b {
+ background-color: #eee;
+}
\ No newline at end of file
Modified: slf4j/trunk/slf4j-site/src/site/resources/download.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/download.html (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/download.html Mon Feb 5 23:37:04 2007
@@ -24,8 +24,7 @@
<h2>Latest official SLF4J version</h2>
<p>Download version 1.2 including <i>full source code</i>,
- class files and documentation as
- </p>
+ class files and documentation in ZIP or TAR.GZ format: </p>
<ul>
<li><a href="dist/slf4j-1.2.tar.gz"><b>slf4j-1.2.tar.gz</b></a> </li>
Modified: slf4j/trunk/slf4j-site/src/site/resources/index.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/index.html (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/index.html Mon Feb 5 23:37:04 2007
@@ -52,7 +52,7 @@
<p>SLF4J does not rely on any special class loader machinery. In
fact, the binding between SLF4J and a given logging API
implementation is performed <em>statically</em> at compile time of
- each binding. Each binding is hardwired to use one and only specific
+ each binding. Each binding is hardwired to use one and only one specific
logging API implementation. Each binding corresponds to one jar
file. In your code, you simply drop the binding of your choice, that
is a jar file, onto the appropriate class path location. As a
Modified: slf4j/trunk/slf4j-site/src/site/resources/mailing-lists.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/mailing-lists.html (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/mailing-lists.html Mon Feb 5 23:37:04 2007
@@ -116,13 +116,11 @@
<a href="http://www.slf4j.org/pipermail/dev/">Pipermail</a> |
<a href="http://news.gmane.org/gmane.comp.java.slf4j.devel">Gmane</a> |
<a href="http://marc.theaimsgroup.com/?l=slf4j-dev">MARC</a> |
- <a href="http://www.mail-archive.com/dev%40slf4j.org/">MailArchive</a>
-
-
- </p>
-
-
-
+ <a href="http://www.mail-archive.com/dev%40slf4j.org/">MailArchive</a> </p>
+ <p> </p>
+ <h2>On IRC</h2>
+ <p>We can also be reached by IRC at irc.freenode.net#slf4j. </p>
+ <p> </p>
</div>
</body>
</html>
Modified: slf4j/trunk/slf4j-site/src/site/resources/manual.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/manual.html (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/manual.html Mon Feb 5 23:37:04 2007
@@ -62,35 +62,32 @@
<h2>Swapping implementations at deployment time</h2>
<p>SLF4J supports multiple logging systems, namely, NOP,
- Simple, log4j version 1.2, log4j version 1.3, JDK 1.4 logging,
+ Simple, log4j version 1.2, JDK 1.4 logging,
JCL and logback. The SLF4J distribution ships with several jar
files <em>slf4j-nop.jar</em>, <em>slf4j-simple.jar</em>,
<em>slf4j-log4j12.jar</em>, <em>slf4j-log4j13.jar</em>,
<em>slf4j-jdk14.jar</em> and <em>slf4j-jcl.jar</em>. Each of
these jar files is hardwired <em>at compile-time</em> to use
just one implementation, that is NOP, Simple, log4j version
- 1.2, log4j version 1.3, JDK 1.4 logging, and repectively
- JCL. <span style="color:#D22">As of version SLF4J 1.1.0, all of the
+ 1.2, JDK 1.4 logging, and repectively
+ JCL. <span style="color:#D22">As of SLF4J version 1.1.0, all of the
bindings shipped with SLF4J depend on <em>slf4j-api.jar</em>
which must be present on the class path for the binding to
- function properly.</span>
- </p>
+ function properly.</span> </p>
<h2>Small applications</h2>
<p>Small applications where configuring a fully-fledged
logging systems can be somewhat of an overkill, can drop in
- <em>slf4j-simple.jar</em> instead of a binding for the
- fully-fledged logging system.
- </p>
+ <em> <em>slf4j-api.jar+</em>slf4j-simple.jar</em> instead of a binding for a
+ fully-fledged logging system. </p>
<h2>Libraries</h2>
<p>Authors of widely-distributed components and libraries may
code against the SLF4J interface in order to avoid imposing an
- logging API implementation on the end-user. At deployment
- time, the end-user may choose the desired logging API
- implementation by inserting the corresponding jar file in her
+ logging system on the end-user. At deployment
+ time, the end-user may choose the desired logging system by inserting the corresponding jar file in her
classpath. This stupid, simple and robust approach avoids many
of the painful bugs associated with dynamic discovery
processes.
@@ -119,8 +116,8 @@
<h2>Built-in support in logback</h2>
- <p>The <code>Logger</code> class in logback directly
- implements SLF4J's <code>Logger</code> interface. Moreover,
+ <p>The <code>ch.qos.logback.classic.Logger</code> class in logback directly
+ implements SLF4J's <code>org.slf4j.Logger</code> interface. Moreover,
logback makes extensive use of SLF4J internally.
</p>
@@ -188,15 +185,13 @@
API, a decision which can be deferred to a later time.
</p>
- <p>On the other hand, <em>slf4j-jcl.jar</em> is useful after
- you have already adopted the SLF4J API for your component
+ <p>On the other hand, <em>slf4j-jcl.jar</em> is useful <strong>after</strong> you have already adopted the SLF4J API for your component
which needs to be embedded in a larger application environment
where JCL is a formal requirement. Your software component can
still use SLF4J API without disrupting the larger
application. Indeed, <em>slf4j-jcl.jar</em> will delegate all
logging decisions to JCL so that the dependency on SLF4J API
- by your component will be transparent to the larger whole.
- </p>
+ by your component will be transparent to the larger whole. </p>
<p>Please note that <em>jcl104-over-slf4j.jar</em> and
<em>slf4j-jcl.jar</em> cannot be deployed at the same
@@ -208,13 +203,13 @@
<a name="summary"><h2>Summary</h2></a>
- <table class="ls" cellspacing="4" cellpadding="4">
+ <table class="bodyTable" cellspacing="4" cellpadding="4">
<tr>
<th align="left">Advantage</th>
<th align="left">Description</th>
</tr>
- <tr>
+ <tr class="a">
<td>Swappable logging API implementations</td>
<td>The desired logging API can be plugged in at
deployment time by inserting the appropriate jar file on
@@ -223,8 +218,8 @@
</tr>
- <tr>
- <td>Fail-safe operation</td>
+ <tr class="b">
+ <td>Fail-fast operation</td>
<td>Assuming the appropriate jar file is available on the
classpath, under no circumstances will SLF4J cause your
application to fail. SLF4J's simple and robust design
@@ -243,7 +238,7 @@
</tr>
- <tr>
+ <tr class="a">
<td>Adapter implementations for popular logging systems
</td>
@@ -254,7 +249,7 @@
</tr>
- <tr>
+ <tr class="b">
<td>Easy migration path</td>
<td>
@@ -267,7 +262,7 @@
</td>
</tr>
- <tr>
+ <tr class="a">
<td>Support for formated log messages</td>
<td>All SLF4J adapters support formated log messages with
@@ -275,7 +270,7 @@
</tr>
- </table>
+ </table>
</div>
Modified: slf4j/trunk/slf4j-site/src/site/resources/news.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/news.html (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/news.html Mon Feb 5 23:37:04 2007
@@ -29,8 +29,12 @@
<hr noshade="noshade" size="1"/>
- <h3>January 24th, 2006 - Release of SLF4J 1.2</h3>
-
+ <h3>Fabruary xx, 2007 - Release of SLF4J 1.3</h3>
+ <p>This release consists of rearrangement of packages, while transparent to the end-user, make
+ SLF4J even more OSGi friendly. In particular, the <code>org.slf4j</code> is
+ entirely contained within <em>slf4j-api.jar</em> whereas the <code>org.slf4j.impl</code> package is entirely contained within each binding. </p>
+ <p>It is now possible to obtain the root logger of the underlying logging implementation by requesting a logger named "ROOT". This feature was requested by Sebastien Davids in <a href="http://bugzilla.slf4j.org/show_bug.cgi?id=35">bug report 35</a>. </p>
+ <h3>January 24th, 2007 - Release of SLF4J 1.2</h3>
<p>This release includes several modifications to make SLF4J
an <a href="http://www.osgi.org/">OSGi</a>-friendly framework.
The modules' MANIFEST.MF files now include
@@ -153,7 +157,7 @@
<p>Release 1.0.1 is a maintenance release containing bug fixes only.
- <ul>
+ <ul>
<li>Fixed <a
href="http://bugzilla.slf4j.org/show_bug.cgi?id=20">bug number
@@ -169,7 +173,7 @@
version 0.2. The bug was reported by Dave Wallace.
</li>
- </ul>
+ </ul>
</p>
Modified: slf4j/trunk/slf4j-site/src/site/resources/svn.html
==============================================================================
--- slf4j/trunk/slf4j-site/src/site/resources/svn.html (original)
+++ slf4j/trunk/slf4j-site/src/site/resources/svn.html Mon Feb 5 23:37:04 2007
@@ -21,21 +21,19 @@
<h1>Source code repositories</h1>
- <p>SLF4j developers are live in different countries throughout the
+ <p>SLF4j developers live in different countries throughout the
world. To enable them to work together, we keep the source code in
- revision control systems called Subversion. Developers have write
+ a revision control system called Subversion. SLF4J developers have write
access to the Subversion repository, enabling them to make changes
- to the source code. Everyone has read access to the repositories, so
- you may download the most up-to-date development version of the
+ to the source code. Everyone else has read access to the repository, so
+ you may check out the most up-to-date development version of the
software. Note that the latest version in the Subversion repository
many not work as expected, it may not even compile properly. If you
are looking for a stable release of the source code, you should
- download an official distribution instead of the latest version in
- the Subversion repositories.
- </p>
+ download an official distribution instead of the latest version from Subversion. </p>
- <p>There are several ways to access the Subversion repositories:</p>
+ <p>There are several ways to access the Subversion repository:</p>
<h2>Web Access</h2>
More information about the slf4j-dev
mailing list