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