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