view doc/plugin-ids.dox @ 20329:24ce4fcce5b0

applied changes from e56db1b8a7bb8729e30fb3bf99a94ff7887fe4ec through 3efb5d625e5a73423be8be77a6baeed0b65f7e55 applied changes from 74f0e6698f9f17bc8335cf2454c06e6b13748039 through 017296ee954fb91349806c809983c916842603da applied changes from c8ff393c43d8a5f4136c653853a95284cc5710dc through f53dbbff44537aa86b1cb8788fd306c90e6ccca9 applied changes from f53dbbff44537aa86b1cb8788fd306c90e6ccca9 through 5798594431164383deacd7d4aad5a9a0d5b867ae applied changes from 5798594431164383deacd7d4aad5a9a0d5b867ae through 0822c640f22b63d7bc8992e62b80bccd1eea12a2 applied changes from 703c3f9437d5e71255819c747f9690d19c6ba6e3 through b7a2c4d81867c3bbd262c2a4b1d924ea7fd3afb6 applied changes from b7a2c4d81867c3bbd262c2a4b1d924ea7fd3afb6 through 5ea15b000ee727088be88bb335c2ded6b2ab96e3 applied changes from 5ea15b000ee727088be88bb335c2ded6b2ab96e3 through c5051010dd50f9fdb7f85d779d882ce8bbc149f2

/** @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