[squirrelmail.git] / doc / themes.txt

Themes
======

To create a theme, it is very simple.  Just go into the themes/ directory
and create a file called yourtheme_theme.php.  You then need to create an
array with 13 elements (0-12).  Below is an example followed by a
description of what the different entries are for.

---<START>--- 
<?php
 
    #  My Theme
    #  Author:  My Name
    #  Date:  Today's Date
    #
    #  Optional description
  
    $color[0]   = '#xxxxxx';
    $color[1]   = '#xxxxxx';
    $color[2]   = '#xxxxxx';
    $color[3]   = '#xxxxxx';
    $color[4]   = '#xxxxxx';
    $color[5]   = '#xxxxxx';
    $color[6]   = '#xxxxxx';
    $color[7]   = '#xxxxxx';
    $color[8]   = '#xxxxxx';
    $color[9]   = '#xxxxxx';
    $color[10]  = '#xxxxxx';
    $color[11]  = '#xxxxxx';
    $color[12]  = '#xxxxxx';
    $color[13]  = '#xxxxxx';
    $color[14]  = '#xxxxxx';

?>
---<END>---

And here is a description of what the different entries in the array
are colors of, and the letter before the number denotes 'b' for background and
'f' for foreground colors.

b  0: Title Bar at the top of the page header
f  1: <not currently used>
f  2: Error messages, usually red
b  3: Left folder list background color
b  4: Normal background color
b  5: Header of the message index [From, Date, Subject]
f  6: Normal text on the left folder list
f  7: Links in the right frame
f  8: Normal text [usually black]
b  9: Darker version of #0
b 10: Darker version of #9
f 11: Special folders color [Inbox, Trash, Sent]
b 12: Alternate color for message list [alters between 4 and this one]
f 13: Color for single-quoted text ('> text') when reading (default:  #800000)
f 14: Color for text with more than one quote (default: #FF0000)
f 15: Non-selectable folders in the left frame (defaults to $color[6])

Next all you have to do is run conf.pl and add the theme to the list
of themes available to you.  If you would like your theme to be 
included in the distribution of SquirrelMail, just email it to
<captbunzo@squirrelmail.org>.
Commit	Line	Data
390372b4	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
f740c049	6	array with 13 elements (0-12). Below is an example followed by a
390372b4	7	description of what the different entries are for.
	8
	9	---<START>---
	10	<?php
390372b4	11
97ca984f	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';
390372b4	33
	34	?>
	35	---<END>---
	36
	37	And here is a description of what the different entries in the array
4689abb8	38	are colors of, and the letter before the number denotes 'b' for background and
4689abb8	39	'f' for foreground colors.
390372b4	40
4689abb8	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
ecf5c1bd	48	f 7: Links in the right frame
4689abb8	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]
97ca984f	54	f 13: Color for single-quoted text ('> text') when reading (default: #800000)
4689abb8	55	f 14: Color for text with more than one quote (default: #FF0000)
ecf5c1bd	56	f 15: Non-selectable folders in the left frame (defaults to $color[6])
390372b4	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
ecf5c1bd	61	<captbunzo@squirrelmail.org>.