mod_webpresence/README.markdown

   1 ---
   2 labels:
   3 - 'Stage-Stable'
   4 summary: Display your online status in web pages
   5 ...
   6
   7 Introduction
   8 ============
   9
  10 Quite often you may want to publish your Jabber status to your blog or
  11 website. mod\_webpresence allows you to do exactly this.
  12
  13 Details
  14 =======
  15
  16 This module uses Prosody's built-in HTTP server (it does not depend on
  17 mod\_httpserver). It supplies a status icon representative of a user's
  18 online state.
  19
  20 Installation
  21 ============
  22
  23 Simply copy mod\_webpresence.lua to your modules directory, the image
  24 files are embedded within it. Then add "webpresence" to your
  25 modules\_enabled list.
  26
  27 Usage
  28 =====
  29
  30 Once loaded you can embed the icon into a page using a simple `<img>`
  31 tag, as follows:
  32
  33     <img src="http://prosody.example.com:5280/status/john.smith" />
  34
  35 Alternatively, it can be used to get status name as plaint text, status
  36 message as plain text or html-code for embedding on web-pages.
  37
  38 To get status name in plain text you can use something like that link:
  39 `http://prosody.example.com:5280/status/john.smith/text`
  40
  41 To get status message as plain text you can use something like following
  42 link: `http://prosody.example.com:5280/status/john.smith/message`
  43
  44 To get html code, containig status name, status image and status message
  45 (if set): `http://prosody.example.com:5280/status/john.smith/html`
  46
  47 All other
  48
  49 Compatibility
  50 =============
  51
  52   ----- -------
  53   trunk   Works
  54   0.10   Works
  55   0.9   Works
  56   0.8   Works
  57   0.7   Works
  58   0.6   Works
  59   ----- -------
  60
  61 Todo
  62 ====
  63
  64 -   Display PEP information (maybe a new plugin?)
  65 -   More (free) iconsets
  66 -   Internal/external image generator (GD, ImageMagick)