Annotate

mod_muc_lang/README.md @ 6112:4c0e3fe57e92

mod_compliance_latest: Gracefull error logging on missing dependency. diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md --- a/mod_compliance_latest/README.md +++ b/mod_compliance_latest/README.md @@ -9,13 +9,15 @@ rockspec: # Introduction -This module will always require and load to the lastest compliance tester we have in the community modules. -Currently this is [mod_compliance_2023]. +This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules. +Currently this is [mod_compliance_2023]. See the linked module for further details. + +If you do not use the *Prosody plugin installer* this module will likely have limited value to you. +You can also just install the current compliance tester manually. # Configuration -Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer. -See the linked module for further details. +Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*. # Compatibility diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua --- a/mod_compliance_latest/mod_compliance_latest.lua +++ b/mod_compliance_latest/mod_compliance_latest.lua @@ -1,1 +1,6 @@ -module:depends("compliance_2023"); +local success, err = pcall(function() module:depends("compliance_2023") end) + +if not success then + module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?") + return 1, "Error: Couldn't load dependency mod_compliance_2023." +end
author Menel <menel@snikket.de>
date Mon, 23 Dec 2024 12:58:03 +0100
parent 6003:fe081789f7b5
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.