← Back to branch summary

~ubuntu-branches/ubuntu/hoary/psi/hoary

« back to all changes in this revision

Viewing changes to libpsi/iconset/ICONSET-HOWTO

  • Committer: Bazaar Package Importer
  • Author(s): Jan Niehusmann
  • Date: 2004-06-15 00:10:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040615001041-enywb6pcpe4sjsw6
Tags: 0.9.2-1
* New upstream release
* Set KDEDIR for ./configure so kde specific files get installed
* Don't install libpsiwidgets.so. It got installed in /usr/share
  where it doesn't belong. May be included (at a better location)
  later.

Show diffs side-by-side

added added

removed removed

Lines of Context:
libpsi/iconset/ICONSET-HOWTO
 
1
Iconset-HOWTO
 
2
~~~~~~~~~~~~~
 
3
 
 
4
Step-by-step guide how to create an iconset.
 
5
 
 
6
1. Create a directory, and name it somehow. For example "my-first-iconset".
 
7
 
 
8
2. Create a file named "icondef.xml" in that directory.
 
9
 
 
10
3. Place all icons and sounds you want to use in iconset, in that directory.
 
11
 
 
12
4. Start editind "icondef.xml" with your favourite XML editor.
 
13
 
 
14
5. Write the following tags in it:
 
15
<?xml version='1.0' encoding='UTF-8'?>
 
16
<icondef>
 
17
</icondef>
 
18
 
 
19
6. First, add the iconset meta information:
 
20
<?xml version='1.0' encoding='UTF-8'?>
 
21
<icondef>
 
22
        <meta>
 
23
                <name>Iconset Name</name>
 
24
                <version>Iconset Version</version>
 
25
                <description>Iconset Description</description>
 
26
                <creation>2003-01-25</creation> <!-- Creation date yyyy-mm-dd -->
 
27
                <home>http://www.myiconsethomepage.com</home>
 
28
                <author jid='mblsha@jabber.ru'
 
29
                        email='mblsha@spammeanddie.com'
 
30
                        www='hhtp://maz.sf.net'>Michail Pishchagin</author>
 
31
                <author>I.M. Anonymous</author>
 
32
        </meta>
 
33
</icondef>
 
34
 
 
35
7. Now, it's time to add some icons:
 
36
<?xml version='1.0' encoding='UTF-8'?>
 
37
<icondef>
 
38
        <meta> <!-- ... --> </meta>
 
39
 
 
40
        <icon>
 
41
                <text>:-)</text>
 
42
                <text>:)</text>
 
43
                <text xml:lang='en'>:smiley:</text>
 
44
 
 
45
                <object mime='image/png'>smiley.png</object>
 
46
                <object mime='audio/x-wav'>smiley.wav</object>
 
47
        </icon>
 
48
</icondef>
 
49
 
 
50
This iconset contains only one icon, that is associated with the following strings:
 
51
':-)', ':)', ':smiley:'. When it is shown on screen, it will be displayed as
 
52
'smiley.png' image, and will play the 'smiley.wav' sound.
 
53
 
 
54
Possible mime-types are:
 
55
        1. For images:
 
56
                image/png -- preferred image format
 
57
                video/x-mng (animated format)
 
58
                image/gif   (animated format)
 
59
                image/x-xpm
 
60
                image/bmp
 
61
                image/jpeg
 
62
                image/svg+xml
 
63
 
 
64
        2. For sounds:
 
65
                audio/x-wav -- preferred sound format, as it can be played on all Psi platforms
 
66
                audio/x-ogg
 
67
                audio/x-mp3
 
68
                audio/x-midi -- not really supported
 
69
 
 
70
Multiple graphic mime types, and sound mime types can be specified simultaneously:
 
71
 
 
72
        <!-- ... -->
 
73
        <icon>
 
74
                <object mime='image/png'>smiley.png</object>
 
75
                <object mime='video/x-mng'>smiley.mng</object>
 
76
                <object mime='image/gif'>smiley.gif</object>
 
77
 
 
78
                <object mime='audio/x-wav'>smiley.wav</object>
 
79
                <object mime='audio/x-ogg'>smiley.ogg</object>
 
80
        </icon>
 
81
        <!-- ... -->
 
82
 
 
83
8. Advanced Psi icon tags:
 
84
 
 
85
The following icon specifies its name. It is primately used in system Psi iconsets:
 
86
 
 
87
        <!-- ... -->
 
88
        <icon>
 
89
                <object mime='image/png'>smiley.png</object>
 
90
                <object mime='audio/x-wav'>smiley.wav</object>
 
91
 
 
92
                <x xmlns='name'>emoticon/smiley</x>
 
93
        </icon>
 
94
        <!-- ... -->
 
95
 
 
96
And it can be forced for icon to be animated, or not:
 
97
 
 
98
        <!-- ... -->
 
99
        <icon>
 
100
                <object mime='image/png'>connect.png</object>
 
101
 
 
102
                <x xmlns='name'>psi/connect</x>
 
103
                <x xmlns='type'>animation</x>
 
104
        </icon>
 
105
        <!-- ... -->
 
106
 
 
107
This way, icon will be animated. Animation frames are laid horizontally in that
 
108
single .png graphic.
 
109
 
 
110
        <!-- ... -->
 
111
        <icon>
 
112
                <object mime='image/png'>connect.png</object>
 
113
 
 
114
                <x xmlns='name'>psi/connect</x>
 
115
                <x xmlns='type'>image</x>
 
116
        </icon>
 
117
        <!-- ... -->
 
118
 
 
119
And this way, it will be loaded as single graphic.
 
120
 
 
121
9. Packing it all together: Pack your 'my-first-iconset' directory in a
 
122
my-first-iconset.zip archive using your favourite archiver. Please note,
 
123
that name of directory and name of archive MUST be the same. 
 
124
Then, you should rename the resulting file to my-first-iconset.jisp and
 
125
distribute that file.
 
126
 
 
127
Good Luck! :-)