Mercurial > pidgin.yaz
view doc/plugin-ids.dox @ 17448:af5f8bdc0bab
propagate from branch 'im.pidgin.pidgin' (head 61738e60f23bfd0eec3701fb8c7c28f263bc04ed)
to branch 'org.maemo.garage.pidgin.smiley-install' (head a6dab6460ee13870320775495613164974a3be24)
author | Gabriel Schulhof <nix@go-nix.ca> |
---|---|
date | Tue, 29 May 2007 20:46:02 +0000 |
parents | 1414e0e01dc5 |
children | e0613cf8c493 |
line wrap: on
line source
/** @page plugin-ids Plugin IDs @section Introduction Every plugin contains a unique identifier to prevent duplicate plugin loading and conflicts. This, which will be called a plugin ID from here on, must follow a specific format. This format categorizes a plugin and makes duplicate IDs unlikely. @section Format The basic format of a plugin ID is as follows: <tt><i>type</i>-<i>username</i>-<i>pluginname</i></tt> The @em type indicator specifies the type of plugin. This must be one of the following: - core - Core plugin, capable of being loaded in any program using libpurple. It must not use any UI-specific code. - prpl - Protocol plugin, providing additional protocols to connect to. - lopl - Loader plugin, which loads scripts as plugins (like Perl or TCL). - gtk - GTK+ 2.x plugin. It may use GTK+ code, but cannot use any window toolkit code (such as X11 or Win32). - gtk-x11 - GTK+ 2.x plugin using X11 code. - gtk-win32 - GTK+ 2.x plugin using Win32 code. - qpe - Gaim for Qtopia plugin. The @em username must be a unique identifier for that person. It @em should be your SourceForge ID. Do @em not leave this field blank. The @em pluginname is the name of your plugin. It can be whatever you like, though it's common to keep it all lowercase. Do not use spaces! If you want a space, use a '-'. Please do not put a version indicator in the ID. The PurplePlugin structure already has a field for this. @section plugin-db Plugin Database Although it doesn't exist yet, in time there will be a plugin database on the Pidgin website, where users can download and install new plugins. Plugins will be accessed by your plugin ID, which is one reason why it must be unique. */ // vim: syntax=c tw=75 et