comparison: doc/plugin-ids.dox
doc/plugin-ids.dox
- changeset 7335
- 6e5ba33ea062
- child 13925
- cf8ee500a599
equal
deleted
inserted
replaced
| 7334:4d1a7f313b70 | 7335:6e5ba33ea062 |
|---|---|
| 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 | |
| 19 libgaim. It must not use any UI-specific code. | |
| 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 | |
| 31 @em should be your Gaim website user ID | |
| 32 (registered <a href="http://gaim.sourceforge.net/register.php">here</a>). | |
| 33 If for some reason you cannot register there (it shouldn't be a | |
| 34 problem!), you can use your SourceForge ID. Do @em not leave this field | |
| 35 blank. | |
| 36 | |
| 37 The @em pluginname is the name of your plugin. It can be whatever you like, | |
| 38 though it's common to keep it all lowercase. Do not use spaces! If you | |
| 39 want a space, use a '-'. Please do not put a version indicator in the ID. | |
| 40 The GaimPlugin structure already has a field for this. | |
| 41 | |
| 42 | |
| 43 @section plugin-db Plugin Database | |
| 44 Although it doesn't exist yet, in time there will be a plugin database | |
| 45 on the Gaim website, where users can download and install new plugins. | |
| 46 Plugins will be accessed by your plugin ID, which is one reason why it | |
| 47 must be unique. | |
| 48 | |
| 49 */ | |
| 50 | |
| 51 // vim: syntax=c tw=75 et |
