Mercurial > prosody-modules

comparison mod_muc_badge/README.markdown @ 3142:feefc29a1ef4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_badge/README: Fix prematurely committed text
author Kim Alvefur <zash@zash.se>
date Sat, 23 Jun 2018 18:12:54 +0200
parents 774845606d73
children 1f0d269a7cf0
comparison
equal deleted inserted replaced
3141:774845606d73 3142:feefc29a1ef4
7 title: 'mod\_muc\_badge' 7 title: 'mod\_muc\_badge'
8 --- 8 ---
9 9
10 # Introduction 10 # Introduction
11 11
12 This module generates a badge, similar the one 12 This module generates a badge at a HTTP URL like
13 <https://opkode.com/blog/xmpp-chat-badge/> 13 `https://example.com:5281/muc_badge/roo@conference.example.org`
14 containing the number of occupants.
15
16 Inspiration
17 : <https://opkode.com/blog/xmpp-chat-badge/>
14 18
15 # Configuration 19 # Configuration
16 20
17 Option Type Default 21 Option Type Default
18 ------------------ -------- -------------------------- 22 ------------------ -------- --------------------------
21 `badge_template` string A SVG image (see source) 25 `badge_template` string A SVG image (see source)
22 26
23 The template must be valid XML. If it contains `{label}` then this is 27 The template must be valid XML. If it contains `{label}` then this is
24 replaced by `badge_label`, similarly, `{count}` is substituted by 28 replaced by `badge_label`, similarly, `{count}` is substituted by
25 `badge_count` with `%d` changed to the number of occupants. 29 `badge_count` with `%d` changed to the number of occupants.
30
31 Details of the HTTP URL is determined by [standard Prosody HTTP server
32 configuration][doc:http].