view mod_muc_inject_mentions/README.markdown @ 4160:9626d5d1adc4

mod_muc_inject_mentions: Update README explainig mention_delimiters setting
author Seve Ferrer <>
date Mon, 28 Sep 2020 19:06:20 +0200
parents e8c1b35bc25b
children 032e1c79d039
line wrap: on
line source

# Introduction

This module intercepts messages sent to a MUC, looks in the message's body if a user was mentioned and injects a mention type reference to that user implementing [XEP-0372](

## Features

1. Multiple mentions in the same message using affixes, including multiple mentions to the same user.
   `Hello nickname`  
   `@nickname hey!`  
   `nickname, hi :)`  
   `Are you sure @nickname?`  

2. Mentions are only injected if no mention was found in a message, avoiding this way, injecting mentions in messages sent from clients with mentions support.

3. Configuration settings for customizing affixes and enabling/disabling the module for specific rooms.

# Configuring

## Enabling


Component "" "muc"

modules_enabled = {


## Settings

Apart from just writing the nick of an occupant to trigger this module,
common affixes used when mentioning someone can be configured in Prosody's config file.  
Recommended affixes:

muc_inject_mentions_prefixes = {"@"} -- Example: @bob hello!
muc_inject_mentions_suffixes = {":", ",", "!", ".", "?"} -- Example: bob! How are you doing?

This module can be enabled/disabled for specific rooms.
Only one of the following settings must be set.

-- muc_inject_mentions_enabled_rooms = {""}
-- muc_inject_mentions_disabled_rooms = {""}

If none or both are found, all rooms in the muc component will have mentions enabled.

It is also possible to modify how this module detects mentions.
In short, the module will detect if a mention is actually a mention
if the nickname (with or without affixes) is between spaces, new lines, or at the beginning/end of the message.
This can be changed using:

-- muc_inject_mentions_mention_delimiters =  {" ", "", "\n"}
Generally speaking and unless the use-case is very specific, there should be no need to modify the defaults of this setting.

# Example stanzas

Alice sends the following message

<message id="af6ca" to="room@conference.localhost" type="groupchat">
    <body>@bob hey! Are you there?</body>

Then, the module detects `@bob` is a mention to `bob` and injects a mention type reference to him

<message from="room@conference.localhost/alice" id="af6ca" to="alice@localhost/ThinkPad" type="groupchat">
    <body>@bob hey! Are you there?</body>
    <reference xmlns="urn:xmpp:reference:0"