comparison mod_csi_muc_priorities/README.markdown @ 3545:c1d7e6752d18

mod_csi_muc_priorities: Add a README
author Kim Alvefur <zash@zash.se>
date Wed, 03 Apr 2019 00:03:15 +0200
parents
children 6f3e878537f4
comparison
equal deleted inserted replaced
3544:7893115bf382 3545:c1d7e6752d18
1 # Introduction
2
3 This module lets users specify which of the group chats they are in are
4 less important. This influences when
5 [mod_csi_simple][doc:modules:mod_csi_simple] decides to send
6 stanzas vs waiting until there is more to send. Users in many large
7 public channels might benefit from this.
8
9 # Configuration
10
11 The module is configured via ad-hoc an command called *Configure group
12 chat priorities* that should appear in the menus of compatible clients.
13
14 The command presents a form that accepts a list of XMPP addresses.
15 Currently there is a single priority, *Lower priority*, which is
16 suitable for e.g. noisy public channels. mod_csi_simple considers
17 groupchat messages important by default on the assumptions that smaller
18 and more important private chats are more common among most users.
19
20 A message of type groupchat from an address in this list will not be
21 considered important enough to send it to an inactive client, unless it
22 is from the current user or mentions their nickname.