jakarta-site-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject cvs commit: jakarta-site2/docs/site jakarta-site2.html
Date Tue, 10 Jul 2001 15:52:23 GMT
jon         01/07/10 08:52:22

  Modified:    xdocs/site jakarta-site2.xml
               docs/site jakarta-site2.html
  Log:
  added more documentation about waht this page is
  
  suggestion by: William BC Crandall <crandall@wiesbaden.vistec.net>
  
  Revision  Changes    Path
  1.11      +35 -9     jakarta-site2/xdocs/site/jakarta-site2.xml
  
  Index: jakarta-site2.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-site2/xdocs/site/jakarta-site2.xml,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- jakarta-site2.xml	2001/07/09 18:14:33	1.10
  +++ jakarta-site2.xml	2001/07/10 15:52:08	1.11
  @@ -7,7 +7,40 @@
     </properties>
   
   <body>
  +  <section name="What is this?">
  +<p>
  +The Jakarta-Site2 module is where we store the code for building our
  +static HTML website. We use XML files as our input and transform them
  +into static HTML files (which is what you are reading now). The reason
  +why we use static HTML is because the apache.org server gets a huge
  +number of "hits" each day. Having a dynamic site would increase the load
  +on the server to an even more unacceptable level because apache.org is
  +a limited shared resource by hundreds of people. Using XML as our input
  +allows us to change the look and feel of the entire site in a matter of
  +seconds.
  +</p>
  +
  +<p>
  +Each Jakarta project has the choice of how they generate their website
  +and documentation. The "encouraged" way is to use the Jakarta-Site2
  +module as the basis for generating the documentation. The provides a
  +consistent look and feel for all of the Jakarta sites pages. As you
  +browse various projects, you may notice slight variations in the look of
  +the site. This is because other projects have chosen to use different
  +technologies for transforming their XML files and have not kept up with
  +the general look and feel of the main Jakarta Site. This is perfectly ok
  +with us as we allow our developers the freedom to innovate.
  +</p>
   
  +<p>
  +The jakarta-site2 module uses Anakia to do the XML->HTML
  +transformations. Therefore, it is highly recommended that you read the
  +Anakia <a href="/velocity/anakia.html">documentation</a> in order to get
  +an overview of what you are dealing with (it really is quite simple as
  +you will soon discover).
  +</p>
  +  </section>
  +  
     <section name="Using the jakarta-site2 module as a dependency">
   <p>
   If you would like to use the jakarta-site2 module as a dependency for
  @@ -18,13 +51,6 @@
   the recommended, but optional way to develop documentation for projects
   hosted under the main Jakarta Project.
   </p>
  -<p>
  -Currently, the jakarta-site2 module uses Anakia to do the XML->HTML
  -transformations. Therefore, it is highly recommended that you read the
  -Anakia <a href="/velocity/anakia.html">documentation</a> in order to get
  -an overview of what you are dealing with (it really is quite simple as
  -you will soon discover).
  -</p>
     </section>
   
     <section name="Doing it your way">
  @@ -231,7 +257,7 @@
   .jar files for Anakia. Because it adds itself to the CLASSPATH after you
   do, any .jar files in your project that duplicate the .jar files needed
   by Anakia will take precedence. So, if there are issues with running
  -Anakia with a combined classpath, you can opt to make a seperate build
  +Anakia with a combined classpath, you can opt to make a separate build
   script for running Anakia with its own CLASSPATH.
   </p>
   
  @@ -290,7 +316,7 @@
       xdocs/stylesheets directory, you will notice that it is the side
       navigation portion of the website. If you want your project logo to
       appear in the upper right corner next to the Jakarta Project logo,
  -    then uncomment the &lt;logo&gt; tag and specify the path to the logo
  +    then un-comment the &lt;logo&gt; tag and specify the path to the logo
       in your images directory or a full URI to your logo. If your project
       has its own navigation needs, simply modify the &lt;menu&gt; tags
       and place in your own navigation elements.
  
  
  
  1.28      +44 -9     jakarta-site2/docs/site/jakarta-site2.html
  
  Index: jakarta-site2.html
  ===================================================================
  RCS file: /home/cvs/jakarta-site2/docs/site/jakarta-site2.html,v
  retrieving revision 1.27
  retrieving revision 1.28
  diff -u -r1.27 -r1.28
  --- jakarta-site2.html	2001/07/10 02:06:53	1.27
  +++ jakarta-site2.html	2001/07/10 15:52:17	1.28
  @@ -126,6 +126,48 @@
                                                                       <table border="0"
