doc/plugin-api

   1 About
   2 ======
   3
   4 This file documents what you can in the plugins/*.lua files.
   5
   6 Current version of the API is 0.1, modules should have the following
   7 line in them:
   8
   9         api_version=0.1
  10
  11 ... TODO: quick blurb about the plugin api.
  12
  13 Version Check
  14 ==============
  15
  16 The API will be versioned with a X.Y version that is not at all tied to the
  17 version of the wmiirc-lua release.  The meaning of the version
  18 components is as follows:
  19
  20   - X, the API major version number, distinguishes incompatible versions.
  21   - Y, the API minor version number, identifies minor improvement.
  22
  23 When the API is changed such that it adds functionality without causing
  24 compatibility issues with existing scripts, then the Y is incremented.
  25
  26 When the API components are modified in a non compatible way, or
  27 functionality is removed/replaced, then Y is reset to ZERO and X is
  28 incremented.
  29
  30 To check what API version your installation is using run:
  31
  32   $ grep api_version core/*.lua plugins/*.lua
  33
  34 In order for a plugin to be accepted by the runtime, the following
  35 conditions must be met:
  36
  37   - the X components of the API versions of the plugin and wmiirc-lua
  38     must match
  39   - the Y component of the plugin's API version must be less than or equal
  40     to the Y component of the wmiirc-lua's API version.
  41
  42 Quick Example
  43 ==============
  44
  45 ... TODO: a complete example of what can be done with comments
  46                 // this could just refer to bundled plugins
  47
  48 API Details
  49 ============
  50
  51 ... TODO:
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61 vim: set ts=8 et sw=8 tw=72