| author | Kim Alvefur <zash@zash.se> |
| Sat, 23 Jun 2018 18:16:01 +0200 | |
| changeset 3149 | a3afab416271 |
| parent 3148 | be4ba474e55d |
| child 3299 | 4a77c9c2a1cd |
| permissions | -rw-r--r-- |
|
3145
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
1 |
--- |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
2 |
depends: |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
3 |
- 'mod\_http' |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
4 |
- 'mod\_muc' |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
5 |
provides: |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
6 |
- http |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 |
title: 'mod\_muc\_badge' |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 |
--- |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 |
|
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
# Introduction |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 |
|
|
3147
1f0d269a7cf0
mod_muc_badge/README: More words
Kim Alvefur <zash@zash.se>
parents:
3146
diff
changeset
|
12 |
This module generates a badge for MUC rooms at a HTTP URL like |
|
3148
be4ba474e55d
mod_muc_badge/README: Fix typo in examlpe URL
Kim Alvefur <zash@zash.se>
parents:
3147
diff
changeset
|
13 |
`https://example.com:5281/muc_badge/room@conference.example.org` |
|
3146
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
14 |
containing the number of occupants. |
|
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
15 |
|
|
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
16 |
Inspiration |
|
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
17 |
: <https://opkode.com/blog/xmpp-chat-badge/> |
|
3145
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 |
|
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 |
# Configuration |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 |
|
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
21 |
Option Type Default |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 |
------------------ -------- -------------------------- |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 |
`badge_label` string `"Chatroom"` |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 |
`badge_count` string `"%d online"` |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 |
`badge_template` string A SVG image (see source) |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 |
|
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 |
The template must be valid XML. If it contains `{label}` then this is |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 |
replaced by `badge_label`, similarly, `{count}` is substituted by |
|
774845606d73
mod_muc_badge: Generates a SVG badge with the number of occupants in rooms
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 |
`badge_count` with `%d` changed to the number of occupants. |
|
3146
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
30 |
|
|
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
31 |
Details of the HTTP URL is determined by [standard Prosody HTTP server |
|
feefc29a1ef4
mod_muc_badge/README: Fix prematurely committed text
Kim Alvefur <zash@zash.se>
parents:
3145
diff
changeset
|
32 |
configuration][doc:http]. |
|
3149
a3afab416271
mod_muc_badge/README: Add a possible future thing to do
Kim Alvefur <zash@zash.se>
parents:
3148
diff
changeset
|
33 |
|
|
a3afab416271
mod_muc_badge/README: Add a possible future thing to do
Kim Alvefur <zash@zash.se>
parents:
3148
diff
changeset
|
34 |
# TODO |
|
a3afab416271
mod_muc_badge/README: Add a possible future thing to do
Kim Alvefur <zash@zash.se>
parents:
3148
diff
changeset
|
35 |
|
|
a3afab416271
mod_muc_badge/README: Add a possible future thing to do
Kim Alvefur <zash@zash.se>
parents:
3148
diff
changeset
|
36 |
- Maybe use the room name instead of a fixed label. Would need dynamic |
|
a3afab416271
mod_muc_badge/README: Add a possible future thing to do
Kim Alvefur <zash@zash.se>
parents:
3148
diff
changeset
|
37 |
resizing. |