Add preview pane to advanced default template. This serves as an example of how...
[squirrelmail.git] / plugins / preview_pane / README
1 Preview Pane plugin for SquirrelMail
2 ====================================
3 Ver 2.0, 2007/01/23
4
5 Original author: Paul Lesniewski <paul@squirrelmail.org>
6
7
8 Description
9 ===========
10
11 This plugin allows the user to turn on an extra frame below
12 the mailbox message list where the messages themselves are 
13 displayed, very similar to many other popular (typically
14 non-web-based) email clients.
15
16 Note that users must turn this functionality on by going to
17 the Options-->Display Preferences menu.  
18
19 This plugin is part of the SquirrelMail core package and
20 should never be replaced with a downloaded copy (that which
21 is available on the SquirrelMail website under Plugins is
22 only applicable to SquirrelMail 1.4.x).
23
24 This plugin should be activated only by a skin (template set)
25 that is capable of displaying a message preview pane.  One
26 such skin (template set) is the "default advanced" one that
27 comes with the SquirrelMail base package.
28
29
30
31 License
32 =======
33
34 This plugin is released under the GNU General Public
35 License (see the file COPYING for details).
36
37
38
39 Requirements
40 ============
41
42   * SquirrelMail version 1.5.2+
43
44
45
46 Help Requests
47 =============
48
49 Help requests should be posted to the SquirrelMail Plugins 
50 mailing list.
51
52 Info about the SquirrelMail Plugins mailing list can be found
53 on the SquirrelMail web site.  It is currently located at:
54
55 http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
56 squirrelmail-plugins@lists.sourceforge.net
57
58
59
60 Change Log
61 ==========
62
63   v2.0  2007/01/23  Paul Lesniewski
64    * Integration into SquirrelMail core
65    * Strip out most interface functionality; migrate to "default
66      advanced" template set
67    * Only works with 1.5.2+
68
69   v1.3  2007/01/19  Paul Lesniewski <paul@squirrelmail.org>
70    * Introduce slight delay refreshing message list so read messages
71      actually refresh as having been read
72    * Added 1.4.9 patch; versions between 1.4.3 and 1.4.9 should be
73      patch-able with the 1.4.3 patch
74    * Added 1.4.9 patch for delete, move, next plugin
75    * Added 1.5.1 patch, then removed it  ;-p  1.5.2 supports this
76      functionality natively.
77    * Patches run from plugin directory now
78    * Translations now kept in SquirrelMail locales packages, not in
79      this plugin; translators please send your translations to the
80      squirrelmail-i18n mailing list
81    * Added requisite informational functions in setup.php per plugin specs
82    * Use $PHP_SELF instead of REQUEST_URI, since apparently the latter is not
83      always 100% reliable.
84    * No longer support replacement source files; patches are more than enough
85    * Fully compatible with Windows plugin, version 1.7+
86
87   v1.2  2004/06/08  Paul Lesniewski <paul@squirrelmail.org>
88    * Added javascript fix so delete link will work when messages are 
89      viewed "in new window" - please give feedback if this causes problems
90    * Fixed missing locale switch (Thanks to Alexandros Vellis <avel@noc.uoa.gr>)
91    * Added Greek locale (Thanks to Alexandros Vellis <avel@noc.uoa.gr>)
92    * Updated patch for compatibility with Archive Mail plugin version 1.2
93    * Fixed placement of Clear button (no, non Archive Mail users, that button
94      was never supposed to be so blatantly placed in the middle of your screen)
95      Please report placement problems if they persist.
96    * Updated patch for 1.5.1 (works only against 1.5.1cvs as of approximately
97      06/08/04)
98    * Added patch for compatibility with the delete_move_next plugin under 
99      SquirrelMail 1.4.x
100
101   v1.1  2004/07/03  Paul Lesniewski <paul@squirrelmail.org>
102    * Added option to split frames vertically instead of horizontally
103
104   v1.0  2004/20/02  Paul Lesniewski <paul@squirrelmail.org>
105    * Initial version
106