goba Sun Jan 11 09:23:04 2004 EDT
Added files:
/livedocs BUGS
Modified files:
/livedocs README livedoc.php
Log:
add BUGS file, remove reference to the brainroom ticketing system, add libxml2 and
CLI PHP requirement docs and properly number INSTALL steps
Index: livedocs/README
diff -u livedocs/README:1.8 livedocs/README:1.9
--- livedocs/README:1.8 Sun Jan 11 09:04:23 2004
+++ livedocs/README Sun Jan 11 09:23:03 2004
@@ -1,4 +1,4 @@
-$Id: README,v 1.8 2004/01/11 14:04:23 goba Exp $
+$Id: README,v 1.9 2004/01/11 14:23:03 goba Exp $
vim:et:tw=78
INTRODUCTION
@@ -26,11 +26,20 @@
INSTALL
-------
-1. Update your phpdoc checkout:
+1. Make sure that you have xsltproc and xmllint installed. These are
+ part of libxml2. You should have them if you work with gnome, or
+ on Windows if you have installed a complete cygwin. These two XML
+ tools are only needed by the livedocs build and not for everyday
+ operation.
+
+ Livedocs also needs a CLI version of PHP installed on your machine,
+ additionaly to your webserver supporting PHP.
+
+2. Update your phpdoc checkout:
cvs -d :pserver:[EMAIL PROTECTED]:/repository checkout phpdoc
-2. Ensure that your php has sqlite support
+3. Ensure that your PHP has sqlite support
pear install sqlite
@@ -39,7 +48,7 @@
Load in the SQLite extension by default in php.ini, since the
scripts will not try to dynamically load it.
-3. Configure livedocs!
+4. Configure livedocs!
cd livedocs
autoconf
@@ -56,7 +65,7 @@
if the default is not suitable. Also ensure that no regexp special chars
exist in the 'web-base' string.
-2. Run the livedoc indexer:
+5. Run the livedoc indexer:
./build.sh
@@ -64,7 +73,7 @@
It will also configure phpdoc (autoconf & ./configure).
-3. Call up a node in your browser
+6. Call up a node in your browser
http://localhost/livedocs/index.php?q=function.fopen
Index: livedocs/livedoc.php
diff -u livedocs/livedoc.php:1.70 livedocs/livedoc.php:1.71
--- livedocs/livedoc.php:1.70 Sun Jan 11 04:48:15 2004
+++ livedocs/livedoc.php Sun Jan 11 09:23:03 2004
@@ -1,4 +1,4 @@
-<?php # $Id: livedoc.php,v 1.70 2004/01/11 09:48:15 nlopess Exp $
+<?php # $Id: livedoc.php,v 1.71 2004/01/11 14:23:03 goba Exp $
/* Generate an HTML version of a phpdoc/docbook page on the fly */
include './common.php';
@@ -64,8 +64,7 @@
}
echo <<<FUNC_FOOT
</p>
-<div class='footer'>$filename $file_revision | generated: $date<br />
-<a target="tickets" href="http://projects.thebrainroom.net:8008/oss/tktnew">Problems
with the formatting of this page?</a></div>
+<div class='footer'>$filename $file_revision | generated: $date</div>
</td></tr>
<tr><td valign="top">
$nav
@@ -580,8 +579,7 @@
}
echo <<<FOOT
<br />
-<div class='footer'>$filename $file_revision | generated: $date<br />
-<a target="tickets" href="http://projects.thebrainroom.net:8008/oss/tktnew">Problems
with the formatting of this page?</a></div>
+<div class='footer'>$filename $file_revision | generated: $date</div>
</td></tr>
<tr><td valign="top">
$nav