added support for example templates/direct strings to commands who need it

added example templates for some commands
added the examples to documentation as well

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

@@ -17,6 +17,7 @@ or if it is not restricted and which roles are immune against the command.
 Changing the system configuration::
 * Usage `setConfig <key> <value>`
 * Description: Changes the value of this configuration identified by `key` to `value`. Some of these configurations have separate commands, but this works in general.
+* Example: `setConfig expMin 15` to set the minimum experience to 15
 Changing emotes Abstracto uses::
 * Usage: `setEmote <key> <emote>`
 * Description: Sets the emote identified by `key` used by Abstracto on this server to `emote`.
@@ -36,15 +37,18 @@ Changing the prefix::
 Changing a post target::
 * Usage: `posttarget <key> <channel>`
 * Description: Changes the given post target identified by `key` to the given channel. All messages using this post target will be send to this channel from now on.
+* Example: `posttarget banLog #general` to log the bans in the #general channel.
 Listing the features::
 * Usage: `features`
 * Description: Lists the available features and whether or not they are enabled in this server.
 Enabling a feature::
 * Usage: `enable <key>`
 * Description: Enables the feature identified by `key` in this server. If the feature dependents on other features, they will be enabled as well.
+* Example: `enable moderation` to enable the moderation feature
 Disabling a feature::
 * Usage: `disable <key>`
 * 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: `disable moderation` to disable the moderation feature
 Creating a channel group::
 * Usage: `createChannelGroup <key>`
 * Description: Creates a new channel group identified by `key`.
@@ -53,10 +57,12 @@ Adding a channel to a channel group::
 * Usage: `addToChannelGroup <groupName> <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>`
 * Description: Removes the `channel` from the channel group identified by `groupName`.
 * Aliases: `rmChChgrp`, `chGrpCh-`
+* Example: `removeFromChannelGroup group1 #general` to remove the channel #general from the group `group1`
 Deleting a channel group::
 * Usage: `deleteChannelGroup <key>`
 * Description: Deletes the channel group identifies 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.
@@ -64,9 +70,11 @@ Deleting a channel group::
 Disabling a command in a group::
 * Usage: `disableCommand <commandName> <groupName>`
 * Description: Disables the command identified by `commandName` in the channel group `groupName`. A command is considered disabled in a specified channel, if the command is disabled in *all* the groups the channel is in.
+* Example: `disableCommand warn group1` to disable the command `warn` in the group `group1`
 Enabling a command in a group::
 * Usage: `enableCommand <commandname> <groupName>`
 * Description: Enables the command identified by `commandName` in the channel group `groupName`. A command is considered enabled in a specified channel, if the command is enabled in *any* the groups the channel is in.
+* Example: `enableCommand warn group1` to enable the command `warn` in the group `group1`
 Showing all available channel groups and the respective channels::
 * Usage: `listChannelGroups`
 * Description: Provides an overview of the currently available channel groups and which channels are in this channel group.
@@ -77,15 +85,19 @@ Removing role restrictions from a command::
 Allowing a role to execute a command::
 * Usage: `allowRole  <featureName|commandName> <role>`
 * Description: Allows the provided `role` to execute all commands in the `feature`/the `command`. This command automatically restricts the commands, which means, if it was unrestricted before, after executing this command only the provided role can execute the command.
+* Example: `allowRole moderation @Staff` to allow the role `Staff` to execute all commands in the `moderation` feature (where @Staff is a role mention)
 Forbidding a role to execute a command::
 * Usage: `disAllowRole <featureName|commandName> <role>`
 * Description: Removes the `role` from the list of allowed roles for all commands in the `feature`/the `command`.
+* Example: `disAllowRole moderation @Staff` to forbid the role `Staff` to execute all commands in the `moderation` feature (where @Staff is a role mention)
 Make a role affected by a command::
 * Usage: `makeAffected <featureName|commandName> <role>`
 * Description: Makes the role affected by all commands in the `feature`/the `command`.
