Mercurial > pidgin.yaz
annotate doc/plugin-ids.dox @ 17593:759cd72bd2ff
Replaced a clean and simple API with a very weird hack due to vivid request on #pidgin by multiple devs. This avoids the change in PurplePluginProtocolInfo, but requires complicated change tracking in every prpl. The others prpl should add this change tracking, too (since otherwise the status gets changed even though nothing they care about changed), but that's not up to me.
author | Andreas Monitzer <pidgin@monitzer.com> |
---|---|
date | Mon, 18 Jun 2007 12:37:29 +0000 |
parents | 1414e0e01dc5 |
children | e0613cf8c493 |
rev | line source |
---|---|
7335 | 1 /** @page plugin-ids Plugin IDs |
2 | |
3 @section Introduction | |
4 Every plugin contains a unique identifier to prevent duplicate plugin | |
5 loading and conflicts. This, which will be called a plugin ID from here | |
6 on, must follow a specific format. This format categorizes a plugin and | |
7 makes duplicate IDs unlikely. | |
8 | |
9 | |
10 @section Format | |
11 The basic format of a plugin ID is as follows: | |
12 | |
13 <tt><i>type</i>-<i>username</i>-<i>pluginname</i></tt> | |
14 | |
15 The @em type indicator specifies the type of plugin. This must be one | |
16 of the following: | |
17 | |
18 - core - Core plugin, capable of being loaded in any program using | |
16196 | 19 libpurple. It must not use any UI-specific code. |
7335 | 20 - prpl - Protocol plugin, providing additional protocols to |
21 connect to. | |
22 - lopl - Loader plugin, which loads scripts as plugins (like Perl | |
23 or TCL). | |
24 - gtk - GTK+ 2.x plugin. It may use GTK+ code, but cannot use any | |
25 window toolkit code (such as X11 or Win32). | |
26 - gtk-x11 - GTK+ 2.x plugin using X11 code. | |
27 - gtk-win32 - GTK+ 2.x plugin using Win32 code. | |
28 - qpe - Gaim for Qtopia plugin. | |
29 | |
30 The @em username must be a unique identifier for that person. It | |
13863
cf3eb9f311b2
[gaim-migrate @ 16326]
Richard Laager <rlaager@wiktel.com>
parents:
7335
diff
changeset
|
31 @em should be your SourceForge ID. Do @em not leave this field |
7335 | 32 blank. |
33 | |
34 The @em pluginname is the name of your plugin. It can be whatever you like, | |
35 though it's common to keep it all lowercase. Do not use spaces! If you | |
36 want a space, use a '-'. Please do not put a version indicator in the ID. | |
16196 | 37 The PurplePlugin structure already has a field for this. |
7335 | 38 |
39 | |
40 @section plugin-db Plugin Database | |
41 Although it doesn't exist yet, in time there will be a plugin database | |
16196 | 42 on the Pidgin website, where users can download and install new plugins. |
7335 | 43 Plugins will be accessed by your plugin ID, which is one reason why it |
44 must be unique. | |
45 | |
46 */ | |
47 | |
48 // vim: syntax=c tw=75 et |