annotate mod_muc_lang/README.markdown @ 5536:96dec7681af8

mod_firewall: Update user marks to store instantly via map store The original approach was to keep marks in memory only, and persist them at shutdown. That saves I/O, at the cost of potentially losing marks on an unclean shutdown. This change persists marks instantly, which may have some performance overhead but should be more "correct". It also splits the marking/unmarking into an event which may be watched or even fired by other modules.
author Matthew Wild <mwild1@gmail.com>
date Thu, 08 Jun 2023 16:20:42 +0100
parents 4e8b5ea7f4c2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3075
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # Introduction
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module adds support for advertising the language used in a room.
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 # Configuring
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 ``` {.lua}
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 Component "rooms.example.net" "muc"
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 modules_enabled = {
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 "muc_lang";
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 }
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 ```
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 The room language is specified in a new field in the room configuration
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 dialog, accessible through compatible clients.
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 Use [language codes](https://en.wikipedia.org/wiki/ISO_639) like `en`,
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 `fr`, `de` etc.
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 # Compatibility
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 Meant for use with Prosody 0.10.x
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 Native support was [added in Prosody
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 trunk/0.11](https://hg.prosody.im/trunk/rev/9c90cd2fc4c3), so there is
4e8b5ea7f4c2 mod_muc_lang: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26 no need for this module.