httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sl...@apache.org
Subject cvs commit: httpd-site/docs/docs-project docsformat.html
Date Thu, 01 Aug 2002 19:54:33 GMT
slive       2002/08/01 12:54:33

  Modified:    xdocs/docs-project docsformat.xml
               docs/docs-project docsformat.html
  Log:
  Info on new build system.
  
  Revision  Changes    Path
  1.6       +30 -24    httpd-site/xdocs/docs-project/docsformat.xml
  
  Index: docsformat.xml
  ===================================================================
  RCS file: /home/cvs/httpd-site/xdocs/docs-project/docsformat.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -d -b -u -r1.5 -r1.6
  --- docsformat.xml	23 May 2002 15:33:51 -0000	1.5
  +++ docsformat.xml	1 Aug 2002 19:54:33 -0000	1.6
  @@ -7,19 +7,24 @@
   <section>
   <title>Module Format and Transformation</title>
   
  -<p>This document describes the format of the Apache HTTP Server module
  +<p>This document describes the format of the Apache HTTP Server
   documentation xml source files and the technique used to transform
   them to html.</p>
   
   </section>
   <section><title>Format</title>
   
  -<p>A DTD is located at <a
  -href="http://httpd.apache.org/docs-2.0/style/modulesynopsis.dtd">docs/manual/style/modulesynopsis.dtd</a>.
  -An example of the format with extensive comments is also available in
  -<a href="mod_template.txt">mod_template.txt</a>.  Obviously, the file
  -extension should be <code>xml</code>.  It was changed to make online
  -viewing simpler.</p>
  +<p>A DTD is located in the <a
  +href="http://httpd.apache.org/docs-2.0/style/">style directory</a> of
  +the manual.  An example of the format with extensive comments
  +is also available in <a href="mod_template.txt">mod_template.txt</a>.
  +Obviously, the file extension should be <code>xml</code>.  It was
  +changed to make online viewing simpler.</p>
  +
  +<p>We are currently in the process of converting the remainder of the
  +httpd-2.0 documentation into xml.  The format used is a subset
  +of the format used for the module documentation, with the exception
  +of an added &lt;related&gt; section.</p>
   
   <p>To assure that your documentation follows the defined format, you
   should parse it using the DTD.  Some help using Emacs with XML files
  @@ -47,23 +52,24 @@
   transformation system based on Xalan+Xerces Java and Ant.  These are
   all Apache projects distributed under the Apache license.</p>
   
  -<p>Assuming that you already have <code>httpd-2.0/docs/manual</code>
  -checked out from CVS, the requirements to do the transformation are a
  -Java 1.2 JVM (which you can obtain free from Sun), and the jars for
  -the <a href="http://xml.apache.org/xalan-j/getstarted.html">Xalan
  -distribution</a>.  If you just want to transform one document at a
  -time, you can simple follow the directions on the Xalan webpage.</p>
  +<p>The only requirement to do the transformation is a Java 1.2 or
  +greater JVM (which can be obtained free from Sun).  Assuming you
  +already have <code>httpd-2.0/docs/manual</code> checked out from CVS,
  +here is what you need to do to build: (If you need instructions on
  +setting up anonymous CVS, see <a
  +href="http://www.apache.org/foundation/cvs.html">this page</a>.)</p>
   
  -<p>To update all documents, you should use the JARs located <a
  -href="http://httpd.apache.org/dev/dist/httpd-docs-lib.tar.gz">here</a>.
  -We are using a specially modified version of Ant to allow for our
  -language-specific filename extensions.  Extract this from the
  -<code>httpd-2.0/docs/manual/style/</code> directory and it will create
  -a <code>lib</code> directory with the appropriate jar files.  Then run
  -<code>build.sh</code> to perform the transformation.  If you are
  -running under win32, build.sh will work if cygwin is installed, or you
  -can setup your environment and run java by hand.
  -</p>
  +<blockquote><code>
  +cd httpd-2.0/docs/manual<br />
  +cvs co -d build site-tools/httpd-docs-build/<br />
  +cd build<br />
  +./build.sh
  +</code></blockquote>
  +
  +<p>If you are running under win32, the build.sh script will work if
  +cygwin is installed.  Alternatively, on WinNT or above, you should be
  +able to run the <code>build.cmd</code> script, but this hasn't yet
  +been well tested.</p>
   
   </section>
   
  
  
  
  1.10      +25 -21    httpd-site/docs/docs-project/docsformat.html
  
  Index: docsformat.html
  ===================================================================
  RCS file: /home/cvs/httpd-site/docs/docs-project/docsformat.html,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -d -b -u -r1.9 -r1.10
  --- docsformat.html	8 Jul 2002 18:57:35 -0000	1.9
  +++ docsformat.html	1 Aug 2002 19:54:33 -0000	1.10
  @@ -59,7 +59,7 @@
    </td></tr>
    <tr><td>
     <blockquote>
  -<p>This document describes the format of the Apache HTTP Server module
  +<p>This document describes the format of the Apache HTTP Server
   documentation xml source files and the technique used to transform
   them to html.</p>
     </blockquote>
  @@ -73,11 +73,15 @@
    </td></tr>
    <tr><td>
     <blockquote>
  -<p>A DTD is located at <a href="http://httpd.apache.org/docs-2.0/style/modulesynopsis.dtd">docs/manual/style/modulesynopsis.dtd</a>.
  -An example of the format with extensive comments is also available in
  -<a href="mod_template.txt">mod_template.txt</a>.  Obviously, the file
  -extension should be <code>xml</code>.  It was changed to make online
  -viewing simpler.</p>
  +<p>A DTD is located in the <a href="http://httpd.apache.org/docs-2.0/style/">style
