there are 16 color keys
[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 16 elements (0-15).  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     $color[13]  = '#xxxxxx';
32     $color[14]  = '#xxxxxx';
33     $color[15]  = '#xxxxxx';
34
35 ?>
36 ---<END>---
37
38 And here is a description of what the different entries in the array
39 are colors of, and the letter before the number denotes 'b' for background and
40 'f' for foreground colors.
41
42 b  0: Title Bar at the top of the page header
43 f  1: <not currently used>
44 f  2: Error messages, usually red
45 b  3: Left folder list background color
46 b  4: Normal background color
47 b  5: Header of the message index [From, Date, Subject]
48 f  6: Normal text on the left folder list
49 f  7: Links in the right frame
50 f  8: Normal text [usually black]
51 b  9: Darker version of #0
52 b 10: Darker version of #9
53 f 11: Special folders color [Inbox, Trash, Sent]
54 b 12: Alternate color for message list [alters between 4 and this one]
55 f 13: Color for single-quoted text ('> text') when reading (default:  #800000)
56 f 14: Color for text with more than one quote (default: #FF0000)
57 f 15: Non-selectable folders in the left frame (defaults to $color[6])
58
59 Next all you have to do is run conf.pl and add the theme to the list
60 of themes available to you.
61
62
63 $Id$