goba Sun Feb 26 12:21:29 2006 UTC
Modified files:
/livedocs README
Log:
README update
- point out some of the advantages of livedocs over the current phpdoc
approach
- point to phpdoc.info wiki
- add credits based on cvs commit logs (I might have missed some peoplethey
are available from the PHP Museum (http://museum.php.net/patches/)
http://cvs.php.net/viewcvs.cgi/livedocs/README?r1=1.16&r2=1.17&diff_format=u
Index: livedocs/README
diff -u livedocs/README:1.16 livedocs/README:1.17
--- livedocs/README:1.16 Fri Sep 9 02:17:14 2005
+++ livedocs/README Sun Feb 26 12:21:29 2006
@@ -1,32 +1,47 @@
-README
-======
-$Id: README,v 1.16 2005/09/09 02:17:14 wez Exp $
+Livedocs README
+==============================================================================
+$Id: README,v 1.17 2006/02/26 12:21:29 goba Exp $
vim:et:tw=78
INTRODUCTION
-------------
+------------------------------------------------------------------------------
-Livedocs is a tool to display DocBook XML files on the fly,
-instead of building all the HTML files first. There is a little
-preprocessing work needed, but otherwise the script collection
-works instantly even on modified XML files. This tool is primarily
-aimed at solving the PHP documentation efforts problems, but it is
-meant to be general enough to handle all the various documentation
-styles and methods we have.
+Livedocs is a tool to display DocBook XML files in a web browser on the fly,
+without the need of building all HTML target files first. It was started as
+a project to simplify the task of PHP Manual contributors, to check their
+changes as they will show up in the documentation. To use Livedocs, a little
+preprocessing work is needed, but after that, the script collection even works
+on modified XML files.
+
+The main advantage of Livedocs for the PHP Manual is the dramatically reduced
+time-to-live interval, since modified XML files can be pushed to servers
+without the need of building all the HTML files even for small changes.
+Additionaly to this, Livedocs also does a good job of providing search
+results for keywords found in the manual, as well as keeping track of
+relations of translated files to their English equivalents, notifying
+readers, if they read a seriously outdated translation.
+
+You can find live test versions as weel as prebuilt Livedocs packages
+for testing and reporting bugs at http://wiki.phpdoc.info/LiveDocs
LICENSE
--------
+------------------------------------------------------------------------------
Livedocs is available under the PHP License 3.0. More information
about the license is available at http://www.php.net/license/
CREDITS
--------
+------------------------------------------------------------------------------
- Wez Furlong, Derick Rethans, Ilia Alshanetsky
+Wez Furlong, Derick Rethans, Ilia Alshanetsky,
+Nuno Lopes, Mehdi Achour, Gabor Hojtsy, Edin Kadribasic
INSTALL
--------
+------------------------------------------------------------------------------
+
+! If you are happy with the prebuilt version of Livedocs, it is a lot simpler
+! to install (and does not need libxml2 or CVS, just a PHP setup with sqlite
included),
+! see the link above for more information.
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
@@ -34,8 +49,8 @@
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.
+ The Livedocs build process also needs a CLI version of PHP installed
+ on your machine, additionaly to your webserver supporting PHP.
You need to enable bz2 extension if you want to incorporate user notes.
@@ -43,16 +58,11 @@
cvs -d :pserver:[EMAIL PROTECTED]:/repository checkout phpdoc
-3. Ensure that your PHP has sqlite support
-
- pear install sqlite
-
- (win32: http://snaps.php.net/win32/PECL_STABLE/php_sqlite.dll)
-
- Load in the SQLite extension by default in php.ini, since the
- scripts will not try to dynamically load it.
+3. Ensure that your PHP has sqlite support. PHP 5.0.x has it bundled
+ and compiled in by default. However from PHP 5.1.x, you need to
+ enable it along with PDO. See http://php.net/sqlite for instructions.
-4. Configure livedocs!
+4. Configure Livedocs!
cd livedocs
autoconf
@@ -97,4 +107,4 @@
http://localhost/livedocs/index.php?q=function.fopen
-Done :)
+Enjoy.
