From 1a0e7d5a10f2140d05dd54531c4ba1f35768ab93 Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Fri, 13 Jul 2018 13:22:40 +0100 Subject: MUC: Improve labels of all config form items --- plugins/muc/description.lib.lua | 1 + plugins/muc/hidden.lib.lua | 3 ++- plugins/muc/history.lib.lua | 6 ++++-- plugins/muc/language.lib.lua | 3 ++- plugins/muc/members_only.lib.lua | 7 ++++--- plugins/muc/moderated.lib.lua | 5 ++++- plugins/muc/name.lib.lua | 2 +- plugins/muc/persistent.lib.lua | 3 ++- plugins/muc/request.lib.lua | 7 +++++-- plugins/muc/subject.lib.lua | 3 ++- plugins/muc/whois.lib.lua | 4 ++-- 11 files changed, 29 insertions(+), 15 deletions(-) diff --git a/plugins/muc/description.lib.lua b/plugins/muc/description.lib.lua index d7e3f7c6..eeda83d2 100644 --- a/plugins/muc/description.lib.lua +++ b/plugins/muc/description.lib.lua @@ -32,6 +32,7 @@ local function add_form_option(event) name = "muc#roomconfig_roomdesc"; type = "text-single"; label = "Description"; + desc = "A brief description of the room"; value = get_description(event.room) or ""; }); end diff --git a/plugins/muc/hidden.lib.lua b/plugins/muc/hidden.lib.lua index b2fe6216..943b0b96 100644 --- a/plugins/muc/hidden.lib.lua +++ b/plugins/muc/hidden.lib.lua @@ -22,7 +22,8 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = "muc#roomconfig_publicroom"; type = "boolean"; - label = "Make Room Publicly Searchable?"; + label = "Include room in public lists"; + desc = "Enable this to allow people to find the room"; value = not get_hidden(event.room); }); end, 100-5); diff --git a/plugins/muc/history.lib.lua b/plugins/muc/history.lib.lua index 100ab720..36b1b260 100644 --- a/plugins/muc/history.lib.lua +++ b/plugins/muc/history.lib.lua @@ -48,13 +48,15 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = "muc#roomconfig_historylength"; type = "text-single"; - label = "Maximum Number of History Messages Returned by Room"; + label = "Maximum number of history messages returned by room"; + desc = "Specify the maximum number of previous messages that should be sent to users when they join the room"; value = tostring(get_historylength(event.room)); }); table.insert(event.form, { name = 'muc#roomconfig_defaulthistorymessages', type = 'text-single', - label = 'Default Number of History Messages Returned by Room', + label = 'Default number of history messages returned by room', + desc = "Specify the number of previous messages sent to new users when they join the room"; value = tostring(get_defaulthistorymessages(event.room)) }); end, 100-10); diff --git a/plugins/muc/language.lib.lua b/plugins/muc/language.lib.lua index ae9bcfed..1c4731d7 100644 --- a/plugins/muc/language.lib.lua +++ b/plugins/muc/language.lib.lua @@ -29,8 +29,9 @@ end local function add_form_option(event) table.insert(event.form, { name = "muc#roomconfig_lang"; - label = "Language tag for Room (e.g. 'en', 'de', 'fr' etc.)"; + label = "Language tag for room (e.g. 'en', 'de', 'fr' etc.)"; type = "text-single"; + desc = "Indicate the primary language spoken in this room"; value = get_language(event.room) or ""; }); end diff --git a/plugins/muc/members_only.lib.lua b/plugins/muc/members_only.lib.lua index c9980280..b3bcdd8b 100644 --- a/plugins/muc/members_only.lib.lua +++ b/plugins/muc/members_only.lib.lua @@ -64,7 +64,7 @@ module:hook("muc-disco#info", function(event) event.reply:tag("feature", {var = get_members_only(event.room) and "muc_membersonly" or "muc_open"}):up(); table.insert(event.form, { name = "{http://prosody.im/protocol/muc}roomconfig_allowmemberinvites"; - label = "Allow members to invite new members?"; + label = "Allow members to invite new members"; type = "boolean"; value = not not get_allow_member_invites(event.room); }); @@ -75,13 +75,14 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = "muc#roomconfig_membersonly"; type = "boolean"; - label = "Make Room Members-Only?"; + label = "Only allow members to join"; + desc = "Enable this to only allow access for room owners, admins and members"; value = get_members_only(event.room); }); table.insert(event.form, { name = "{http://prosody.im/protocol/muc}roomconfig_allowmemberinvites"; type = "boolean"; - label = "Allow members to invite new members?"; + label = "Allow members to invite new members"; value = get_allow_member_invites(event.room); }); end, 100-6); diff --git a/plugins/muc/moderated.lib.lua b/plugins/muc/moderated.lib.lua index 8354c585..1087e2c4 100644 --- a/plugins/muc/moderated.lib.lua +++ b/plugins/muc/moderated.lib.lua @@ -26,7 +26,8 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = "muc#roomconfig_moderatedroom"; type = "boolean"; - label = "Make Room Moderated?"; + label = "Moderated (require permission to speak)"; + desc = "In moderated rooms occupants must be given permission to speak by a room moderator"; value = get_moderated(event.room); }); end, 100-4); @@ -40,6 +41,8 @@ end); module:hook("muc-get-default-role", function(event) if event.affiliation == nil then if get_moderated(event.room) then + -- XEP-0045: + -- An implementation MAY grant voice by default to visitors in unmoderated rooms. return "visitor" end end diff --git a/plugins/muc/name.lib.lua b/plugins/muc/name.lib.lua index 38d7b27e..37fe1259 100644 --- a/plugins/muc/name.lib.lua +++ b/plugins/muc/name.lib.lua @@ -24,7 +24,7 @@ local function insert_name_into_form(event) table.insert(event.form, { name = "muc#roomconfig_roomname"; type = "text-single"; - label = "Name"; + label = "Title"; value = event.room._data.name; }); end diff --git a/plugins/muc/persistent.lib.lua b/plugins/muc/persistent.lib.lua index 4bc61930..0f787759 100644 --- a/plugins/muc/persistent.lib.lua +++ b/plugins/muc/persistent.lib.lua @@ -22,7 +22,8 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = "muc#roomconfig_persistentroom"; type = "boolean"; - label = "Make Room Persistent?"; + label = "Persistent (room should remain even when it is empty)"; + desc = "Rooms are automatically deleted when they are empty, unless this option is enabled"; value = get_persistent(event.room); }); end, 100-3); diff --git a/plugins/muc/request.lib.lua b/plugins/muc/request.lib.lua index d7fa9426..1bf02e55 100644 --- a/plugins/muc/request.lib.lua +++ b/plugins/muc/request.lib.lua @@ -25,16 +25,18 @@ local voice_request_form = require "util.dataforms".new({ name = "muc#jid"; type = "jid-single"; label = "User ID"; + desc = "The user's JID (address)"; }, { name = "muc#roomnick"; type = "text-single"; - label = "Room Nickname"; + label = "Room nickname"; + desc = "The user's nickname within the room"; }, { name = "muc#role"; type = "list-single"; - label = "Requested Role"; + label = "Requested role"; value = "participant"; options = { "none", @@ -47,6 +49,7 @@ local voice_request_form = require "util.dataforms".new({ name = "muc#request_allow"; type = "boolean"; label = "Grant voice to this person?"; + desc = "Specify whether this person is able to speak in a moderated room"; value = false; } }); diff --git a/plugins/muc/subject.lib.lua b/plugins/muc/subject.lib.lua index 56d8d174..3b4efaf7 100644 --- a/plugins/muc/subject.lib.lua +++ b/plugins/muc/subject.lib.lua @@ -41,7 +41,8 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = "muc#roomconfig_changesubject"; type = "boolean"; - label = "Allow Occupants to Change Subject?"; + label = "Allow anyone to set the room's subject"; + desc = "Choose whether anyone, or only moderators, may set the room's subject"; value = get_changesubject(event.room); }); end, 100-8); diff --git a/plugins/muc/whois.lib.lua b/plugins/muc/whois.lib.lua index 4acf288c..ec3114eb 100644 --- a/plugins/muc/whois.lib.lua +++ b/plugins/muc/whois.lib.lua @@ -32,9 +32,9 @@ module:hook("muc-config-form", function(event) table.insert(event.form, { name = 'muc#roomconfig_whois', type = 'list-single', - label = 'Who May Discover Real JIDs?', + label = 'Addresses (JIDs) of room occupants may be viewed by:', value = { - { value = 'moderators', label = 'Moderators Only', default = whois == 'moderators' }, + { value = 'moderators', label = 'Moderators only', default = whois == 'moderators' }, { value = 'anyone', label = 'Anyone', default = whois == 'anyone' } } }); -- cgit v1.2.3