directory</a> of
  +the manual.  An example of the format with extensive comments
  +is also available in <a href="mod_template.txt">mod_template.txt</a>.
  +Obviously, the file extension should be <code>xml</code>.  It was
  +changed to make online viewing simpler.</p>
  +<p>We are currently in the process of converting the remainder of the
  +httpd-2.0 documentation into xml.  The format used is a subset
  +of the format used for the module documentation, with the exception
  +of an added &lt;related&gt; section.</p>
   <p>To assure that your documentation follows the defined format, you
   should parse it using the DTD.  Some help using Emacs with XML files
   is available from <a href="http://www-106.ibm.com/developerworks/xml/library/x-emacs/">IBM
  @@ -107,21 +111,21 @@
   the transformed files.  Therefore, we have chosen a single recommended
   transformation system based on Xalan+Xerces Java and Ant.  These are
   all Apache projects distributed under the Apache license.</p>
  -<p>Assuming that you already have <code>httpd-2.0/docs/manual</code>
  -checked out from CVS, the requirements to do the transformation are a
  -Java 1.2 JVM (which you can obtain free from Sun), and the jars for
  -the <a href="http://xml.apache.org/xalan-j/getstarted.html">Xalan
  -distribution</a>.  If you just want to transform one document at a
  -time, you can simple follow the directions on the Xalan webpage.</p>
  -<p>To update all documents, you should use the JARs located <a href="http://httpd.apache.org/dev/dist/httpd-docs-lib.tar.gz">here</a>.
  -We are using a specially modified version of Ant to allow for our
  -language-specific filename extensions.  Extract this from the
  -<code>httpd-2.0/docs/manual/style/</code> directory and it will create
  -a <code>lib</code> directory with the appropriate jar files.  Then run
  -<code>build.sh</code> to perform the transformation.  If you are
  -running under win32, build.sh will work if cygwin is installed, or you
  -can setup your environment and run java by hand.
  -</p>
  +<p>The only requirement to do the transformation is a Java 1.2 or
  +greater JVM (which can be obtained free from Sun).  Assuming you
  +already have <code>httpd-2.0/docs/manual</code> checked out from CVS,
  +here is what you need to do to build: (If you need instructions on
  +setting up anonymous CVS, see <a href="http://www.apache.org/foundation/cvs.html">this
page</a>.)</p>
  +<blockquote><code>
  +cd httpd-2.0/docs/manual<br />
  +cvs co -d build site-tools/httpd-docs-build/<br />
  +cd build<br />
  +./build.sh
  +</code></blockquote>
  +<p>If you are running under win32, the build.sh script will work if
  +cygwin is installed.  Alternatively, on WinNT or above, you should be
  +able to run the <code>build.cmd</code> script, but this hasn't yet
  +been well tested.</p>
     </blockquote>
    </td></tr>
   </table>
  
  
  

Mime
View raw message