Changeset

4160:9626d5d1adc4

mod_muc_inject_mentions: Update README explainig mention_delimiters setting
author Seve Ferrer <seve@delape.net>
date Mon, 28 Sep 2020 19:06:20 +0200 (2020-09-28)
parents 4159:94e3e7753220
children 4161:032e1c79d039
files mod_muc_inject_mentions/README.markdown
diffstat 1 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_muc_inject_mentions/README.markdown	Mon Sep 28 18:46:33 2020 +0200
+++ b/mod_muc_inject_mentions/README.markdown	Mon Sep 28 19:06:20 2020 +0200
@@ -51,6 +51,18 @@
 
 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