Merge of Steve Brown's patch
[squirrelmail.git] / doc / themes.txt
1 Themes
2 ======
3 SquirrelMail users are able to customize the look of the interface by selecting
4 a custom theme and the font style.
5
6 SquirrelMail themes define interface colors. Each theme is a set of 17 or more
7 colors.
8
9 You can easily create your own theme. It is very simple. Just go into the
10 themes/ directory and create a file called yourtheme_theme.php.
11 You then need to create an array with 17 elements (0-16). Below is a blank theme
12 sample followed by a description of what the different entries are for.
13
14 ---<START>--- 
15 <?php
16
17 /**
18  * My Theme
19  *
20  * Author: My name
21  * Date:   Today's date
22  *
23  * Optional description
24  */
25
26 global $color;
27 $color[0]   = '#xxxxxx';
28 $color[1]   = '#xxxxxx';
29 $color[2]   = '#xxxxxx';
30 $color[3]   = '#xxxxxx';
31 $color[4]   = '#xxxxxx';
32 $color[5]   = '#xxxxxx';
33 $color[6]   = '#xxxxxx';
34 $color[7]   = '#xxxxxx';
35 $color[8]   = '#xxxxxx';
36 $color[9]   = '#xxxxxx';
37 $color[10]  = '#xxxxxx';
38 $color[11]  = '#xxxxxx';
39 $color[12]  = '#xxxxxx';
40 $color[13]  = '#xxxxxx';
41 $color[14]  = '#xxxxxx';
42 $color[15]  = '#xxxxxx';
43 $color[16]  = '#xxxxxx';
44
45 ?>
46 ---<END>---
47
48 Here is descriptions of what the different entries in the array are colors of.
49 The letter before the number denotes 'b' for background and 'f' for foreground
50 colors.
51
52 b  0: Title bar at the top of the page header
53 f  1: Error messages border, usually red
54 f  2: Error messages, usually red
55 b  3: Left folder list background color
56 b  4: Normal background color
57 b  5: Header of the message index [From, Date, Subject]
58 f  6: Normal text on the left folder list
59 f  7: Links in the right frame
60 f  8: Normal text [usually black]
61 b  9: Darker version of #0
62 b 10: Darker version of #9
63 f 11: Special folders color [Inbox, Trash, Sent]
64 b 12: Alternate color for message list [alters between #4 and this one]
65 f 13: Color for single-quoted text ('> text') when reading (default: #800000)
66 f 14: Color for text with more than one quote (default: #ff0000)
67 f 15: Non-selectable folders in the left frame (default: $color[6])
68 b 16: Highlight color (default: $color[2])
69
70 Next all you have to do is run SquirrelMail configuration utility and add the
71 theme to the list of themes available to you.
72
73
74 $Id$