| 1 | <h2>SquirrelMail Documentation</h2> |
| 2 | <p> |
| 3 | Sorry for the lack of cohesion in the SquirrelMail documentation, but here is a conglomeration |
| 4 | of all the docs that we have accumulated so far. Maybe some time in the future we will put |
| 5 | together a good documentation system. This is just meant to get you up and running. If you find |
| 6 | mistakes, please email them to <a href="luke@squirrelmail.org">luke@squirrelmail.org</a>. |
| 7 | </p> |
| 8 | |
| 9 | |
| 10 | <ul> |
| 11 | <a href="translating.txt">Translating</a> |
| 12 | <ul> |
| 13 | If you would like to make a translation of SquirrelMail, here are some guidelines to help |
| 14 | you along the way. These were compiled, thanks to Gustav Foseid. |
| 15 | </ul> |
| 16 | </ul> |
| 17 | |
| 18 | <ul> |
| 19 | <a href="translating_help.txt">Translating the Help System</a> |
| 20 | <ul> |
| 21 | We have a rather extensive help system in SquirrelMail now. This document contains |
| 22 | information about translating those help documents. |
| 23 | </ul> |
| 24 | </ul> |
| 25 | |
| 26 | <ul> |
| 27 | <a href="tree.txt">The Mailbox Tree</a> |
| 28 | <ul> |
| 29 | This explains the algorithms and arrays behind the mailbox tree used in deleting folders. |
| 30 | This was compiled thanks to Nathan Ehresman. |
| 31 | </ul> |
| 32 | </ul> |
| 33 | |
| 34 | <ul> |
| 35 | <a href="addressbook.txt">The Addressbook</a> |
| 36 | <ul> |
| 37 | This explains how the addressbook works internally. |
| 38 | </ul> |
| 39 | </ul> |
| 40 | |
| 41 | <ul> |
| 42 | <a href="mime.txt">MIME</a> |
| 43 | <ul> |
| 44 | Ever wonder how SquirrelMail handles MIME support? You need not search |
| 45 | any longer. This document gives an overview of how it works and how |
| 46 | we decode MIME encoded messages. |
| 47 | </ul> |
| 48 | </ul> |
| 49 | |
| 50 | <ul> |
| 51 | <a href="plugin.txt">Plugins</a> |
| 52 | <ul> |
| 53 | If you would like to create plugins for SquirrelMail, this is the place |
| 54 | to start. It gives an overview and tells what needs to be in place for |
| 55 | all plugins. |
| 56 | </ul> |
| 57 | </ul> |
| 58 | |
| 59 | <ul> |
| 60 | <a href="themes.txt">Themes</a> |
| 61 | <ul> |
| 62 | You can create your own color themes and add them in the themes/ directory |
| 63 | if you wish. This describes the format of the theme files. |
| 64 | </ul> |
| 65 | </ul> |
| 66 | |
| 67 | <ul> |
| 68 | <a href="README.russian_apache">Russian Apache</a> |
| 69 | <ul> |
| 70 | There are special instructions if you are running Russian Apache. This |
| 71 | document, thanks to Konstantin Riabitsev, will help you out. |
| 72 | </ul> |
| 73 | </ul> |
| 74 | |
| 75 | <ul> |
| 76 | Basic documentation that comes with distrbution: |
| 77 | <ul> |
| 78 | <a href="../AUTHORS">AUTHORS</a><br> |
| 79 | <a href="../INSTALL">INSTALL</a><br> |
| 80 | <a href="../UPGRADE">UPGRADE</a><br> |
| 81 | <a href="../README">README</a><br> |
| 82 | <a href="../COPYING">COPYING</a><br> |
| 83 | <a href="../ChangeLog">ChangeLog</a><br> |
| 84 | </ul> |
| 85 | </ul> |