1 FIXME: This is outdated.
3 PhpWiki is a web application 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 Read UPGRADE before upgrading from a previous version of PhpWiki.
11 INSTALL.mysql for using PhpWiki with MySQL
12 INSTALL.pgsql for using PhpWiki with PostgreSQL
13 INSTALL.flatfile for using PhpWiki with flatfile databases
14 INSTALL.mSQL for using PhpWiki with mSQL
15 INSTALL.MacOSX for using PhpWiki in MacOSX
16 README.coding for notes on modifying PhpWiki
21 For a list of current bugs see:
22 https://sourceforge.net/bugs/?group_id=6121
24 The out-of-the-box version uses a dbm file in the /tmp directory; you may
25 wish a more permanent place for yours, but make sure it's read/writable
28 NOTE: Not all database versions are equal. The MySQL and Postgresql
29 implementations have the full set of features; DBM and mSQL are
30 missing only a few, and the flat file implementation is solid
31 and waiting for your improvement. All are suitable for production.
35 * FIXME: files moved or replaced
37 index.php: just the user-defined configs, calls lib/main.php
40 lib/ArchiveCleaner.php
42 lib/config.php: not user-definable config functions.
44 *lib/dbalib.php: database access functions for the dba interface
47 *lib/db_filesystem.php support for flat file Wiki
48 *lib/dbmlib.php: database access functions for dbm files
49 lib/diff.php: request colored diff's
52 lib/display.php: display a page (this calls "lib/transform.php")
53 lib/editpage.php: edit a page
56 *lib/fullsearch.php: full page text search
57 lib/interwiki.map: list of other wiki's linked by trailing :
58 lib/interwiki.php: do the interwiki linking
59 lib/loadsave.php: make snapshots or backups
60 (previously setupwiki.php and dump-/loadserial.php)
61 lib/main.php: the main loop which was previously in index.php
62 *lib/mysql.php: database access functions for mySQL
63 *lib/pageinfo.php: gives detailed low-level info on the page structure
64 *lib/pgsql.php: database access functions for PostgreSQL
65 lib/prepend.php: things which must be done before all else
69 lib/savepage.php: save a page to db, thank user
70 *lib/search.php: page title search
71 lib/stdlib.php: standard library of functions (non-db related)
73 lib/TextSearchQuery.php
74 lib/transform.php: convert wiki markup into HTML
75 *lib/userauth.php: the WikiUser class holding saved state in cookies.
80 lib/ziplib.php: support for zip/unzip, used for page dumps
83 plugin/_BackendInfo.php
86 plugin/FullTextSearch.php
88 plugin/IncludePage.php
90 plugin/MostPopular.php
91 plugin/PageHistory.php
92 plugin/RecentChanges.php
94 plugin/TitleSearch.php
101 *admin/: directory completely replaced by other files
103 *admin/dumpserial.php: replaced by lib/loadsave.php
104 *admin/loadserial.php: replaced by lib/loadsave.php
105 *admin/lockpage.php: lock a page so it cannot be edited
106 *admin/shrinkdbm.pl: Perl script to reduce size of DBM files
107 *admin/wiki_dumpHTML.php: dump the Wiki out as HTML pages
108 *admin/wiki_port1_0.php: import a 1.0 PhpWiki database
109 *admin/wiki_rebuilddbms.php: rebuild DBM files to reclaim disk space
112 browse.html: for rendering most pages
113 editpage.html: template for form for editing pages
114 message.html: error/system message template
116 schemas/: SQL schemas for the RDBMSs
124 http://wcsb.org/~swain/
126 $Id: README,v 1.13 2002-01-17 04:35:06 carstenklapp Exp $