Stream options were forgot here
[squirrelmail.git] / doc / index.html
index bb570df..1ac2dec 100644 (file)
@@ -1,36 +1,84 @@
-<h2>SquirrelMail Documentation</h2>
-<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
-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>   
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+  "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
+<!-- $Id$ -->
+<html>
+<head>
+<meta name="robots" content="noindex,nofollow">
+<title>SquirrelMail Documentation</title>
+</head>
+<body text="#000000" bgcolor="#ffffff" link="#0000cc" vlink="#0000cc" alink="#0000cc">
+<img src="../images/sm_logo.png" alt="SquirrelMail Logo" width="308" height="111" align="right" />
+
+<h1>SquirrelMail Documentation</h1>
+
+<p>Below is a list of all the documentation that comes in the SquirrelMail
+distribution package. Some of it may not be as up to date as what you'll
+find in our online manuals, which have better and more current information.
+We have manuals for administrators, developers, translators and users.
+There is also plenty of content that has been contributed by the community
+on our wiki.  Links to all these manuals and wikis can be found on our
+<a href="http://squirrelmail.org/documentation">documentation page</a></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="russian_apache.txt">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="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="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 />
+      <a href="release_notes_archive/">ReleaseNotes archive</a> - Notes for older SquirrelMail versions<br />
+   </dd>
+</dl>
+
+</body>
+</html>