2 This web application is licensed under the Gnu Public License, which
3 should be included in the same directory as this README. A copy
4 can be found at http://www.gnu.org/copyleft/gpl.txt.
6 See INSTALL for installation notes.
7 See INSTALL.mysql for using PhpWiki with MySQL.
8 See INSTALL.pgsql for using PhpWiki with PostgreSQL
9 See INSTALL.mSQL for using PhpWiki with mSQL.
11 The out-of-the-box version uses a dbm file in the /tmp directory; you may
12 wish a more permanent place for yours, but make sure it's read/writable
15 NOTE: Not all database versions are equal. The MySQL and Postgresql
16 implementations have the full set of features; DBM and mSQL are
17 missing only a few, and the flat file implementation is alpha quality
18 and waiting for your improvement. However all but the flat file
19 version are suitable for production.
21 index.php: the "main page", really a set of branching instructions
22 admin.php: entry page for doing wiki administration
24 lib/config.php: configuration options, constants, global variables
25 lib/db_filesystem.php alpha support for flat file Wiki
26 lib/dbmlib.php: database access functions for dbm files
27 lib/display.php: display a page (this calls "lib/transform.php")
28 lib/editlinks.php: edit the embedded links of a page
29 lib/editpage.php: edit a page
30 lib/fullsearch.php: full page text search
31 lib/mysql.php: database access functions for mySQL
32 lib/pageinfo.php: gives detailed low-level info on the page structure
33 lib/pgsql.php: database access functions for PostgreSQL
34 lib/savepage.php: save a page to db, thank user
35 lib/search.php: page title search
36 lib/setupwiki.php: load a set of pages from ./pgsrc/ directory
37 lib/stdlib.php: standard library of functions (non-db related)
38 lib/transform.php: convert wiki markup into HTML
39 lib/ziplib.php: support for zip/unzip, used for page dumps
42 admin/dumpserial.php: dump the Wiki out as serialize() pages
43 admin/loadserial.php: load Wiki pages that were dumped with dumpserial
44 admin/lockpage.php: lock a page so it cannot be edited
45 admin/shrinkdbm.pl: Perl script to reduce size of DBM files
46 admin/wiki_dumpHTML.php: dump the Wiki out as HTML pages
47 admin/wiki_port1_0.php: import a 1.0 PhpWiki database
48 admin/wiki_rebuilddbms.php: rebuild DBM files to reclaim disk space
49 admin/zip.php3: create a Zip archive of all Wiki pages
52 browse.html: for rendering most pages
53 editlinks.html: template for editing references
54 editpage.html: template for form for editing pages
55 message.html: error/system message template
57 schemas/: SQL schemas for the RDBMSs
62 http://wcsb.org/~swain/
64 $Id: README,v 1.8 2000-12-12 21:24:50 wainstead Exp $