[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 color of:

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

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
<luke@squirrelmail.org> and I will review it.
Commit	Line	Data
	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 color of:
	39
	40	0: Title Bar at the top of the page header
	41	1: <not currently used>
	42	2: Error messages (usually red)
	43	3: Left folder list background color
	44	4: Normal background color
	45	5: Header of the message index (From, Date, Subject)
	46	6: Normal text on the left folder list
	47	7: Links in the right frame
	48	8: Normal text (usually black)
	49	9: Darker version of #0
	50	10: Darker version of #9
	51	11: Special folders color (Inbox, Trash, Sent)
	52	12: Alternate color for message list (alters between 4 and this one)
	53	13: Color for single-quoted text ("> text") when reading (default: #800000)
	54	14: Color for text with more than one quote (default: #FF0000)
	55
	56	Next all you have to do is run conf.pl and add the theme to the list
	57	of themes available to you. If you would like your theme to be
	58	included in the distribution of SquirrelMail, just email it to
	59	<luke@squirrelmail.org> and I will review it.