Added description of $color[12]
[squirrelmail.git] / doc / themes.txt
1 Themes
2 ======
3
4 To create a theme, it is very simple.  Just go into the themes/ directory
5 and create a file called yourtheme_theme.php.  You then need to create an
6 array with 12 elements (0-13).  Below is an example followed by a
7 description of what the different entries are for.
8
9 ---<START>--- 
10 <?php
11
12    #  My Theme
13    #  Author:  My Name
14    #  Date:  Today's Date
15    #
16    #  Optional description
17  
18    $color[0]   = "#xxxxxx";
19    $color[1]   = "#xxxxxx";
20    $color[2]   = "#xxxxxx";
21    $color[3]   = "#xxxxxx";
22    $color[4]   = "#xxxxxx";
23    $color[5]   = "#xxxxxx";
24    $color[6]   = "#xxxxxx";
25    $color[7]   = "#xxxxxx";
26    $color[8]   = "#xxxxxx";
27    $color[9]   = "#xxxxxx";
28    $color[10]  = "#xxxxxx";
29    $color[11]  = "#xxxxxx";
30    $color[12]  = "#xxxxxx";
31
32 ?>
33 ---<END>---
34
35 And here is a description of what the different entries in the array
36 are color of:
37
38   0: Title Bar at the top of the page header
39   1: <not currently used>
40   2: Error messages (usually red)
41   3: Left folder list background color
42   4: Normal background color
43   5: Header of the message index (From, Date, Subject)
44   6: Normal text on the left folder list
45   7: Links in the right frame
46   8: Normal text (usually black) 
47   9: Darker version of #0
48  10: Darker version of #9
49  11: Special folders color (Inbox, Trash, Sent)
50  12: Alternate color for message list (alters between 4 and this one)
51
52 Next all you have to do is run conf.pl and add the theme to the list
53 of themes available to you.  If you would like your theme to be 
54 included in the distribution of SquirrelMail, just email it to
55 <luke@squirrelmail.org> and I will review it.