[AB-xxx] updating documentation

abstracto-application/documentation/src/main/docs/asciidoc/modules/core.adoc

@@ -23,16 +23,16 @@ This information includes a short description, a more detailed description, alia
 and which effects a command has.
 Changing the system configuration::
 * Usage `setConfig <key> <value>`
-* Slash command: `config set`
+* Slash command: `config set <key> <value>`
 * Description: Changes the value of this configuration identified by `key` to `value`. Some of these configurations have separate specific commands, but this works in general.
 * Example: `setConfig expMin 15` to set the minimum experience to 15
 Resetting the configuration to default values::
 * Usage `resetConfig [key/feature]`
-* Slash command: `config reset`
+* Slash command: `config reset [key/feature>`
 * Description: Resets the configuration of the given `key` or for the complete feature identified by `feature`. If this is not provided, it will reset the entire server to the default configuration.
 Changing emotes the bot uses::
 * Usage: `setEmote <key> <emote>`
-* Slash command: `config setemote`
+* Slash command: `config setemote <emotekey> <emote>`
 * Description: Sets the emote identified by `key` used by the bot on this server to `emote`.
 This allows both built in emotes and custom emotes, but the bot must be in the server of the custom emote in order to use them.
 Clearing the cache::
@@ -44,25 +44,25 @@ Ping::
 * Slash command: `ping`
 * Description: Prints the gateway ping of the bot to the Discord servers.
 Echo::
-* Usage: `echo <text> [targetChannel]`
-* Slash command: `echo`
+* Usage: `echo <text>`
+* Slash command: `echo <teyt> [targetchannel]`
 * Description: Echos `text` in the same channel this command as executed in. The slash command offers the ability to provide a `targetChannel`.
 Changing the prefix::
 * Usage: `setPrefix <prefix>`
 * Description: Changes the prefix of the bot in this guild to `prefix`. This can be one or multiple characters.
 Changing a post target::
-* Usage: `posttarget <name> <channel>`
-* Slash command: `posttarget posttarget`
+* Usage: `posttarget [name] [channel]`
+* Slash command: `posttarget posttarget [name] [channel>`
 * Description: Changes the given post target identified by `name` to `channel`. All messages using this post target will be sent to this channel from now on.
 If neither `name` nor `channel` is given, this will print the currently available post targets and the channels they point to, if set.
 * Example: `posttarget banLog #general` to log the bans in the #general channel.
 Disabling a post target::
-* Usage: `disablePostTarget <key>`
-* Slash command: `posttarget diable`
+* Usage: `disablePostTarget <name>`
+* Slash command: `posttarget diable <name>`
 * Description: Disables the post target identified by `key` to not send any messages towards. Some features require a post target to be enabled, and have the option to throw an exception, others might just ignore it.
 Enabling a post target::
-* Usage: `enablePostTarget <key>`
-* Slash command: `posttarget enable`
+* Usage: `enablePostTarget <name>`
+* Slash command: `posttarget enable <name>`
 * Description: Enables the post target identified by `key` to not send any messages towards.
 Changing admin mode::
 * Usage: `setAdminMode <true/false>`
@@ -72,57 +72,59 @@ Listing the features::
 * Slash command: `feature list`
 * Description: Lists the available features and whether they are enabled in this server.
 Enabling a feature::
-* Usage: `enableFeature <key>`
-* Slash command: `feature enable`
+* Usage: `enableFeature <featurename>`
+* Slash command: `feature enable <featurename>`
 * Description: Enables the feature identified by `key` in this server. If the feature dependents on other features, they will be enabled as well. Any configuration which requires setup will be listed. In order to start a configuration wizard execute the command `setupFeature`.
 * Example: `enableFeature moderation` to enable the moderation feature
 Setting up a feature with an interactive wizard::
 * Usage: `setupFeature <featureName>`
 * Description: Starts an interactive wizard to configure the necessary configuration of a feature. Closes with a summary page to see all changes.
 Disabling a feature::
-* Usage: `disableFeature <key>`
-* Slash command: `feature disable`
+* Usage: `disableFeature <featurename>`
+* Slash command: `feature disable <featurename>`
 * Description: Disables the feature identified by `key` in this server. If the feature is required for other features, they will be disabled as well.
 * Example: `disableFeature moderation` to disable the moderation feature
 Enabling a feature mode::
