README

   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.
   4
   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.
   9
  10 For a list of current bugs see:
  11 https://sourceforge.net/bugs/?group_id=6121
  12
  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
  15 by your web server!
  16
  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.
  21
  22 MANIFEST:
  23
  24 index.php:             just the user-defined configs, calls lib/main.php
  25
  26 lib/config.php:        not user-definable config functions.
  27 lib/db_filesystem.php  support for flat file Wiki
  28 lib/dbalib.php:        database access functions for the dba interface
  29 lib/dbmlib.php:        database access functions for dbm files
  30 lib/diff.php:          request colored diff's
  31 lib/display.php:       display a page (this calls "lib/transform.php")
  32 lib/editpage.php:      edit a page
  33 lib/fullsearch.php:    full page text search
  34 lib/interwiki.map:     list of other wiki's linked by trailing :
  35 lib/interwiki.php:     do the interwiki linking
  36 lib/loadsave.php:      make snapshots or backups
  37                        (previously setupwiki.php and dump-/loadserial.php)
  38 lib/main.php:          the main loop which was previously in index.php
  39 lib/mysql.php:         database access functions for mySQL
  40 lib/pageinfo.php:      gives detailed low-level info on the page structure
  41 lib/pgsql.php:         database access functions for PostgreSQL
  42 lib/prepend.php:       things which must be done before all else
  43 lib/savepage.php:      save a page to db, thank user
  44 lib/search.php:        page title search
  45 lib/stdlib.php:        standard library of functions (non-db related)
  46 lib/transform.php:     convert wiki markup into HTML
  47 lib/userauth.php:      the WikiUser class holding saved state in cookies.
  48 lib/ziplib.php:        support for zip/unzip, used for page dumps
  49
  50 admin/:
  51 admin/dumpserial.php:        replaced by lib/loadsave.php
  52 admin/loadserial.php:        replaced by lib/loadsave.php
  53 admin/lockpage.php:          lock a page so it cannot be edited
  54 admin/shrinkdbm.pl:          Perl script to reduce size of DBM files
  55 admin/wiki_dumpHTML.php:     dump the Wiki out as HTML pages
  56 admin/wiki_port1_0.php:      import a 1.0 PhpWiki database
  57 admin/wiki_rebuilddbms.php:  rebuild DBM files to reclaim disk space
  58
  59 templates/:
  60 browse.html:           for rendering most pages
  61 editlinks.html:        template for editing references
  62 editpage.html:         template for form for editing pages
  63 message.html:          error/system message template
  64
  65 schemas/:              SQL schemas for the RDBMSs
  66
  67
  68 Steve Wainstead
  69 swain@wcsb.org
  70 http://wcsb.org/~swain/
  71
  72 $Id: README,v 1.10 2001-02-14 05:22:49 dairiki Exp $