doc/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <!-- $Id -->
   3 <HTML><HEAD>
   4 <TITLE>SquirrelMail Documentation</TITLE>
   5 </HEAD>
   6 <BODY>
   7
   8 <h2>SquirrelMail Documentation</h2>
   9 <p>
  10 Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
  11 of all the docs that we have accumulated so far.  Maybe some time in the future we will put
  12 together a good documentation system.  This is just meant to get you up and running.  If you find
  13 mistakes, please email them to <a href="luke@squirrelmail.org">luke@squirrelmail.org</a>.
  14 </p>
  15
  16
  17 <dl>
  18    <dt><a href="translating.txt">Translating</a></dt>
  19    <dd>
  20       If you would like to make a translation of SquirrelMail, here are some guidelines to help
  21           you along the way.  These were compiled, thanks to Gustav Foseid.
  22    </dd>
  23
  24   <dt><a href="translating_help.txt">Translating the Help System</a></dt>
  25    <dd>
  26       We have a rather extensive help system in SquirrelMail now.  This document contains
  27       information about translating those help documents.
  28    </dd>
  29
  30   <dt><a href="tree.txt">The Mailbox Tree</a></dt>
  31    <dd>
  32       This explains the algorithms and arrays behind the mailbox tree used in deleting folders.
  33           This was compiled thanks to Nathan Ehresman.
  34    </dd>
  35
  36   <dt><a href="addressbook.txt">The Addressbook</a></dt>
  37    <dd>
  38       This explains how the addressbook works internally.
  39    </dd>
  40
  41   <dt><a href="mime.txt">MIME</a></dt>
  42    <dd>
  43       Ever wonder how SquirrelMail handles MIME support?  You need not search
  44       any longer.  This document gives an overview of how it works and how
  45       we decode MIME encoded messages.
  46    </dd>
  47
  48    <dt><a href="plugin.txt">Plugins</a></dt>
  49    <dd>
  50       If you would like to create plugins for SquirrelMail, this is the place
  51       to start.  It gives an overview and tells what needs to be in place for
  52       all plugins.
  53    </dd>
  54
  55    <dt><a href="themes.txt">Themes</a></dt>
  56    <dd>
  57       You can create your own color themes and add them in the themes/ directory
  58       if you wish.  This describes the format of the theme files.
  59    </dd>
  60
  61    <dt><a href="README.russian_apache">Russian Apache</a></dt>
  62    <dd>
  63       There are special instructions if you are running Russian Apache.  This
  64       document, thanks to Konstantin Riabitsev, will help you out.
  65    </dd>
  66
  67    <dt>Basic documentation that comes with distrbution:</dt>
  68    <dd>
  69       <a href="../AUTHORS">AUTHORS</a><br>
  70       <a href="../INSTALL">INSTALL</a><br>
  71       <a href="../UPGRADE">UPGRADE</a><br>
  72       <a href="../README">README</a><br>
  73       <a href="../COPYING">COPYING</a><br>
  74       <a href="../ChangeLog">ChangeLog</a><br>
  75    </dd>
  76 </dl>
  77
  78 </BODY>
  79 </HTML>