-* Usage: `enableMode <featureName> <mode>`
-* Slash command: `feature enablemode`
+* Usage: `enableMode <feature> <mode>`
+* Slash command: `feature enablemode <feature> <mode>`
 * Description: Enables the mode `mode` in feature `featureName`. If the mode followed default configuration previously, it will not anymore after executing this command.
 Disabling a feature mode::
-* Usage: `disableMode <featureName> <mode>`
-* Slash command: `feature disablemode`
+* Usage: `disableMode <feature> <mode>`
+* Slash command: `feature disablemode <feature> <mode>`
 * Description: Disables the mode `mode` in feature `featureName`. If the mode followed default configuration previously, it will not anymore after executing this command.
 Listing all feature modes::
 * Usage `featureModes [feature]`
-* Slash command: `feature featuremodes`
+* Slash command: `feature featuremodes [feature]`
 * Description: Lists all the currently available feature modes and the feature they are associated with. If `feature` is given, it only lists the feature modes of this feature. The output also includes whether it is enabled and if this value comes from the default configuration.
 Creating a channel group::
 * Usage: `createChannelGroup <key>`
-* Slash command: `channels createchannelgroup`
+* Slash command: `channels createchannelgroup <name> <grouptype>`
 * Description: Creates a new channel group identified by `key`. There are different types of channel groups, depending on the features available. Per default `command` and `commandCoolDown` are available.
 * Aliases: `+ChGroup`
 
 Disabling a channel group::
 * Usage: `disableChannelGroup <channelGroupName>`
+* Slash command: `channels disablechannelgroup <channelgroupname>`
 * Description: Disables the effect the channel group `channelGroupName` has.
 Enabling a channel group::
 * Usage: `enableChannelGroup <channelGroupName>`
+* Slash command: `channels enablechannelgroup <channelgroupname>`
 * Description: Enables the effect the channel group `channelGroupName` has.
 Adding a channel to a channel group::
 * Usage: `addToChannelGroup <groupName> <channel>`
-* Slash command: `channels addtochannelgroup`
+* Slash command: `channels addtochannelgroup <name> <channel>`
 * Description: Adds the `channel` to the channel group identified by the `groupName`. It is not possible for a channel to be in a group twice.
 * Aliases: `addTChGrp`, `chGrpCh+`
 * Example: `addToChannelGroup group1 #general` to add the channel #general to the group `group1`
 Removing a channel from a channel group::
-* Usage: `removeFromChannelGroup <groupName> <channel>`
-* Slash command: `channels removefromchannelgroup`
-* Description: Removes the `channel` from the channel group identified by `groupName`.
+* Usage: `removeFromChannelGroup <name> <channel>`
+* Slash command: `channels removefromchannelgroup <name> [channel_channel/channel_string]`
+* Description: Removes the `channel` from the channel group identified by `groupName`. The second parameter for slash command is used to either use a mention for `channel_channel` or the ID of the channel using `channel_string`.
 * Aliases: `rmChChgrp`, `chGrpCh-`
 * Example: `removeFromChannelGroup group1 #general` to remove the channel #general from the group `group1`
 Deleting a channel group::
-* Usage: `deleteChannelGroup <key>`
-* Slash command: `channels deletechannelgroup`
+* Usage: `deleteChannelGroup <name>`
+* Slash command: `channels deletechannelgroup <name>`
 * Description: Deletes the channel group identified by `key`. This will also remove all associated channels from this group. This command fails, if the group is used in other features and referenced.
 * Aliases: `-ChGroup`
 Showing all available channel groups::
@@ -146,12 +148,12 @@ Removing role restrictions from a command::
 * Description: Allows everyone to execute all commands in this `feature`/the `command`. Which means, any restrictions concerning which role is able to execute a certain command is ignored even if it still configured.
 Make a role affected by a command::
 * Usage: `makeAffected <effect> <role>`
-* Slash command: `config makeaffected`
+* Slash command: `config makeaffected <effect> <role>`
 * Description: Makes the `role` affected by the `effect`.
 * Example: `makeAffected ban @Staff` in order to the role `Staff` can be banned (where @Staff is a role mention)
 Make a role immune against a command::
 * Usage: `makeImmune <effect> <role>`
