README

   1
   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.
   5
   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.
  10
  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
  13 by your web server!
  14
  15 index.php:             the "main page", really a set of branching instructions
  16 admin.php:             entry page for doing wiki administration
  17
  18 lib/config.php:        configuration options, constants, global variables
  19 lib/db_filesystem.php  alpha support for flat file Wiki
  20 lib/dbmlib.php:        database access functions for dbm files
  21 lib/display.php:       display a page (this calls "lib/transform.php")
  22 lib/editlinks.php:     edit the embedded links of a page
  23 lib/editpage.php:      edit a page
  24 lib/fullsearch.php:    full page text search
  25 lib/mysql.php:         database access functions for mySQL
  26 lib/pageinfo.php:      gives detailed low-level info on the page structure
  27 lib/pgsql.php:         database access functions for PostgreSQL
  28 lib/savepage.php:      save a page to db, thank user
  29 lib/search.php:        page title search
  30 lib/setupwiki.php:     load a set of pages from ./pgsrc/ directory
  31 lib/stdlib.php:        standard library of functions (non-db related)
  32 lib/transform.php:     convert wiki markup into HTML
  33 lib/ziplib.php:        support for zip/unzip, used for page dumps
  34
  35 admin/:
  36 admin/dumpserial.php:        dump the Wiki out as serialize() pages
  37 admin/loadserial.php:        load Wiki pages that were dumped with dumpserial
  38 admin/lockpage.php:          lock a page so it cannot be edited
  39 admin/shrinkdbm.pl:          Perl script to reduce size of DBM files
  40 admin/wiki_dumpHTML.php:     dump the Wiki out as HTML pages
  41 admin/wiki_port1_0.php:      import a 1.0 PhpWiki database
  42 admin/wiki_rebuilddbms.php:  rebuild DBM files to reclaim disk space
  43 admin/zip.php3:              create a Zip archive of all Wiki pages
  44
  45 templates/:
  46 browse.html:           for rendering most pages
  47 editlinks.html:        template for editing references
  48 editpage.html:         template for form for editing pages
  49 message.html:          error/system message template
  50
  51 schemas/:              SQL schemas for the RDBMSs
  52
  53
  54 Steve Wainstead
  55 swain@wcsb.org
  56 http://wcsb.org/~swain/
  57
  58 $Id: README,v 1.7 2000-12-12 17:11:14 wainstead Exp $