cvs commit: logging-site/src/xdocs/site logging-site.xml

[ceki]

ceki        2004/01/23 10:15:51

  Modified:    docs/site logging-site.html
               src/xdocs/site logging-site.xml
  Log:
  Fixed documentaiton bug 
  
  PR:
  Obtained from:
  Submitted by: 
  Reviewed by:  
  
  Revision  Changes    Path
  1.2       +61 -41    logging-site/docs/site/logging-site.html
  
  Index: logging-site.html
  ===================================================================
  RCS file: /home/cvs/logging-site/docs/site/logging-site.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- logging-site.html 23 Jan 2004 18:04:30 -0000      1.1
  +++ logging-site.html 23 Jan 2004 18:15:51 -0000      1.2
  @@ -338,57 +338,77 @@
                                                                                       
               <p>
   Assuming that you are using <a href="http://ant.apache.org";>Ant</a> as
   your build tool for your project, we will now list the modifications
  -to your build file.
  -
  -<source><![CDATA[
  -    <property name="docs.src" value="./src/xdocs"/>
  -    <property name="docs.dest" value="./docs"/>
  +to your build file:
  +</p>
  +                                                                                    
                    <div align="left">
  +    <table cellspacing="4" cellpadding="0" border="0">
  +    <tr>
  +      <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" 
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  +      <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" 
height="1" vspace="0" hspace="0" border="0"/></td>
  +      <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" 
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  +    </tr>
  +    <tr>
  +      <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" 
height="1" vspace="0" hspace="0" border="0"/></td>
  +      <td bgcolor="#ffffff"><pre>
  +    &lt;property name=&quot;docs.src&quot; value=&quot;./src/xdocs&quot;/&gt;
  +    &lt;property name=&quot;docs.dest&quot; value=&quot;./docs&quot;/&gt;
   
  -    <property name="logging-site" 
  -             value="your copy of logging-site dir"/>
  +    &lt;property name=&quot;logging-site&quot; 
  +             value=&quot;your copy of logging-site dir&quot;/&gt;
        
  -     <!-- Construct classpath for building the html pages-->
  -     <path id="site.classpath">
  -       <fileset dir="${logging-site}/lib">
  -         <include name="*.jar"/>
  -       </fileset>
  -     </path>
  +     &lt;!-- Construct classpath for building the html pages --&gt;
  +     &lt;path id=&quot;site.classpath&quot;&gt;
  +       &lt;fileset dir=&quot;${logging-site}/lib&quot;&gt;
  +         &lt;include name=&quot;*.jar&quot;/&gt;
  +       &lt;/fileset&gt;
  +     &lt;/path&gt;
   
  +    &lt;!-- ============================ --&gt;
  +    &lt;!-- ======= New targets ======== --&gt;
  +    &lt;!-- ============================ --&gt;
   
  -    <target name="prepareSite">
  -      <available classname="org.apache.velocity.anakia.AnakiaTask"
  -     property="AnakiaTask.present">
  -     <classpath refid="site.classpath"/>
  -      </available>
  -    </target>
  +    &lt;target name=&quot;prepareSite&quot;&gt;
  +      &lt;available classname=&quot;org.apache.velocity.anakia.AnakiaTask&quot;
  +     property=&quot;AnakiaTask.present&quot;&gt;
  +     &lt;classpath refid=&quot;site.classpath&quot;/&gt;
  +      &lt;/available&gt;
  +    &lt;/target&gt;
       
  -    <target name="checkSite" depends="prepareSite" unless="AnakiaTask.present">
  -      <echo>
  +    &lt;target name=&quot;checkSite&quot; depends=&quot;prepareSite&quot; 
unless=&quot;AnakiaTask.present&quot;&gt;
  +      &lt;echo&gt;
        AnakiaTask is not present! Please check to make sure that
        velocity.jar is in your classpath.
  -      </echo>
  -    </target>
  +      &lt;/echo&gt;
  +    &lt;/target&gt;
       
  -    <target name="site" depends="checkSite" if="AnakiaTask.present">
  -      <taskdef name="anakia" classname="org.apache.velocity.anakia.AnakiaTask">
  -     <classpath refid="site.classpath"/>
  -      </taskdef>
  +    &lt;target name=&quot;site&quot; depends=&quot;checkSite&quot; 
if=&quot;AnakiaTask.present&quot;&gt;
  +      &lt;taskdef name=&quot;anakia&quot; 
classname=&quot;org.apache.velocity.anakia.AnakiaTask&quot;&gt;
  +     &lt;classpath refid=&quot;site.classpath&quot;/&gt;
  +      &lt;/taskdef&gt;
       
  -      <mkdir dir="${docs.dest}/css"/>  
  -      <copy file="${logging-site}/docs/css/site.css" 
tofile="${docs.dest}/css/site.css"/>
  +      &lt;mkdir dir=&quot;${docs.dest}/css&quot;/&gt;  
  +      &lt;copy file=&quot;${logging-site}/docs/css/site.css&quot; 
tofile=&quot;${docs.dest}/css/site.css&quot;/&gt;
         
  -      <anakia basedir="${xdocs.src}" destdir="${docs.dest}/"
  -     extension=".html"
  -     style="site.vsl"
  -     projectFile="stylesheets/project.xml"
  -     excludes="**/stylesheets/**, empty.xml"
  -     includes="**/*.xml"
  -     lastModifiedCheck="true"
  -     templatePath="${logging-site}/src/xdocs/stylesheets">
  -      </anakia>
  -    
  -    </target>]]></source>
  -</p>
  +      &lt;anakia basedir=&quot;${xdocs.src}&quot; destdir=&quot;${docs.dest}/&quot;
  +     extension=&quot;.html&quot;
  +     style=&quot;site.vsl&quot;
  +     projectFile=&quot;stylesheets/project.xml&quot;
  +     excludes=&quot;**/stylesheets/**, empty.xml&quot;
  +     includes=&quot;**/*.xml&quot;
  +     lastModifiedCheck=&quot;true&quot;
  +     templatePath=&quot;${logging-site}/src/xdocs/stylesheets&quot;&gt;
  +      &lt;/anakia&gt;    
  +    &lt;/target&gt;
  +</pre></td>
  +      <td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" 