-* Slash command: `config makeimmune`
+* Slash command: `config makeimmune <effect> <role>`
 * Description: Makes the `role` immune to `effect`.
 * Example: `makeImmune ban @Staff` in order to the role `Staff` cannot be banned (where @Staff is a role mention)
 Show all effects::
@@ -168,19 +170,19 @@ Disallow the bot to use certain mentions::
 This change takes immediate effect and is only for the current server. Per default everyone/here mentions are disabled. This configuration can be overwritten on a template base.
 Setting a custom template for this server::
 * Usage: `setTemplate <templateKey>`
-* Slash command: `internal settemplate`
+* Slash command: `internal settemplate <templatekey> <file>`
 * Description: Adds or updates the given template identified by `templateKey` only for the current server. The content of the template needs to be attached to the message as a file and is required to be a plaintext file. The file can be named anything. The template needs to be in https://freemarker.apache.org/[Freemarker] format. This change is only in effect for this server and is called a 'customized template'. This will take effect immediately.
 Retrieving the current default template::
 * Usage: `getTemplate <templateKey>`
-* Slash command: `internal gettemplate`
+* Slash command: `internal gettemplate <templatekey>`
 * Description: Loads the current global template identified by `templateKey` and returns the content as an attached file.
 Retrieving the current customized template for this server::
 * Usage: `getCustomTemplate <templateKey>`
-* Slash command: `internal getcustomtemplate`
+* Slash command: `internal getcustomtemplate <templateKey>`
 * Description: Loads the current customized template identified by `templateKey` and returns the content as an attached file.
 Resetting a customized template to the default template::
 * Usage `resetTemplate <templateKey>`
-* Slash command: `internal resettemplate`
+* Slash command: `internal resettemplate <templateKey>`
 * Description: Resets the template identified by `templateKey` to the default content.
 Show a link to documentation::
 * Usage `documentation`
@@ -194,11 +196,11 @@ Delete a server specific alias::
 * Description: Deletes the server specific alias identified by `alias`. It is not possible to delete built-in aliases.  Requires you to confirm the command.
 Creating a profanity group::
 * Usage: `createProfanityGroup <profanityGroupName>`
-* Slash command: `profanity createprofanitygroup`
+* Slash command: `profanity createprofanitygroup <profanityGroupName>`
 * Description: Creates a profanity group with the given `profanityGroupName`. This name must be unique within the server.
 Adding a profanity regex to a profanity group::
 * Usage: `addProfanityRegex <profanityGroupName> <profanityName> <regex> [replacement]`
-* Slash command: `profanity addprofanityregex`
+* Slash command: `profanity addprofanityregex <profanityGroupName> <profanityName> <regex> [replacement]`
 * Description: Adds a profanity regex `profanityName` to the profanity group `profanityGroupName`. The regex to be used is in `regex`. Depending on how the regex is used, you can define a `replacement`, with which a found text can be replaced. The `profanityName` must be unique within the profanity group.
 Show the current profanity configuration::
 * Usage: `showProfanityConfig`
@@ -206,11 +208,11 @@ Show the current profanity configuration::
 * Description: Shows the current profanity configuration for the current server, including all profanity groups and profanity regex.
 Removing a profanity regex from a profanity group::
 * Usage: `removeProfanityRegex <profanityGroupName> <profanityName>`
-* Slash command: `profanity removeprofanityregex`
+* Slash command: `profanity removeprofanityregex <profanityGroupName> <profanityName>`
 * Description: Removes the profanity regex `profanityName` from the profanity group `profanityGroupName`.
 Deleting a profanity group::
 * Usage: `deleteProfanityGroup <profanityGroupName>`
-* Slash command: `profanity deleteprofanitygroup`
+* Slash command: `profanity deleteprofanitygroup <profanityGroupName>`
 * Description: Deletes the profanity group identified by `profanityGroupName` and all profanity regexes within.
 Showing the uptime of the bot::
 * Usage: `uptime`
@@ -240,12 +242,12 @@ Setting the global cooldown for a command::
 * Usage: `commandCoolDownServer <command> <duration>`
 * Description: Sets the cooldown for command `command` to `duration` for the whole server.
 Setting the cooldown which is applied to every member in a server for a specific command::
-* Usage: `setCommandMemberCooldown <command> <duration>`
-* Slash command: `cooldown commandmember set`
+* Usage: `setCommandMemberCooldown <commandName> <duration>`
+* Slash command: `cooldown commandmember set <commandName> <duration>`
 * Description: This causes the command to only be executable every `<duration>` by each specific member. This means, that member B can execute the command after member A, but is restricted after doing so.
 Removing the cooldown which is applied to every member in a server for a specific command::
 * Usage: `removeCommandMemberCooldown <commandName>`
