[squirrelmail.git] / doc / index.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- $Id$ -->
<html>
<head>
<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
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>Basic documentation that comes with distrbution:</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 />
   </dd>
</dl>

</body>
</html>
Commit	Line	Data
47c5f7fc	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
39f79fa9	2	<!-- $Id$ -->
	3	<html>
	4	<head>
	5	<title>SquirrelMail Documentation</title>
	6	</head>
	7	<body>
47c5f7fc	8
39f79fa9	9	<h1>SquirrelMail Documentation</h1>
	10
	11	<p>Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
4ca45d7b	12	of all the docs that we have accumulated so far. Maybe some time in the future we will put
39f79fa9	13	together a good documentation system. This is just meant to get you up and running.</p>
4ca45d7b	14
4ca45d7b	15
47c5f7fc	16	<dl>
	17	<dt><a href="translating.txt">Translating</a></dt>
	18	<dd>
ca1a555e	19	If you would like to make a translation of SquirrelMail, here are some guidelines to help
ca1a555e	20	you along the way. These were compiled, thanks to Gustav Foseid.
47c5f7fc	21	</dd>
4ca45d7b	22
47c5f7fc	23	<dt><a href="translating_help.txt">Translating the Help System</a></dt>
47c5f7fc	24	<dd>
39f79fa9	25	We have a rather extensive help system in SquirrelMail. This document contains
ca1a555e	26	information about translating those help documents.
47c5f7fc	27	</dd>
dc1521c1	28
47c5f7fc	29	<dt><a href="tree.txt">The Mailbox Tree</a></dt>
47c5f7fc	30	<dd>
dc1521c1	31	This explains the algorithms and arrays behind the mailbox tree used in deleting folders.
dc1521c1	32	This was compiled thanks to Nathan Ehresman.
47c5f7fc	33	</dd>
dc1521c1	34
47c5f7fc	35	<dt><a href="addressbook.txt">The Addressbook</a></dt>
47c5f7fc	36	<dd>
7dd930d1	37	This explains how the addressbook works internally.
47c5f7fc	38	</dd>
7dd930d1	39
47c5f7fc	40	<dt><a href="mime.txt">MIME</a></dt>
47c5f7fc	41	<dd>
cbcf32f6	42	Ever wonder how SquirrelMail handles MIME support? You need not search
	43	any longer. This document gives an overview of how it works and how
	44	we decode MIME encoded messages.
47c5f7fc	45	</dd>
cbcf32f6	46
47c5f7fc	47	<dt><a href="plugin.txt">Plugins</a></dt>
47c5f7fc	48	<dd>
ca1a555e	49	If you would like to create plugins for SquirrelMail, this is the place
	50	to start. It gives an overview and tells what needs to be in place for
	51	all plugins.
47c5f7fc	52	</dd>
ca1a555e	53
47c5f7fc	54	<dt><a href="themes.txt">Themes</a></dt>
47c5f7fc	55	<dd>
390372b4	56	You can create your own color themes and add them in the themes/ directory
390372b4	57	if you wish. This describes the format of the theme files.
47c5f7fc	58	</dd>
390372b4	59
47c5f7fc	60	<dt><a href="README.russian_apache">Russian Apache</a></dt>
47c5f7fc	61	<dd>
ca1a555e	62	There are special instructions if you are running Russian Apache. This
ca1a555e	63	document, thanks to Konstantin Riabitsev, will help you out.
47c5f7fc	64	</dd>
ca1a555e	65
2546dc76	66	<dt><a href="authentication.txt">Authentication</a></dt>
	67	<dd>
	68	SquirrelMail allows you to log in to your IMAP and SMTP servers using
	69	plaintext, CRAM-MD5 or DIGEST-MD5, as well as use SSL for extra security.
	70	This document describes how to use this new code, and the requirements.
	71	</dd>
	72
47c5f7fc	73	<dt>Basic documentation that comes with distrbution:</dt>
47c5f7fc	74	<dd>
39f79fa9	75	<a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
	76	<a href="../INSTALL">INSTALL</a> - Installation instructions<br />
	77	<a href="../UPGRADE">UPGRADE</a> - Upgrading instructions<br />
	78	<a href="../README">README</a> - Everyone should read this.<br />
	79	<a href="../COPYING">COPYING</a> - Licencing of SquirrelMail<br/>
	80	<a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail versions.<br />
47c5f7fc	81	</dd>
	82	</dl>
	83
39f79fa9	84	</body>
39f79fa9	85	</html>