prosody-modules
f16720087ef2
mod_webpresence/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_webpresence/README.markdown @ 5588:f16720087ef2

mod_webpresence: Add opt-in mechanism.
author Trần H. Trung <work@trung.fun>
date Tue, 23 May 2023 23:45:00 +0700
parent 2734:f5005d256877
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 labels:
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
3 - 'Stage-Stable'
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
4 summary: Display your online status in web pages
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
5 rockspec:
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
6 build:
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
7 copy_directories:
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
8 - icons
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
9 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
11 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
12 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
14 Quite often you may want to publish your Jabber status to your blog or
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
15 website. mod\_webpresence allows you to do exactly this via adhoc control.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
17 Installation
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
18 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
20 Copy mod\_webpresence.lua to your modules directory then add it to your
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
21 modules\_enabled list:
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
22
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
23 ```
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
25 modules_enabled = {
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
26 "webpresence";
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
27 };
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
28
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
29 ```
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
30
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
31 Configuration & Usage
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
32 =====================
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
33
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
34 There is a set of icons supplied with the module. But you can configure it to
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
35 load your own in the config file:
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
37 ```
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
38
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
39 webpresence_icons = "/path/to/your/icons";
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
40
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
41 ```
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
42
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
43 Beware that the icon files must have the same names as the default files.
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
44
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
45 This module will always returns offline until you enable it via adhoc.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
46
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
47 You can embed the icon into a page using a simple `<img>` tag, as follows:
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
48
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
49 <img src="http://prosody.example.com:5280/status/john.smith@domain.net" />
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
51 Alternatively, it can be used to get status name as plain text, status message
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
52 as plain text or html-code for embedding on web-pages.
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
53
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
54 To get status name in plain text you can use something like this link:
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
55 `http://prosody.example.com:5280/status/john.smith@domain.net/text`
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
56
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
57 To get status message as plain text you can use something like following
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
58 link: `http://prosody.example.com:5280/status/john.smith@domain.net/message`
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
59
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
60 To get html code, containing status name, status image and status message
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
61 (if set): `http://prosody.example.com:5280/status/john.smith@domain.net/html`
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
62
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
63 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
64 =============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
65
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
66 ----- -------
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
67 trunk Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
68 0.12.3 Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
69 0.10 Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
70 0.9 Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
71 0.8 Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
72 0.7 Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
73 0.6 Works
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
74 ----- -------
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
75
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
76 Todo
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
77 ====
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
78
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
79 - Display PEP information (maybe a new plugin?)
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
80 - Internal/external image generator (GD, ImageMagick)
5588
f16720087ef2 mod_webpresence: Add opt-in mechanism.
Trần H. Trung <work@trung.fun>
parents: 2734
diff changeset
81 - Display the correct boolean in the first form.