-* Slash command: `cooldown commandmember remove`
+* Slash command: `cooldown commandmember remove <commandName>`
 * Description: This removes the cooldown which is applied for every member, if that member executes a command.
 
 .What is a channel group?

abstracto-application/documentation/src/main/docs/asciidoc/modules/experience.adoc

@@ -27,18 +27,18 @@ Currently, members only have their highest earned role assigned.
 
 ==== Commands
 Changing the experience scale of the server::
-* Usage: `expScale <value>`
-* Slash command: `experienceconfig expscale`
+* Usage: `expScale <scale>`
+* Slash command: `experienceconfig expscale <scale>`
 * Description: Changes the value of `expScale` on this server to `value`.
 
 Showing the current rank of a user::
 * Usage: `rank [member]`
-* Slash command: `experience rank`
+* Slash command: `experience rank [member]`
 * Description: Shows the experience amount, level, message count, experience until next level, server rank and level progress of the executing user, or the user provided as a parameter.
 
 Showing the leaderboard of the server::
 * Usage: `leaderboard [page]`
-* Slash command: `experience leaderboard`
+* Slash command: `experience leaderboard [page]`
 * Description: Shows the leaderboard of the server in a paginated format.
 If no parameter is provided, it will show message count, level, experience and rank of the top 10 members.
 Additionally, the same information for the executing user is shown, regardless whether the user is already shown on the given leader board page.
@@ -53,7 +53,7 @@ A status image indicating the progress will be shown. It will not award this rol
 * Example: `setExpRole 50 @HighLevel` in order to award the role `HighLevel` at level `50` (the @HighLevel is a role mention)
 
 Syncing the roles of the members with the configuration::
-* Usage: `syncRoles`
+* Usage: `syncExpRoles`
 * Description: Recalculates the appropriate levels for all users on the server and awards the roles appropriate for the level.
 There will be a message indicating the current status of the progress, and it is highly advised to not execute this command while another instance is still processing. Requires you to confirm the command.
 This command can run for a longer period of time, depending on the amount of members in the guild.
@@ -65,13 +65,13 @@ This will provide a status update message displaying the process.
 
 Disable experience gain for a certain role::
 * Usage: `disableExpForRole <role>`
-* Slash command: `experienceconfig disableexpforrole`
+* Slash command: `experienceconfig disableexpforrole <role>`
 * Description: Disables any experience gain for members with this role. They will not gain any experience until the role is removed or it is possible for the role to gain experience again.
 If a member has *any* role of the ones for which experience is disabled, the member will not gain experience. This command has a slash command
 
 Enable experience gain for a certain role::
 * Usage: `enableExpForRole <role>`
-* Slash command: `experienceconfig enableexpforrole`
+* Slash command: `experienceconfig enableexpforrole <role>`
 * Description: Enables experience gain for `role`.
 
 List roles for which experience gain is disabled::
@@ -82,12 +82,12 @@ List roles for which experience gain is disabled::
 
 Disable experience gain for a specific member::
 * Usage: `disableExpGain <member>`
-* Slash command: `exeprienceconfig disableexpgain`
+* Slash command: `exeprienceconfig disableexpgain <member>`
 * Description: Disables experience gain fpr `member`.
 
 Enable experience gain for a specific member::
 * Usage: `enableExpGain <member>`
-* Slash command: `experienceconfig enableexpgain`
+* Slash command: `experienceconfig enableexpgain <member>`
 * Description: Enables experience gain for `member`.
 
 Show the currently configured experience roles in the server::
@@ -97,13 +97,13 @@ Show the currently configured experience roles in the server::
 
 Toggle the level up notification::
 * Usage: `expLevelUpNotification <newValue>`
-* Slash command: `experience explevelupnotification`
+* Slash command: `experience explevelupnotification <newValue>`
 * Description: Toggles for the executing user, if they receive level up notifications. Only `true` really enables the notification, any other value disables the notification.
 * Mode Restriction: This command is only available when the feature mode `levelUpNotification` is enabled.
 
 Add a level action::
 * Usage: `addLevelAction <action> <level> <parameter> [member]`
