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