view mod_default_bookmarks/README.md @ 6084: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
parents fe081789f7b5
children
line wrap: on
line source

---
labels:
summary: Default bookmarked chatrooms
...

Introduction
============

This module allows you to add default bookmarks for users. It only kicks
in when the user has no existing bookmarks, so users are free to add,
change or remove them.

Details
=======

Most clients support storing a private list of room "bookmarks" on the
server. When they log in, they fetch this list and join any that are
marked as "autojoin". If this list is empty, as it would be for new
users, this module would return the list supplied in the config.

Configuration
=============

Add "default\_bookmarks" to your modules\_enabled list:

        modules_enabled = {
                   -- ...other modules here... --
                   "default_bookmarks";
                   -- ...maybe some more here... --
        }

Then add a list of the default rooms you want:

``` lua
default_bookmarks = {
    { jid = "room@conference.example.com"; name = "The Room"; autojoin = true };
    -- Specifying a password is supported:
    { jid = "secret-room@conference.example.com"; name = "A Secret Room"; password = "secret"; autojoin = true };
    -- You can also use this compact syntax:
    "yetanother@conference.example.com"; -- this will get "yetanother" as name
};
```

Compatibility
-------------

  ------- ---------------
  trunk   Works
  0.10    Should work
  0.9     Should work
  ------- ---------------