-* Slash command: `experienceconfig levelAction add`
+* Slash command: `experienceconfig levelAction add <action> <level> <parameter> [member]``
 * Description: Adds an `action` to be executed at `level` with the given `parameter`. If a `member` is provided, the action is restricted to be executed for only this member. The parameters `action` uses auto complete to show the currently available actions. The combination of `action`, `level` and `member` (if provided), is considered unique. If such a combination already exists, an error is shown. Each action then requires a different `parameter` passed. The actions `add_member_to_channel_above_level` and `remove_member_from_channel_above_level` require a channel mention/name/id, and `add_role_above_level` and `remove_role_above_level` require a role mention/name/id.
 * Mode Restriction: This command is only available when the feature mode `levelAction` is enabled.
 
@@ -115,7 +115,7 @@ Viewing the current configured level actions::
 
 Removing a level action::
 * Usage: `removeLevelAction <action> <level> [member]`
-* Slash command:  `experienceconfig levelAction remove`
+* Slash command:  `experienceconfig levelAction remove <action> <level> [member]`
 * Description: Removes an action to be executed at a certain level. Such an action is identified by a combination of `action`, `level` and optionally `member`. If no identifiable combination is found, an error is shown.
 * Mode Restriction: This command is only available when the feature mode `levelAction` is enabled.
 

abstracto-application/documentation/src/main/docs/asciidoc/modules/moderation.adoc

@@ -12,32 +12,31 @@ This feature contains various generic utilities like kicking and banning.
 ==== Commands
 Ban a member::
 * Usage: `ban <user> <reason> [deletionDuration]`
-* Slash command: `moderation ban`
+* Slash command: `moderation ban <reason> [user_user/user_string] [deletionDuration]`
 * Description:
 Bans `user` with the given `reason`. This sends a logging message to the `banLog` post target.
 Per default no messages are deleted, you can pass a duration in the parameter `deletionDuration`
-It is also possible to ban users via ID, if they are not part of the server anymore. When using the slash command, the parameter `user_user` enables you to mention the user, and `user_string` serves as the input for the user ID.
-* Example: `ban @Member bad` in order to ban `Member` with the reason `banned` (the @Member is a user mention)
+It is also possible to ban users via ID using the slash command, if they are not part of the server anymore. When using the slash command, the parameter `user_user` enables you to mention the user, and `user_string` serves as the input for the user ID. This command is slash command only.
 * Required bot permission: `BAN_MEMBERS`
 Unban a user::
-* Usage: `unBan <userId>`
-* Slash command: `moderation unBan`
-* Description: Un-bans the given user with the id `userId`.
+* Usage: `unBan <user>`
+* Slash command: `moderation unBan <user>`
+* Description: Un-bans the given user with the id provided in `userId`.
 * Required bot permission: `BAN_MEMBERS`
 Kick a member::
 * Usage: `kick <member> [reason]`
-* Slash command: `moderation kick`
+* Slash command: `moderation kick <member> [reason]`
 * Description: Kicks the `member` from the guild with the given `reason`. If the `reason` is not provided, a default reason is used.
 * Example: `kick @Member bad` in order to kick `Member` with the reason `bad` (the @Member is a user mention)
 * Required bot permission: `KICK_MEMBERS`
 Change slowmode in a channel::
 * Usage: `slowmode <duration> [channel]`
-* Slash command: `moderation slowmode`
+* Slash command: `moderation slowmode <duration> [channel]`
 * Description: This command sets the slow mode in the `channel` to the given `duration`. This command uses duration parsing. The `channel` is optional and if none is provided, the current channel is used.
 * Example: `slowMode 1h2m3s #general` in order to set the slow mode in channel `general` to 1 hour 2 minutes and 3 seconds (the #general is a channel mention)
 Purging messages in a channel::
-* Usage: `purge <messageCount> [member]`
-* Slash command: `moderation purge`
+* Usage: `purge <amount> [member]`
+* Slash command: `moderation purge <amount> [member]`
 * Description: Deletes the last `messageCount` messages in the current channel. If a `member` is provided as parameter, only messages by this member
 will be deleted. The deletion of this messages will *not* be logged by the logging mechanism. The messages to be deleted need to be from within the last 2 weeks, but there is no limit on how much messages can be deleted besides that.
 While the command is ongoing, a status update message will be shown indicating how far the command is. This message will be deleted after the command is done.
