You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by ce...@apache.org on 2004/11/18 22:48:53 UTC

cvs commit: logging-log4j/docs codes.html

ceki        2004/11/18 13:48:53

  Modified:    docs/css site.css
  Added:       src/xdocs codes.xml
               docs     codes.html
  Log:
  Documenting messages generated by log4j at runtime.
  
  Revision  Changes    Path
  1.5       +30 -2     logging-log4j/docs/css/site.css
  
  Index: site.css
  ===================================================================
  RCS file: /home/cvs/logging-log4j/docs/css/site.css,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- site.css	2 Nov 2004 19:37:18 -0000	1.4
  +++ site.css	18 Nov 2004 21:48:53 -0000	1.5
  @@ -102,7 +102,7 @@
     font-weight: bolder;
   }
   
  -/* this class is used for screen output placed in <pre></pre> tags
  +/* this class is used for screen output placed in <pre></pre> tags */
   .screen_output {
     padding-left:  1em;
     padding-right: 1em;
  @@ -110,4 +110,32 @@
     border-right: 1px solid #AAAAAA;
     border-bottom:1px solid #AAAAAA;
     border-left:  1px solid #AAAAAA;
  -}
  \ No newline at end of file
  +}
  +
  +
  +.big {
  +  font-size: larger;
  +  font-weight: bold;
  +}
  +
  +.small {
  +  font-size: smaller;
  +}
  +
  +.red {
  +  color: #AA0000;
  +}
  +
  +.msg_title {
  +  padding-left:  1em;
  +  padding-right: 1em;
  +  font-family: Courier, "MS Courier New", Prestige, Everson Monocourrier, monospace;
  +  border:   1px solid #AAAAAA;
  +  background: #DDDDFF;
  +
  +}
  +
  +.msg_meaning {
  +  padding-left:  2em;
  +  padding-right: 1em;
  +}
  
  
  
  1.1                  logging-log4j/src/xdocs/codes.xml
  
  Index: codes.xml
  ===================================================================
  <?xml version="1.0"?>
  
  <document>
  
    <properties>
      <author email="ceki AT aappaacchheeee DOT org">Ceki Gulcu</author>
      <title>Log4j error codes</title>
    </properties>
  
    <body>
  
      <center>
        <h2>Log4j error messages and their meanings</h2>
        <h3>Ceki  G&#252;lc&#252; <br/>
        November 2004, last updated on November 18th, 2004</h3>
      </center>
      
      <message ref="log4j_dtd">
        <title>The 'log4j.dtd' is no longer used nor needed.</title>
        
        <explanation>
          <p>Given syntactical flexiblilty that
          <code>JoranConfigrator</code> supports, it is no longer
          possible to express this syntatical range with a DTD. Thus,
          new log4j configuration files in XML should follow the general
          template.
          </p>
  
          <p class="red big">Good:</p>
  
          <pre>&lt;?xml version="1.0" encoding="UTF-8" ?>
  <b>&lt;!DOCTYPE log4j:configuration></b>
  
  &lt;log4j:configuration>
    ...
  &lt;/log4j:configuration>
          </pre>
  
          <p>However, <code>JoranConfigurator</code> will continue to
          parse your old XML configuration files which previously
          required a reference to <code>log4j.dtd</code>. Thus, altough
          deprecated, the following form will continue to be parsed
          correctly.
          </p>
  
          <p class="red big">Deprecated:</p>
  
            <pre>&lt;?xml version="1.0" encoding="UTF-8" ?>
  <b>&lt;!DOCTYPE log4j:configuration SYSTEM "log4j.dtd" ></b>
          </pre>
       
  
          <p>Using the deprecated form will generate the above mentioned
          warning message.
          </p>
  
        </explanation>
      </message>
  
  
      
    </body>
  </document>
  
  
  1.1                  logging-log4j/docs/codes.html
  
  Index: codes.html
  ===================================================================
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  
  <!-- Content Stylesheet for Site -->
  
      
      
      
          
  <!-- start the processing -->
      <!-- ====================================================================== -->
      <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
      <!-- Main Page Section -->
      <!-- ====================================================================== -->
      <html>
          <head>
              <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
  
                                                      <meta name="author" value="Ceki Gulcu">
              <meta name="email" value="ceki AT aappaacchheeee DOT org">
              
              
                                      
                           
              <link href="./css/site.css" rel="stylesheet" type="text/css"/>
                                     
  
              <title>Log4j project - Log4j error codes</title>
          </head>
  
          <body bgcolor="#ffffff" text="#000000" link="#525D76">        
             <!-- START Header table --> 
                       <table class="banner" border="0">
       <tr>
         <td valign="top">
           <a href="http://logging.apache.org/">
             <img src="http://logging.apache.org/images/ls-logo.jpg" border="0"/>
           </a>
         </td>
         <td align="right">
                                	       <a href="http://logging.apache.org/log4j/docs/">
                   <img src="./images/logo.jpg" alt="The log4j project" border="0"/>
        	       </a>
                                 </td>
       </tr>
     </table>
                <!-- END Header table --> 
  
  	   <div class="centercol">
               <hr noshade="" size="1"/>
  		       
                                         <center>
        <h2>Log4j error messages and their meanings</h2>
        <h3>Ceki  G�lc� <br />
        November 2004, last updated on November 18th, 2004</h3>
      </center>
                                                                                 
              
    
                              <hr/>
  
    
                                              <div class="big">
          <a name="log4j_dtd">
           <b>Message:</b> <span class="msg_title">The 'log4j.dtd' is no longer used nor needed.</span>
          </a>
        </div>
        <div class="msg_meaning">
          
          <p>Given syntactical flexiblilty that
          <code>JoranConfigrator</code> supports, it is no longer
          possible to express this syntatical range with a DTD. Thus,
          new log4j configuration files in XML should follow the general
          template.
          </p>
  
          <p class="red big">Good:</p>
  
          <pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
  <b>&lt;!DOCTYPE log4j:configuration&gt;</b>
  
  &lt;log4j:configuration&gt;
    ...
  &lt;/log4j:configuration&gt;
          </pre>
  
          <p>However, <code>JoranConfigurator</code> will continue to
          parse your old XML configuration files which previously
          required a reference to <code>log4j.dtd</code>. Thus, altough
          deprecated, the following form will continue to be parsed
          correctly.
          </p>
  
          <p class="red big">Deprecated:</p>
  
            <pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
  <b>&lt;!DOCTYPE log4j:configuration SYSTEM "log4j.dtd" &gt;</b>
          </pre>
       
  
          <p>Using the deprecated form will generate the above mentioned
          warning message.
          </p>
  
        
        </div>
        
  
               
                  <!-- FOOTER -->
                <div align="center"><font color="#525D76" size="-1"><em>
                   Copyright &#169; 1999-2004, Apache Software Foundation
                 </em></font></div>
  
             <!-- END main table --> 
  
             <!-- LEFT SIDE NAVIGATION -->
               <!-- ============================================================ -->
    <div class="leftcol">
                 <div class="menu_header">Log4j Project</div>
                	 <div class="menu_item">        <a href="./index.html">Introduction</a>
    </div>
                	 <div class="menu_item">        <a href="./download.html">Download</a>
    </div>
                	 <div class="menu_item">        <a href="./documentation.html">Documentation</a>
    </div>
                	 <div class="menu_item">        <a href="./chainsaw.html">Chainsaw</a>
    </div>
                	 <div class="menu_item">        <a href="./plan.html">Plan</a>
    </div>
                	 <div class="menu_item">        <a href="http://wiki.apache.org/logging-log4j/Log4JProjectPages">Wiki</a>
    </div>
                	 <div class="menu_item">        <a href="./contactUs.html">Contact us</a>
    </div>
                	 <div class="menu_item">        <a href="./contributors.html">Contributors</a>
    </div>
                	 <div class="menu_item">        <a href="./history.html">History</a>
    </div>
                    <div class="menu_header">Logging Services</div>
                	 <div class="menu_item">        <a href="http://logging.apache.org/">Home page</a>
    </div>
                	 <div class="menu_item">        <a href="http://logging.apache.org/site/news.html">News</a>
    </div>
                	 <div class="menu_item">        <a href="http://logging.apache.org/site/mission-statement.html">Mission</a>
    </div>
                	 <div class="menu_item">        <a href="http://logging.apache.org/site/bylaws.html">Guidelines</a>
    </div>
                    <div class="menu_header">Translations</div>
                	 <div class="menu_item">        <a href="http://jakarta.apache-korea.org/log4j/index.html">Korean</a>
    </div>
                	 <div class="menu_item">        <a href="http://www.ingrid.org/jajakarta/log4j/">Japanese</a>
    </div>
               </div> 
     
  
          </body>
      </html>
  <!-- end the processing -->
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org