Mercurial > prosody-modules

comparison mod_webpresence/README.wiki @ 1782:29f3d6b7ad16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import wiki pages
author Kim Alvefur <zash@zash.se>
date Mon, 24 Aug 2015 16:43:56 +0200
parents
children
comparison
equal deleted inserted replaced
1781:12ac88940fe3 1782:29f3d6b7ad16
1 #summary Display your online status in web pages
2 #labels Stage-Stable
3
4 = Introduction =
5
6 Quite often you may want to publish your Jabber status to your blog or website. mod_webpresence allows you to do exactly this.
7
8 = Details =
9
10 This module uses Prosody's built-in HTTP server (it does not depend on mod_httpserver). It supplies a status icon representative of a user's online state.
11
12 = Installation =
13
14 Simply copy mod_webpresence.lua to your modules directory, the image files are embedded within it. Then add "webpresence" to your modules_enabled list.
15
16 = Usage =
17
18 Once loaded you can embed the icon into a page using a simple `<img>` tag, as follows:
19
20 {{{<img src="http://prosody.example.com:5280/status/john.smith" />}}}
21
22 Alternatively, it can be used to get status name as plaint text, status message as plain text or html-code for embedding on web-pages.
23
24 To get status name in plain text you can use something like that link: {{{http://prosody.example.com:5280/status/john.smith/text}}}
25
26 To get status message as plain text you can use something like following link: {{{http://prosody.example.com:5280/status/john.smith/message}}}
27
28 To get html code, containig status name, status image and status message (if set):
29 {{{http://prosody.example.com:5280/status/john.smith/html}}}
30
31 All other
32 = Compatibility =
33 ||0.9||Works||
34 ||0.8||Works||
35 ||0.7||Works||
36 ||0.6||Works||
37
38 = Todo =
39
40 * JSON?
41 * Display PEP information (maybe a new plugin?)
42 * More (free) iconsets
43 * Internal/external image generator (GD, ImageMagick)