@@ -59,14 +58,14 @@ Feature key: `warnings`
 
 ==== Commands
 Warn a user::
-* Usage: `warn <member> [reason]`
-* Slash command: `warnings create`
+* Usage: `warn <user> [reason]`
+* Slash command: `warnings create <user> [reason]`
 * Description: Warns the `member` with the given `reason` or a default one, if none is provided. This command sends a log message to the `warnLog` post
 target and notifies the member about the warning.
 * Example: `warn @Member bad` in order to warn `Member` with the reason `bad` (the @Member is a user mention)
 Listing the warnings of users::
-* Usage: `warnings [member]`
-* Slash command: `warnings list`
+* Usage: `warnings [user]`
+* Slash command: `warnings list [user]`
 * Description: If no `member` is provided displays all the warnings on the server. If a `member` is provided, will only display the warnings of the user.
 This uses a paginated output, which means multiple pages in case there are more warnings to display. This will also display the date the warning was decayed if applicable.
 Showing your warnings::
@@ -79,7 +78,7 @@ Decaying all warnings regardless of the date::
 * Description: This will cause all warnings of this server which are not decayed yet to be decayed instantly. Requires you to confirm the command.
 Deleting a warning::
 * Usage: `deleteWarning <warnId>`
-* Slash command: `warnings delete`
+* Slash command: `warnings delete <warnId>`
 * Description: Deletes the warning identified by `warnId` completely from the database.
 
 
@@ -120,15 +119,18 @@ Feature key `muting`
 
 ==== Commands
 Muting a user::
-* Usage: `mute <member> <duration> [reason]`
+* Usage: `mute <user> <duration> [reason]`
+* Slash command: `mute create <user> <duration> [reason]`
 * Description: Timeouts the given `member` for the given `duration`. If `reason` is not provided, a default reason will be used for logging in the `muteLog` post target. This will automatically un-mute the user after the duration has passed. If the un-mute happens automatically, this will also be logged in the `muteLog` post target.
 This command sends a notification to the user about the mute.
 * Example: `mute @Member 1h2m3s muted` in order to mute the member `Member` for 1 hour 2 minutes and 3 seconds with the reason `muted` (the @Member is a user mention)
 Un-Muting a user::
-* Usage: `unMute <member>`
+* Usage: `unMute <user>`
+* Slash command: `mute remove <user>`
 * Description: Removes the mute role from `member`. This does *not* log the un-mute.
 Showing all mutes::
 * Usage: `mutes [member]`
+* Slash command: `mute list [member]`
 * Description: Shows all the mutes in a paginated matter with buttons to navigate the pages. If `member` is provided, it will only show mutes for this member.
 
 === Logging
@@ -159,14 +161,17 @@ This feature provides the ability to store specific notes for members in the dat
 ==== Commands
 Creating a user note::
 * Usage: `userNote <user> <text>`
+* Slash command: `usernote create <user> <text>`
 * Description: Creates a single user note for the specified user.
 
 Deleting a user note::
 * Usage: `deleteNote <id>`
+* Slash command: `usernote delete <id>`
 * Description: Deletes the user note identified by its ID. The ID can be retrieved by the command `userNotes`.
 
 Retrieving user notes::
 * Usage: `userNotes [user]`
+* Slash command: `usernote list [user]`
 * Description: If `user` is not provided, this will list the user notes of the whole server, if `user` is provided, this will only list user notes from this particular `user`.
 
 === Invite filter
@@ -276,6 +281,12 @@ This functionality just behaves to track general infractions of users, be it thr
 ==== Post targets
 `infractionNotification`:: target for notifications of infraction level changes
 
+==== Commands
+List infractions::
+* Usage: `infractions [user]`
+* Slash command: `infractions list [user_user/user_string]`
+* Description: Shows the infractions of the provided `user`, or all if no `user` is provided. For the slash command you can provide a user mention via `user_user` or an ID via `user_string`.
+
 ==== Relevant system configuration
 `infractionLevels`:: The amount of infraction levels which should be possible to configure. Default: 5
 `infractionLevel`:: This system config key acts as a prefix up until the amount of infraction levels. With this you can configure the amount of points necessary to reach the given level: For example `infractionLevel2` would be the amount of points necessary to reach level 2. These levels are not enforced to be ordered nor if all levels have a value assigned to it. Any level evaluation will stop at the first level not defined. Per default, the levels are 10, 20, 30, 40, and 50.