cellspacing="0" cellpadding="2" width="100%">
         <tr><td bgcolor="#525D76">
           <font color="#ffffff" face="arial,helvetica,sanserif">
  +          <a name="What is this?"><strong>What is this?</strong></a>
  +        </font>
  +      </td></tr>
  +      <tr><td>
  +        <blockquote>
  +                                    <p>
  +The Jakarta-Site2 module is where we store the code for building our
  +static HTML website. We use XML files as our input and transform them
  +into static HTML files (which is what you are reading now). The reason
  +why we use static HTML is because the apache.org server gets a huge
  +number of "hits" each day. Having a dynamic site would increase the load
  +on the server to an even more unacceptable level because apache.org is
  +a limited shared resource by hundreds of people. Using XML as our input
  +allows us to change the look and feel of the entire site in a matter of
  +seconds.
  +</p>
  +                                                <p>
  +Each Jakarta project has the choice of how they generate their website
  +and documentation. The "encouraged" way is to use the Jakarta-Site2
  +module as the basis for generating the documentation. The provides a
  +consistent look and feel for all of the Jakarta sites pages. As you
  +browse various projects, you may notice slight variations in the look of
  +the site. This is because other projects have chosen to use different
  +technologies for transforming their XML files and have not kept up with
  +the general look and feel of the main Jakarta Site. This is perfectly ok
  +with us as we allow our developers the freedom to innovate.
  +</p>
  +                                                <p>
  +The jakarta-site2 module uses Anakia to do the XML-&gt;HTML
  +transformations. Therefore, it is highly recommended that you read the
  +Anakia <a href="/velocity/anakia.html">documentation</a> in order to get
  +an overview of what you are dealing with (it really is quite simple as
  +you will soon discover).
  +</p>
  +                            </blockquote>
  +        </p>
  +      </td></tr>
  +      <tr><td><br/></td></tr>
  +    </table>
  +                                                <table border="0" cellspacing="0" cellpadding="2"
width="100%">
  +      <tr><td bgcolor="#525D76">
  +        <font color="#ffffff" face="arial,helvetica,sanserif">
             <a name="Using the jakarta-site2 module as a dependency"><strong>Using
the jakarta-site2 module as a dependency</strong></a>
           </font>
         </td></tr>
  @@ -140,13 +182,6 @@
   the recommended, but optional way to develop documentation for projects
   hosted under the main Jakarta Project.
   </p>
  -                                                <p>
  -Currently, the jakarta-site2 module uses Anakia to do the XML-&gt;HTML
  -transformations. Therefore, it is highly recommended that you read the
  -Anakia <a href="/velocity/anakia.html">documentation</a> in order to get
  -an overview of what you are dealing with (it really is quite simple as
  -you will soon discover).
  -</p>
                               </blockquote>
           </p>
         </td></tr>
  @@ -462,7 +497,7 @@
   .jar files for Anakia. Because it adds itself to the CLASSPATH after you
   do, any .jar files in your project that duplicate the .jar files needed
   by Anakia will take precedence. So, if there are issues with running
  -Anakia with a combined classpath, you can opt to make a seperate build
  +Anakia with a combined classpath, you can opt to make a separate build
   script for running Anakia with its own CLASSPATH.
   </p>
                                                       <div align="left">
  @@ -562,7 +597,7 @@
       xdocs/stylesheets directory, you will notice that it is the side
       navigation portion of the website. If you want your project logo to
       appear in the upper right corner next to the Jakarta Project logo,
  -    then uncomment the &lt;logo&gt; tag and specify the path to the logo
  +    then un-comment the &lt;logo&gt; tag and specify the path to the logo
       in your images directory or a full URI to your logo. If your project
       has its own navigation needs, simply modify the &lt;menu&gt; tags
       and place in your own navigation elements.
  
  
  

Mime
View raw message