| 1 | = Buddy List Themes = |
| 2 | |
| 3 | == Installing == |
| 4 | The theme.xml file (along with any image preview) should be placed in `$PURPLEHOME/themes/$THEMENAME/purple/blist/` |
| 5 | Alternatively, in Linux the files can be put in /usr/share/themes/$THEMENAME/purple/blist/ |
| 6 | |
| 7 | == Creating == |
| 8 | A theme is contained entirely within an XML file called theme.xml and an optional image preview/logo file. |
| 9 | |
| 10 | The root node of the XML file contains all information about the theme including the name, author, type of theme (pidgin buddy list), as well as the name of a image file to display as a preview of the theme. The Theme file should also contain a description element which gives a short description of the theme. |
| 11 | |
| 12 | The XML file contains elements for different items on the buddy list: |
| 13 | * blist - the 'color' attribute sets the background color of the entire buddy list |
| 14 | |
| 15 | * groups - this has two sub-elements for expanded and collapsed groups, both of which are used to set the font and color of the group header. |
| 16 | |
| 17 | * buddys - this is used to set different elements of a buddy/contact/chat. It is used to set the arrangement of items for each buddy, as well as set the font and color depending on the status. |
| 18 | * placement - arranges the order from 0-4 of each elements of a buddy/contact/chat, the placement can also be set to -1 to hide any element. The show_status attribute also can hide or show the the status message for all buddies. The attributes are: |
| 19 | * status_icon - the icon representing available/away/busy/etc. |
| 20 | * name - the buddy/chat/contact name |
| 21 | * emblem - special symbols used to represent thing like mobile or web clients |
| 22 | * protocol_icon - icons representing the various protocol networks |
| 23 | * buddy_icon - a contact's buddy icon |
| 24 | * show_status - if this is set to 1 it will show a status message for each buddy, or if it is set to 0 it will hide the status message for all buddies. |
| 25 | * background - the 'color' attribute will set the background color of each buddy |
| 26 | * contact_text - sets the font and color of the text for a contact |
| 27 | * online_text - sets the font and color of the text for a buddy that is available |
| 28 | * away_text - sets the font and color of the text for a buddy that is away |
| 29 | * offline_text - sets the font and color of the text for a buddy that is offline |
| 30 | * idle_text - sets the font and color of the text for a buddy that is idle |
| 31 | * status_text - sets the font and color of the text for a buddy's status message |
| 32 | * message_text - sets the font and color of the text for a buddy that has sent you a message |
| 33 | * message_nick_said_text - sets the font and color for a chat where someone said your name |
| 34 | |
| 35 | All fonts and color attributes can be left blank or changed to anything supported by Pango. |
| 36 | * [http://library.gnome.org/devel/pango/stable/pango-Fonts.html#PangoFontDescription Pango font description] |
| 37 | * [http://library.gnome.org/devel/pango/stable/pango-Text-Attributes.html#pango_color_parse Pango color description] |
| 38 | |
| 39 | An example theme would look like: |
| 40 | |
| 41 | {{{ |
| 42 | <?xml version="1.0" encoding="UTF-8"?> |
| 43 | <theme type="pidgin buddy list" |
| 44 | name="Example Theme" |
| 45 | author="Your Name" |
| 46 | image="Example_theme_logo.png" |
| 47 | > |
| 48 | |
| 49 | |
| 50 | <description> |
| 51 | A short description of the theme |
| 52 | </description> |
| 53 | |
| 54 | <blist color="#000000"/> |
| 55 | |
| 56 | <selected text_color="" background_color=""/> |
| 57 | |
| 58 | <groups> |
| 59 | <expanded background="#FFFFFF" text_color="#000000" font=""/> |
| 60 | <collapsed background="black" text_color="white" font=""/> |
| 61 | </groups> |
| 62 | |
| 63 | <buddys> |
| 64 | <placement status_icon="0" |
| 65 | name="1" |
| 66 | emblem="2" |
| 67 | protocol_icon="3" |
| 68 | buddy_icon="4" |
| 69 | show_status="1" |
| 70 | /> |
| 71 | |
| 72 | <background color="#111111"/> |
| 73 | |
| 74 | <contact_text font="Purisa" color="#FFDFBF"/> |
| 75 | |
| 76 | <online_text font="" color="#FFDFBF"/> |
| 77 | <away_text font="" color=""/> |
| 78 | <offline_text font="" color=""/> |
| 79 | <idle_text font="" color=""/> |
| 80 | |
| 81 | <message_text font="" color=""/> |
| 82 | <message_nick_said_text font="" color="/> |
| 83 | |
| 84 | <status_text font="" color=""/> |
| 85 | </buddys> |
| 86 | </theme> |
| 87 | }}} |
| 88 | |
| 89 | == Example Themes == |