--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<!-- $Id$ -->
+<html lang="en_GB">
+<head>
+<meta name="robots" content="noindex,nofollow">
+<title>SquirrelMail - Developer 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 Internals</h1>
+
+<p>This dir has some assorted bits of documentation about SquirrelMail internals, useful for
+people that want to change or extend SquirrelMail.</p>
+
+<p>More information about SquirrelMail development can be found on <a href="http://www.squirrelmail.org/">our
+website</a> and via the <a href="mailto:squirrelmail-devel@lists.sourceforge.net">squirrelmail-devel@lists.sourceforge.net</a> mailinglist (requires subscription before you can post).</p>
+
+<p><a href="plugin.txt">Plugin hooks and functions</a></p>
+
+<p><a href="addressbook.txt">Addressbook internals</a></p>
+
+<p><a href="tree.txt">Mailbox tree functions</a></p>
+
+<p><a href="rfc_documents.txt">List of RFC documents used in SquirrelMail</a></p>
+
+<p><a href="mime.txt">MIME bodystructure handling</a></p>
+
+<p><a href="compose.txt">Creating compose links the right way</a></p>
+
+</body>
+</html>
+
<meta name="robots" content="noindex,nofollow">
<title>SquirrelMail Documentation</title>
</head>
-<body>
+<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>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>
-
+of all the docs that we have accumulated so far. We are working on a more comprehensive user
+manual.</p>
<dl>
<dt><a href="translating.txt">Translating</a></dt>
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>
+ <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.
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><a href="Development/">SquirrelMail Development</a></dt>
+ <dd>
+ Want to code on SquirrelMail? Change behaviour or fix bugs? Create your own
+ plugin? See this set of documentation for some pointers.
+ </dd>
+
<dt>Basic documentation that comes with distribution:</dt>
<dd>
<a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
<a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail
versions.<br />
<a href="../ReleaseNotes">ReleaseNotes</a> - SquirrelMail release notes.<br />
+ <a href="ReleaseNotes/">ReleaseNotes archive</a> - Notes for older SquirrelMail versions<br />
</dd>
</dl>
projects / squirrelmail.git / commitdiff