height="1" vspace="0" hspace="0" border="0"/></td>
  +    </tr>
  +    <tr>
  +      <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" 
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  +      <td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1" 
height="1" vspace="0" hspace="0" border="0"/></td>
  +      <td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif" 
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
  +    </tr>
  +    </table>
  +    </div>
                                                                                       
               <h2>Constructing your documentation</h2>
                                                                                       
               <p>Now, in order to build your website, all you need to do is:</p>
                                                                                       
                    <div align="left">
  
  
  
  1.2       +9 -6      logging-site/src/xdocs/site/logging-site.xml
  
  Index: logging-site.xml
  ===================================================================
  RCS file: /home/cvs/logging-site/src/xdocs/site/logging-site.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- logging-site.xml  23 Jan 2004 18:04:30 -0000      1.1
  +++ logging-site.xml  23 Jan 2004 18:15:51 -0000      1.2
  @@ -212,7 +212,8 @@
   <p>
   Assuming that you are using <a href="http://ant.apache.org";>Ant</a> as
   your build tool for your project, we will now list the modifications
  -to your build file.
  +to your build file:
  +</p>
   
   <source><![CDATA[
       <property name="docs.src" value="./src/xdocs"/>
  @@ -221,13 +222,16 @@
       <property name="logging-site" 
                value="your copy of logging-site dir"/>
        
  -     <!-- Construct classpath for building the html pages-->
  +     <!-- Construct classpath for building the html pages -->
        <path id="site.classpath">
          <fileset dir="${logging-site}/lib">
            <include name="*.jar"/>
          </fileset>
        </path>
   
  +    <!-- ============================ -->
  +    <!-- ======= New targets ======== -->
  +    <!-- ============================ -->
   
       <target name="prepareSite">
         <available classname="org.apache.velocity.anakia.AnakiaTask"
  @@ -259,10 +263,9 @@
        includes="**/*.xml"
        lastModifiedCheck="true"
        templatePath="${logging-site}/src/xdocs/stylesheets">
  -      </anakia>
  -    
  -    </target>]]></source>
  -</p>
  +      </anakia>    
  +    </target>
  +]]></source>
   
   <h2>Constructing your documentation</h2>
       <p>Now, in order to build your website, all you need to do is:</p>