瀏覽代碼

Add index.html to Development subdir, rename README.russian_apache to
russian_apache.txt (why doens't CVS support moves? we need svn!).

Thijs Kinkhorst 20 年之前
父節點
當前提交
f79f993db4
共有 4 個文件被更改,包括 45 次插入37 次删除
  1. 1 1
      INSTALL
  2. 32 0
      doc/Development/index.html
  3. 12 36
      doc/index.html
  4. 0 0
      doc/russian_apache.txt

+ 1 - 1
INSTALL

@@ -179,7 +179,7 @@ c. Setting up SquirrelMail
 -------------------
 -------------------
 
 
   For information on how to make SquirrelMail work with Russian
   For information on how to make SquirrelMail work with Russian
-  Apache, see the README.russian_apache in the doc/ subdirectory.
+  Apache, see the russian_apache.txt in the doc/ subdirectory.
 
 
 
 
 6. TRANSLATIONS
 6. TRANSLATIONS

+ 32 - 0
doc/Development/index.html

@@ -0,0 +1,32 @@
+<!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>
+

+ 12 - 36
doc/index.html

@@ -5,14 +5,14 @@
 <meta name="robots" content="noindex,nofollow">
 <meta name="robots" content="noindex,nofollow">
 <title>SquirrelMail Documentation</title>
 <title>SquirrelMail Documentation</title>
 </head>
 </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>
 <h1>SquirrelMail Documentation</h1>
 
 
 <p>Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration
 <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>
 <dl>
    <dt><a href="translating.txt">Translating</a></dt>
    <dt><a href="translating.txt">Translating</a></dt>
@@ -27,38 +27,13 @@ together a good documentation system.  This is just meant to get you up and runn
       information about translating those help documents.
       information about translating those help documents.
    </dd>
    </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>
    <dt><a href="themes.txt">Themes</a></dt>
    <dd>
    <dd>
       You can create your own color themes and add them in the themes/ directory
       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.
       if you wish.  This describes the format of the theme files.
    </dd>
    </dd>
 
 
-   <dt><a href="README.russian_apache">Russian Apache</a></dt>
+   <dt><a href="russian_apache.txt">Russian Apache</a></dt>
    <dd>
    <dd>
       There are special instructions if you are running Russian Apache.  This
       There are special instructions if you are running Russian Apache.  This
       document, thanks to Konstantin Riabitsev, will help you out.
       document, thanks to Konstantin Riabitsev, will help you out.
@@ -93,18 +68,18 @@ together a good documentation system.  This is just meant to get you up and runn
      internals.
      internals.
    </dd>
    </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>
    <dt><a href="ie_ssl.txt">Internet Explorer and SSL</a></dt>
    <dd>
    <dd>
      Information about possible issues in Internet Explorer, when SquirrelMail
      Information about possible issues in Internet Explorer, when SquirrelMail
      is used in SSL enabled webserver.
      is used in SSL enabled webserver.
    </dd>
    </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>
    <dt>Basic documentation that comes with distribution:</dt>
    <dd>
    <dd>
       <a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
       <a href="../AUTHORS">AUTHORS</a> - Who's behind all this?<br />
@@ -115,6 +90,7 @@ together a good documentation system.  This is just meant to get you up and runn
       <a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail
       <a href="../ChangeLog">ChangeLog</a> - Differences between SquirrelMail
       versions.<br />
       versions.<br />
       <a href="../ReleaseNotes">ReleaseNotes</a> - SquirrelMail release notes.<br />
       <a href="../ReleaseNotes">ReleaseNotes</a> - SquirrelMail release notes.<br />
+      <a href="ReleaseNotes/">ReleaseNotes archive</a> - Notes for older SquirrelMail versions<br />
    </dd>
    </dd>
 </dl>
 </dl>
 
 

+ 0 - 0
doc/README.russian_apache → doc/russian_apache.txt