annotate mod_muc_mention_notifications/README.markdown @ 4312:33a41503b9e3

Improve UX by providing defaults users expect
author Seve Ferrer <seve@delape.net>
date Tue, 22 Dec 2020 11:27:20 +0100
parents af7297e49885
children 149ec3abf09e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4280
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
1 # Configuring
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
2
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
3 ## Enabling
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
4
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
5 ``` {.lua}
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
6 Component "rooms.example.net" "muc"
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
7 modules_enabled = {
4307
af7297e49885 muc_mention_notifications: Rename module
JC Brand <jc@opkode.com>
parents: 4280
diff changeset
8 "muc_mention_notifications";
4280
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
9 }
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
10 ```
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
11
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
12 ## Settings
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
13
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
14 |Name |Description |Default |
278f2998ce49 mod_muc_room_mention_notifications: Publish module
Seve Ferrer <seve@delape.net>
parents:
diff changeset
15 |-----|------------|--------|
4307
af7297e49885 muc_mention_notifications: Rename module
JC Brand <jc@opkode.com>
parents: 4280
diff changeset
16 |muc_mmn_notify_unaffiliated_users| Notify mentioned users even if they are not members of the room they were mentioned in | false |