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.php3:            the "main page", really a set of branching instructions
  16 wiki_config.php3:      configuration options, constants, global variables
  17 wiki_dbmlib.php3:      database access functions for dbm files
  18 wiki_display.php3:     display a page (this calls "wiki_transform.php3")
  19 wiki_editlinks.php3:   edit the embedded links of a page
  20 wiki_editpage.php3:    edit a page
  21 wiki_fullsearch.php3:  full page text search
  22 wiki_mysql.php3:       database access functions for mySQL
  23 wiki_pageinfo.php3:    gives detailed low-level info on the page structure
  24 wiki_pgsql.php3:       database access functions for PostgreSQL
  25 wiki_savepage.php3:    save a page to db, thank user
  26 wiki_search.php3:      page title search
  27 wiki_setupwiki.php3:   load a set of pages from ./pgsrc/ directory
  28 wiki_stdlib.php3:      standard library of functions (non-db related)
  29 wiki_transform.php3:   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.5 2000-07-15 20:56:45 wainstead Exp $