annotate pixmaps/smileys/THEMES-HOWTO @ 11035:11e465b55fe6

[gaim-migrate @ 12922] A host of doxygen tweaks. There's a few more left, not sure how to fix them at the moment... committer: Tailor Script <tailor@pidgin.im>
author Gary Kramlich <grim@reaperworld.com>
date Tue, 28 Jun 2005 20:36:20 +0000
parents 280ed2b617be
children 6fd7425133fc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4252
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
1 Gaim Smiley Themes Documentation
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
2 Sean M. Egan
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
3 5 Jan 2003
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
4
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
5 Version 0.60 of Gaim brings up all themable smileys. In the preferences dialog, a user can choose from a selection of looks his smileys will take. This guide is to serve as a reference to those interested in creating third-party smiley themes.
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
6
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
7 (SME: I'm doing this at 6:30AM; I'm tired, but I can't sleep. Someone make sure I fix this up to make sure it all makes sense when I'm not tired anymore. Right now it's mostly just unassembled thoughts)
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
8
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
9 Your theme should be contained in a single directory. This directory will be installed in the Gaim smiley theme directory (SME: There should probably be a $HOME/.gaim/smileys/ that the theme could go in too.). This directory will contain a file called `theme' that specifies the theme and image (SME: And possibly sound) files that are used by the theme. The format of the `theme' file is as follows.
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
10
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
11 The beginning of the file contains some metainformation about the theme in the format
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
12
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
13 Key=Value
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
14
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
15 Valid keys include:
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
16 Name - Name of the theme
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
17 Description - Description of the theme
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
18 Icon - An image used to represent the theme in the theme selector UI
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
19 Author - The author's name
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
20
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
21 Following this meta-information are "sml" groups. A "sml" group is a group of smileys that will be shown together. For example, each protocol has its own "sml" group (MSN, Yahoo, Gadu-Gadu, etc.). The name of the group is surrounded in square brackets, and each line beneath it (until the next sml group or the end of the file) defines a smiley.
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
22 Each line of the group starts with a filename of the icon (SME: Or sound?) followed by a space-delimited list of the characters that represent it.
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
23
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
24 Example:
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
25 [AIM/ICQ]
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
26 smiley.png :) :-)
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
27
280ed2b617be [gaim-migrate @ 4502]
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
28 In the smiley selector UI, each icon will only be shown once, and the first string representing it will be used. To keep a smiley out of the selector altogether, make the first two characters of the line "! " followed by the filename and emoticons.