You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2004/01/04 20:20:40 UTC
cvs commit: httpd-site/xdocs/docs-project docsformat.xml
nd 2004/01/04 11:20:40
Modified: docs/docs-project docsformat.html
xdocs/docs-project docsformat.xml
Log:
update docsformat page
Revision Changes Path
1.21 +15 -10 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.20
retrieving revision 1.21
diff -u -u -r1.20 -r1.21
--- docsformat.html 1 Jan 2004 13:47:21 -0000 1.20
+++ docsformat.html 4 Jan 2004 19:20:40 -0000 1.21
@@ -125,13 +125,19 @@
./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>
+cygwin is installed. Alternatively, on Win32, you should be
+able to run the <code>build.bat</code> script.</p>
+<p>If you don't want to get the files from CVS, you can download a snapshot of
+the build tools from our <a href="http://www.apache.org/dyn/closer.cgi/httpd/docs/tools-2004-01-04.zip">distribution
+directory</a>.</p>
<p>The default target builds only the english-language docs. To
build other docs, you should specify the language-code (ja, de, etc)
as an argument. To find the available languages, please see our
<a href="translations.html">translations page</a>.</p>
+<p>You can get an overview of all possible build targets by typing:</p>
+<blockquote><code>
+./build.sh -projecthelp
+</code></blockquote>
</blockquote>
</td></tr>
</table>
@@ -143,13 +149,12 @@
</td></tr>
<tr><td>
<blockquote>
-<p>When adding a new module, the name of the xml file must be added to
-<code>mod/allmodules.xml</code>. In this way, the new module will
-be included in the automatic index generation procedures. Also,
-you need to create <code>newfilename.xml.meta</code> file.
-The best way to make sure these things are done is
-running the metafiles target.
-</p>
+<p>When adding a new module, the transformation process tries to generate an
+appropriate entry within <code>mod/allmodules.xml</code> and to create an
+accompanying metafile (<code>newfilename.xml.meta</code>). Since these
+tasks are written in perl, you'll need a working perl installation for this.
+If not, you should take these steps manually or just drop a note onto
+the project mailing list that someone else can do it.</p>
</blockquote>
</td></tr>
</table>
1.9 +18 -10 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.8
retrieving revision 1.9
diff -u -u -r1.8 -r1.9
--- docsformat.xml 3 Dec 2003 05:16:43 -0000 1.8
+++ docsformat.xml 4 Jan 2004 19:20:40 -0000 1.9
@@ -68,27 +68,35 @@
</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>
+cygwin is installed. Alternatively, on Win32, you should be
+able to run the <code>build.bat</code> script.</p>
+
+<p>If you don't want to get the files from CVS, you can download a snapshot of
+the build tools from our <a
+href="http://www.apache.org/dyn/closer.cgi/httpd/docs/tools-2004-01-04.zip">distribution
+directory</a>.</p>
<p>The default target builds only the english-language docs. To
build other docs, you should specify the language-code (ja, de, etc)
as an argument. To find the available languages, please see our
<a href="translations.html">translations page</a>.</p>
+<p>You can get an overview of all possible build targets by typing:</p>
+
+<blockquote><code>
+./build.sh -projecthelp
+</code></blockquote>
</section>
<section><title>Special Files</title>
-<p>When adding a new module, the name of the xml file must be added to
-<code>mod/allmodules.xml</code>. In this way, the new module will
-be included in the automatic index generation procedures. Also,
-you need to create <code>newfilename.xml.meta</code> file.
-The best way to make sure these things are done is
-running the metafiles target.
-</p>
+<p>When adding a new module, the transformation process tries to generate an
+appropriate entry within <code>mod/allmodules.xml</code> and to create an
+accompanying metafile (<code>newfilename.xml.meta</code>). Since these
+tasks are written in perl, you'll need a working perl installation for this.
+If not, you should take these steps manually or just drop a note onto
+the project mailing list that someone else can do it.</p>
</section>