1 FIXME: This is outdated.
3 This web application is licensed under the Gnu Public License, which
4 should be included in the same directory as this README. A copy
5 can be found at http://www.gnu.org/copyleft/gpl.txt.
7 See INSTALL for installation notes.
8 See INSTALL.mysql for using PhpWiki with MySQL.
9 See INSTALL.pgsql for using PhpWiki with PostgreSQL
10 See INSTALL.mSQL for using PhpWiki with mSQL.
12 For a list of current bugs see:
13 https://sourceforge.net/bugs/?group_id=6121
15 The out-of-the-box version uses a dbm file in the /tmp directory; you may
16 wish a more permanent place for yours, but make sure it's read/writable
19 NOTE: Not all database versions are equal. The MySQL and Postgresql
20 implementations have the full set of features; DBM and mSQL are
21 missing only a few, and the flat file implementation is solid
22 and waiting for your improvement. All are suitable for production.
26 index.php: just the user-defined configs, calls lib/main.php
28 lib/config.php: not user-definable config functions.
29 lib/db_filesystem.php support for flat file Wiki
30 lib/dbalib.php: database access functions for the dba interface
31 lib/dbmlib.php: database access functions for dbm files
32 lib/diff.php: request colored diff's
33 lib/display.php: display a page (this calls "lib/transform.php")
34 lib/editpage.php: edit a page
35 lib/fullsearch.php: full page text search
36 lib/interwiki.map: list of other wiki's linked by trailing :
37 lib/interwiki.php: do the interwiki linking
38 lib/loadsave.php: make snapshots or backups
39 (previously setupwiki.php and dump-/loadserial.php)
40 lib/main.php: the main loop which was previously in index.php
41 lib/mysql.php: database access functions for mySQL
42 lib/pageinfo.php: gives detailed low-level info on the page structure
43 lib/pgsql.php: database access functions for PostgreSQL
44 lib/prepend.php: things which must be done before all else
45 lib/savepage.php: save a page to db, thank user
46 lib/search.php: page title search
47 lib/stdlib.php: standard library of functions (non-db related)
48 lib/transform.php: convert wiki markup into HTML
49 lib/userauth.php: the WikiUser class holding saved state in cookies.
50 lib/ziplib.php: support for zip/unzip, used for page dumps
53 admin/dumpserial.php: replaced by lib/loadsave.php
54 admin/loadserial.php: replaced by lib/loadsave.php
55 admin/lockpage.php: lock a page so it cannot be edited
56 admin/shrinkdbm.pl: Perl script to reduce size of DBM files
57 admin/wiki_dumpHTML.php: dump the Wiki out as HTML pages
58 admin/wiki_port1_0.php: import a 1.0 PhpWiki database
59 admin/wiki_rebuilddbms.php: rebuild DBM files to reclaim disk space
62 browse.html: for rendering most pages
63 editlinks.html: template for editing references
64 editpage.html: template for form for editing pages
65 message.html: error/system message template
67 schemas/: SQL schemas for the RDBMSs
72 http://wcsb.org/~swain/
74 $Id: README,v 1.12 2001-09-18 19:16:23 dairiki Exp $