Fix a small bug when displaying less messages than the page max.
[squirrelmail.git] / doc / index.html
index bb570dfbb6b53f10df49057648b99bdd68169a4a..3367aaf93748d62eb831d4e33b7f1fc959e5b835 100644 (file)
-<h2>SquirrelMail Documentation</h2>
-<p>
-Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!-- $Id$ -->
+<html>
+<head>
+<meta name="robots" content="noindex,nofollow">
+<title>SquirrelMail Documentation</title>
+</head>
+<body>
+
+<h1>SquirrelMail Documentation</h1>
+
+<p>Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
 of all the docs that we have accumulated so far.  Maybe some time in the future we will put
 of all the docs that we have accumulated so far.  Maybe some time in the future we will put
-together a good documentation system.  This is just meant to get you up and running.  If you find
-mistakes, please email them to <a href="lehresma@css.tayloru.edu">lehresma@css.tayloru.edu</a>.
-</p>
-
-
-<ul>
-   <a href="message_array.html">Message Array Format</a>
-   <ul>
-      When reading in a message from a mailbox, SquirrelMail shoves all the infomation into a
-      large array.  I have attempted to map out that array.  I have done my best to make this
-      accurate, but there probably are some inacuracies somewhere.
-   </ul>
-</ul>
-
-<ul>
-   <a href="sqimap.php3">SquirrelMail IMAP Functions</a>
-   <ul>
-      These are a collection of functions designed to replace the PHP imap functions so that you
-      don't have to compile in the UW IMAP server into your PHP distrobution.
-   </ul>
-</ul>
-
-<ul>
-   Basic documentation that comes with distrbution:
-   <ul>
-      <a href="../AUTHORS">AUTHORS</a><br>
-      <a href="../INSTALL">INSTALL</a><br>
-      <a href="../README">README</a><br>
-      <a href="../COPYING">COPYING</a><br>
-      <a href="../ChangeLog">ChangeLog</a><br>
-   </ul>
-</ul>   
+together a good documentation system.  This is just meant to get you up and running.</p>
+
+
+<dl>
+   <dt><a href="translating.txt">Translating</a></dt>
+   <dd>
+      If you would like to make a translation of SquirrelMail, here are some guidelines to help
+      you along the way.  These were compiled, thanks to Gustav Foseid.
+   </dd>
+
+  <dt><a href="translating_help.txt">Translating the Help System</a></dt>
+   <dd>
+      We have a rather extensive help system in SquirrelMail. This document contains
+      information about translating those help documents.
+   </dd>
+
+  <dt><a href="tree.txt">The Mailbox Tree</a></dt>
+   <dd>
+      This explains the algorithms and arrays behind the mailbox tree used in deleting folders.
+      This was compiled thanks to Nathan Ehresman.
+   </dd>
+
+  <dt><a href="addressbook.txt">The Addressbook</a></dt>
+   <dd>
+      This explains how the addressbook works internally.
+   </dd>
+
+  <dt><a href="mime.txt">MIME</a></dt>
+   <dd>
+      Ever wonder how SquirrelMail handles MIME support?  You need not search
+      any longer.  This document gives an overview of how it works and how
+      we decode MIME encoded messages.
+   </dd>
+
+   <dt><a href="plugin.txt">Plugins</a></dt>
+   <dd>
+      If you would like to create plugins for SquirrelMail, this is the place
+      to start.  It gives an overview and tells what needs to be in place for
+      all plugins.
+   </dd>
+
+   <dt><a href="themes.txt">Themes</a></dt>
+   <dd>
+      You can create your own color themes and add them in the themes/ directory
+      if you wish.  This describes the format of the theme files.
+   </dd>
+
+   <dt><a href="README.russian_apache">Russian Apache</a></dt>
+   <dd>
+      There are special instructions if you are running Russian Apache.  This
+      document, thanks to Konstantin Riabitsev, will help you out.
+   </dd>
+
+   <dt><a href="authentication.txt">Authentication</a></dt>
+   <dd>
+     SquirrelMail allows you to log in to your IMAP and SMTP servers using
+     plaintext, CRAM-MD5 or DIGEST-MD5, as well as use SSL for extra security.
+     This document describes how to use this new code, and the requirements.
+   </dd>
+
+   <dt><a href="db-backend.txt">Database Backend</a></dt>
+   <dd>
+     SquirrelMail allows you to store user's preferences and address books
+     in database that is compatible with PHP Pear DB libraries. This document
+     describes how to setup database.
+   </dd>
+
+   <dt><a href="presets.txt">Specific IMAP server setups</a></dt>
+   <dd>
+     SquirrelMail configuration utility allows adjusting settings for selected
+     IMAP server with one quick command. D command asks for IMAP server name and
+     modifies all settings that are specific to selected IMAP server. This
+     document provides quick description of all IMAP presets.
+   </dd>
+
+   <dt><a href="i18n.txt">SquirrelMail internationalization</a></dt>
+   <dd>
+     Some information about SquirrelMail internationalization (interface
+     translations, time zones, reading emails in different charsets.)
+     internals.
+   </dd>
+
+   <dt><a href="rfc_documents.txt">RFC documents</a></dt>
+   <dd>
+     Information about protocol standards that are being implemented in
+     SquirrelMail.
+   </dd>
+
+   <dt><a href="ie_ssl.txt">Internet Explorer and SSL</a></dt>
+   <dd>
+     Information about possible issues in Internet Explorer, when SquirrelMail
+     is used in SSL enabled webserver.
+   </dd>
+
+   <dt>Basic documentation that comes with distribution:</dt>
+   <dd>
+      <a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
+      <a href="../INSTALL">INSTALL</a> - Installation instructions<br />
+      <a href="../UPGRADE">UPGRADE</a> - Upgrading instructions<br />
+      <a href="../README">README</a> - Everyone should read this.<br />
+      <a href="../COPYING">COPYING</a> - Licencing of SquirrelMail<br/>
+      <a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail
+      versions.<br />
+      <a href="../ReleaseNotes">ReleaseNotes</a> - SquirrelMail release notes.<br />
+   </dd>
+</dl>
+
+</body>
+</html>