[Summary view] [Print] [Text view]

   1  $Id: README.txt,v 1.5 2005/03/31 11:33:09 holroy Exp $
   2  
   3  WikkiTikkiTavi - README
   4  -----------------------
   5  
   6    Copyright (C) 2000-2001 Scott Moonen and others.
   7  
   8    WikkiTikkiTavi is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12  
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17  
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  
  22  Comments are welcome.
  23  
  24  [Information about general setup]
  25  
  26  README.txt
  27  -------------
  28  README.txt is the file you are currently reading.  It contains general
  29  information on WikkiTikkiTavi, including how the code is organized and
  30  what is included with it.
  31  
  32  INSTALL.txt
  33  -------------
  34  The INSTALL.txt file contains information and instructions on installing and
  35  setting up your own Wiki using the WikkiTikkiTavi WikiEngine.
  36  
  37  LICENSE.txt
  38  -------------
  39  The LICENSE.txt file contains a copy of the GNU General Public License,
  40  which WikkiTikkiTavi is licensed under.
  41  
  42  NEWS.txt
  43  -------------
  44  The NEWS.txt file contains important information, news, or events regarding
  45  WikkiTikkiTavi.  This could include new release information, major new
  46  features, or anything else the developers feel warrants mention.
  47  
  48  ChangeLog.txt
  49  -------------
  50  ChangeLog.txt contains a date history of changes and updates made to
  51  WikkiTikkiTavi.
  52  
  53  TODO.txt
  54  -------------
  55  Contains info on where to find information on what to do in the future with
  56  WikkiTikkiTavi, and some additional information on where to contribute with
  57  patches, suggestions and bugs. 
  58  
  59  index.php
  60  -------------
  61  The index.php file is the "default" page loaded when accessing a Wiki
  62  run by WikkiTikkiTavi.
  63  
  64  config.php
  65  -------------
  66  config.php is not present in the 'Tavi distribution.  It is created when
  67  you install 'Tavi using the install/configure.pl script.  It contains
  68  various vital configuration settings for the wiki.
  69  
  70  
  71  contrib/
  72  -------------
  73  The contrib/ directory contains scripts, patches, and other add-ons or
  74  extras that are not part of the "official" code base (and thus, not
  75  maintained by us, nor supported by us) but might be useful to you.
  76  Please note that these extras may not work, or may require tweaking on
  77  your part to get them working with the latest releases of
  78  WikkiTikkiTavi.
  79  
  80  install/
  81  -------------
  82  The install/ directory contains scripts and utilities to aid with the
  83  installation and setup of the WikkiTikkiTavi engine.  You can find a
  84  database creation script, as well as conversion scripts to help you
  85  upgrade your Wiki from an older release of 'Tavi.
  86  
  87  lang/
  88  -------------
  89  This directory contains the nationalised user interface files required to get
  90  the user interface in your own language. If you don't see your own language
  91  within here, please translate and publish your translation on the web site,
  92  that is on: http://tavi.sourceforge.net/TaviTranslation
  93  
  94  fonts/
  95  -------------
  96  Related to the anti spam module, we use figlet fonts to provide an ascii image
  97  which the reader are supposed to read. This directory contains these fonts. 
  98  Please see http://www.figlet.org/ for more information on this subject.
  99  
 100  action/  admin/  lib/  parse/  template/  tools/
 101  ------------------------------------------------
 102  The rest of the directories are contains source code which usually isn't 
 103  changed. That might be with the exception of the template/ directory where
 104  users may provide his/her own templates for use with 'Tavi.