Mercurial > pidgin3 / file revision

doc/plugin-ids.dox@61ee455834c5

doc/plugin-ids.dox

Fri, 27 Feb 2004 19:25:27 +0000

author
Arun Tharuvai <aatharuv@mit.edu>
date
Fri, 27 Feb 2004 19:25:27 +0000
changeset 8354
61ee455834c5
parent 7335
6e5ba33ea062
child 13925
cf8ee500a599
permissions
-rw-r--r--

[gaim-migrate @ 9078]
" An update to com_err on debian appears to have broken
the ability of the zephyr plugin to compile with krb4.

Here's a patch, tested against comerr-dev
2.1-1.34+1.35-WIP-2004.01.31-1 in debian, and an older
version of com_err local to MIT, that fixes this. I
haven't tested this against non-kerberized zephyr, or
against other versions of com_err. A lot of the comerr
(error table) related code appears to be unnecessary.

This also fixes two other issues:
1) Upon each login, every entry in the "Anyone" group
was getting added to the Buddies group. I didn't notice
this earlier, since I usually don't restart gaim very
often.

2) No more compile warnings.

This also replaces occurrences of ZGetSender and
ZGetRealm with gaim_zephyr_get_sender and
gaim_zephyr_get_realm(),
in preparation for getting gaim to alternately use an
external program, "tzc" to talk to zephyr."
--Arun A Tharuvai, aka, the lone gaim zepher user

committer: Luke Schierer <lschiere@pidgin.im>

/** @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
                  libgaim. 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 Gaim website user ID
  (registered <a href="http://gaim.sourceforge.net/register.php">here</a>).
  If for some reason you cannot register there (it shouldn't be a
  problem!), you can use 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 GaimPlugin 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 Gaim 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

Mercurial Repository: pidgin3

mercurial