abstracto-application/documentation/src/main/docs/asciidoc/modules/modmail.adoc

@@ -1,36 +1,37 @@
 === Mod mail
 
+Feature key: `modmail`
+
 This feature enables users to contact the moderation of the server in a private manner. This can be initiated by messaging the bot.
 The messages, in the channel which is created to contain the mod mail thread, are not automatically sent to the user, but only when using the commands
 `reply` or `anonReply`. Any other message is ignored with the intention of enabling discussions within the channel. In case the message of a message sent to the user
-needs to be updated or deleted, you can do simply by editing/deleting the message containing the command.
-
-Feature key: `modmail`
+needs to be updated or deleted, you can do simply by editing/deleting the message containing the command. This channel can also be a thread in a special feature mode `threadContainer`.
 
 ==== Necessary bot permissions
-`MANAGE_CHANNEL` to create the channels representing the mod mail threads
+`MANAGE_CHANNEL` to create the channels representing the mod mail threads (if feature mode is not `threadContainer`)
 
 ==== Workflow
 * User messages the bot
 * If the bot is active in multiple servers with mod mail enabled, the user is prompted to which server they want to open a mod mail thread for.
-* A channel in the mod mail category is created for the user and notification is sent that a new mod mail thread has been opened
-* User can send messages in the private channel and they get relayed to this created text channel.
+* A channel/thread in the mod mail category/channel is created for the user and notification is sent that a new mod mail thread has been opened
+* User can send messages in the private channel and they get relayed to this created channel/thread
 * Moderators can answer in the thread with the commands
-* Moderators close the thread
-* The interactions between the user and the moderators gets logged in the mod mail logging channel
+* Moderators close the mod mail thread
+* Optionally: The interactions between the user and the moderators gets logged in the mod mail logging channel
 
 ==== Relevant system configuration
-`modmailCategory`:: The category on the server which is used to hold the text channels representing the threads
-
+`modmailCategory`:: The category on the server which is used to hold the text channels representing the threads. Not relevant when feature mode `threadContainer` is enabled
 `modMailClosingText`:: The text being used when notifying the user when a thread is closed.
 
 ==== Post targets
 `modmailPing`:: Will be used to send the notification when a new thread is opened.
 `modmailLog`:: Will be used to log the interactions when a thread is closed.
+`modmailContainer`:: Will be used to create threads in when feature mode `threadContainer` is enabled.
 
 ==== Feature modes
-`log`:: If this is enabled, the messages should be logged into the `modmailLog` post target when the thread is closed (by the respective commands). Makes the command `closeNoLog` available. Enabled by default.
-`threadMessage`:: If this is enabled, every message which is sent via the commands `reply` and `anonReply` will also be sent to the thread in order to have a visualizer how the message looks and to have a clear indication which messages were sent. Enabled by default.
+`log`:: If enabled, the messages should be logged into the `modmailLog` post target when the thread is closed (by the respective commands). Makes the command `closeNoLog` available. Enabled by default.
+`threadMessage`:: If enabled, every message which is sent via the commands `reply` and `anonReply` will also be sent to the thread in order to have a visualizer how the message looks and to have a clear indication which messages were sent. Enabled by default.
+`threadContainer`:: If enabled, the bot uses threads instead of channels to facilitate communication. This requires the post target `modmailContainer` to function correctly. This feature mode changes the functionality of the closing process: if a mod mail thread is closed, this will archive thread instead of logging the contents. Disabled by default.
 
 ==== Emotes
 * `readReaction` to indicate to the user that the message sent was processed
@@ -38,7 +39,7 @@ Feature key: `modmail`
 ==== Commands
 Opening a mod mail thread for a user::
 * Usage: `contact <member>`
-* Description: Creates a new mod mail thread with the `member`. Does not send a notification about the new thread.
+* Description: Creates a new mod mail thread with the `member` and does not send a notification about the new thread. This will send a message linking to the existing mod mail thread, if there already exists one.
 Adding a role to the roles responsible for managing mod mail threads::
 * Usage: `setModMailRole <role>`
 * Description: Adds this role to the roles responsible for mod mail threads, which means: this role will be pinged when a new thread is created and this role is automatically added to the roles allowed to execute all commands related to mod mail.