+* Example: `makeAffected ban @Staff` in order so the role `Staff` can be banned via the command (where @Staff is a role mention)
 Make a role immune against a command::
 * Usage: `makeImmune <featureName|commandName> <role>`
 * Description: Makes the role immune from all commands in the `feature`/the `command`.
+* Example: `makeImmune ban @Staff` in order so the role `Staff` cannot be banned via the command (where @Staff is a role mention)
 Enforce the role restrictions of commands::
 * Usage: `restrict <featureName|commandName>`
 * Description: Causes the role restrictions for a all commands in the `feature`/the `command` to be in effect again.

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

@@ -30,6 +30,7 @@ Setting a role to be awarded at a certain level::
 this will cause to remove this assignment and recalculate the roles for all users previously having this role.
 This command will provide a status message indicating this process.
 This will not award this role to users which qualify for this, a `syncRoles` is necessary for this.
+* 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`

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

@@ -12,19 +12,23 @@ Ban a member::
 * Description:
 Bans the given given `member` with the given optional `reason`. This sends a logging message to the `banLog` post target.
 Banning this way does not delete old messages of the member on the server. If the `reason` is not provided, a default reason is used.
+* Example: `ban @Member bad` in order to ban `Member` with the reason `bad` (the @Member is a user mention)
 * Required bot permission: `BAN_MEMBERS`
 Ban a user by ID::
 * Usage: `banId <userId> [reason]`
 * Description: Bans the `user` by his id with the optional `reason`. . This command can be used in case the user is not part of the server anymore.
 This will also send a log message to `banLog` and not delete old messages.
+* Example: `banId 1234 bad` in order to ban the user with ID `1234` with the reason `bad`
 * Required bot permission: `BAN_MEMBERS`
 Kick a member::
 * Usage: `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 the slow mode in a channel::
 * Usage: `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 user mention)
 * Required bot permission: `MANAGE_CHANNEL` in the respective channel
 
 === Warning
@@ -42,6 +46,7 @@ Warn a user::
 * Usage: `warn <member> [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 warn.
+* 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]`
 * 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.
@@ -92,6 +97,7 @@ Muting a user::
 * Description: Applies the mute role to 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 and kicks the user from the voice channel, if any.
+* Example: `mute @Member 1h2m3s bad` in order to mute the member `Member` for 1 hour 2 minutes and 3 seconds with the reason `bad` (the @Member is a user mention)
 Un-Muting a user::
 * Usage: `unMute <member>`
 * Description: Removes the mute role from the given member. This does *not* log the un-mute.

abstracto-application/documentation/src/main/docs/asciidoc/features/utility.adoc

@@ -9,6 +9,7 @@ Create a reminder::
 * Usage: `remind <duration> <text>`
 * Description: Creates a reminder with `text` which will be triggered after `duration`. This command uses duration parsing. The reminder will ping when the duration has passed and provide
 the context of the reminder.
+* Example: `remind 1h2m3s text` in order to be reminded in 1 hour 2 minutes and 3 seconds with the reason `text`
 Cancelling a reminder::
 * Usage `unRemind <reminderId>`
 * Description: Cancels this reminder reminder and will cause this reminder to not be executed.
@@ -70,9 +71,11 @@ Creating a suggestion::
 Accepting a suggestion::
 * Usage `accept <suggestionId> [note]`
 * Description: Re-posts the suggestion identified by `suggestionId` and marks the suggestion as accepted. The optional `note` will be used in this re-post, if provided.
-Deny a suggestion::
-* Usage `deny <suggestionId> [note]`
+* Example: `accept 1 okay` in order to accept the suggestion `1` with the reason `okay`
+Rejecting a suggestion::
+* Usage `reject <suggestionId> [note]`
 * Description: Re-posts the suggestion identified by `suggestionId` and marks the suggestion as denied. The optional `note` will be used in this re-post, if provided.
+* Example: `deny 1 not okay` in order to reject the suggestion `1` with the reason `not okay`
 
 === Miscellaneous