view mod_csi_muc_priorities/README.markdown @ 4719:5a06c711649c

mod_bookmarks2: Use max_items='max' on trunk, with fallback check_node_config() throws an error attempting to compare the pep_max_items number with the 'max' string, which allows detecting and support using 'max' where available. Unsure what happens when you upgrade, that seems a problem for a future commit! :)
author Kim Alvefur <zash@zash.se>
date Wed, 20 Oct 2021 22:16:14 +0200
parents 562d3b219876
children
line wrap: on
line source

# Introduction

This module lets users specify which of the group chats they are in are
less important. This influences when
[mod_csi_simple][doc:modules:mod_csi_simple] decides to send
stanzas vs waiting until there is more to send. Users in many large
public channels might benefit from this.

# Configuration

The module is configured via ad-hoc an command called *Configure group
chat priorities* that should appear in the menus of compatible clients.

The command presents a form that accepts a list of XMPP addresses.
Currently there is a single priority, *Lower priority*, which is
suitable for e.g. noisy public channels. mod_csi_simple considers
groupchat messages important by default on the assumptions that smaller
and more important private chats are more common among most users.

A message of type groupchat from an address in this list will not be
considered important enough to send it to an inactive client, unless it
is from the current user or mentions of their nickname. **Note** that
mention support require the separate module [mod_track_muc_joins]
to also be loaded.

``` {.lua}
modules_enabled = {
    -- other modules etc

    "csi_simple",
    "csi_muc_priorities",
    "track_muc_joins", -- optional
}
```