diff --git a/CHANGELOG.md b/CHANGELOG.md index 68887ddb..07057014 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## 10.3.0 (Not Released Yet) +### New features + +* #132: [moderation delay](https://livingston.frama.io/peertube-plugin-livechat/documentation/user/streamers/moderation_delay/). + ### Minor changes and fixes * Translations updates: german. diff --git a/support/documentation/content/en/documentation/user/streamers/_index.md b/support/documentation/content/en/documentation/user/streamers/_index.md index 32691c38..dc7e9983 100644 --- a/support/documentation/content/en/documentation/user/streamers/_index.md +++ b/support/documentation/content/en/documentation/user/streamers/_index.md @@ -1,7 +1,7 @@ --- title: "For streamers" description: "How to setup the chat for your live stream" -weight: 20 +weight: 200 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/basics.md b/support/documentation/content/en/documentation/user/streamers/basics.md index dac15d37..3114f059 100644 --- a/support/documentation/content/en/documentation/user/streamers/basics.md +++ b/support/documentation/content/en/documentation/user/streamers/basics.md @@ -1,7 +1,7 @@ --- title: "Some basics" description: "Some basics about how to setup and use the chat for your live stream" -weight: 10 +weight: 100 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/bot/_index.md b/support/documentation/content/en/documentation/user/streamers/bot/_index.md index e2f9f896..ffd81d45 100644 --- a/support/documentation/content/en/documentation/user/streamers/bot/_index.md +++ b/support/documentation/content/en/documentation/user/streamers/bot/_index.md @@ -1,7 +1,7 @@ --- title: "Chat bot" description: "Chat bot setup" -weight: 40 +weight: 400 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/channel.md b/support/documentation/content/en/documentation/user/streamers/channel.md index 3370cb9d..a36079f7 100644 --- a/support/documentation/content/en/documentation/user/streamers/channel.md +++ b/support/documentation/content/en/documentation/user/streamers/channel.md @@ -1,7 +1,7 @@ --- title: "Channel configuration" description: "Peertube channel chatrooms configuration" -weight: 20 +weight: 200 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/emojis.md b/support/documentation/content/en/documentation/user/streamers/emojis.md index ffef1742..ed9336a0 100644 --- a/support/documentation/content/en/documentation/user/streamers/emojis.md +++ b/support/documentation/content/en/documentation/user/streamers/emojis.md @@ -1,7 +1,7 @@ --- title: "Custom emojis" description: "Plugin peertube-plugin-livechat custom emojis" -weight: 33 +weight: 330 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/moderation.md b/support/documentation/content/en/documentation/user/streamers/moderation.md index 4e68b79e..80cdc7fa 100644 --- a/support/documentation/content/en/documentation/user/streamers/moderation.md +++ b/support/documentation/content/en/documentation/user/streamers/moderation.md @@ -1,7 +1,7 @@ --- title: "Moderation" description: "Plugin peertube-plugin-livechat advanced moderation features" -weight: 30 +weight: 300 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/moderation_delay.md b/support/documentation/content/en/documentation/user/streamers/moderation_delay.md new file mode 100644 index 00000000..cc36e8cd --- /dev/null +++ b/support/documentation/content/en/documentation/user/streamers/moderation_delay.md @@ -0,0 +1,35 @@ +--- +title: "Moderation delay" +description: "Plugin peertube-plugin-livechat moderation delay" +weight: 325 +chapter: false +--- + +{{% notice info %}} +This feature comes with the livechat plugin version 10.3.0. +{{% /notice %}} + +## Introduction + +As a streamer, you can choose to delay messages in the chat, to let some time to moderators to delete messages before they can even be read by other participants. + +When this feature is enabled, moderators will see all messages without any delay. +Chat participants won't see that their own messages are delayed. + +Please note that messages sent by moderators will also be delayed, to avoid them to respond to messages that are not even visible by other participants. + +## Moderation delay option + +On the [channel configuration page](/peertube-plugin-livechat/documentation/user/streamers/channel), you can set the "{{% livechat_label moderation_delay %}}" option: + +![Channel configuration / Moderation delay](/peertube-plugin-livechat/images/moderation_delay_channel_option.png?classes=shadow,border&height=400px) + +This value will apply as a default value for all your channel's chatrooms. + +Setting the value to `0` will disable the feature. + +Setting the value to a positive integer will set the delay, in seconds, to apply to messages. +Please avoid setting the value too high. +Ideally it should not exceed a few seconds (4 or 5 seconds for example). + +To modify the value for an already existing room, just open the room "configuration" menu (on top of the chat window), and change the moderation delay value in the configuration form. diff --git a/support/documentation/content/en/documentation/user/streamers/polls.md b/support/documentation/content/en/documentation/user/streamers/polls.md index cf9c74c1..d737a90d 100644 --- a/support/documentation/content/en/documentation/user/streamers/polls.md +++ b/support/documentation/content/en/documentation/user/streamers/polls.md @@ -1,7 +1,7 @@ --- title: "Polls" description: "You can create polls to ask viewers their opinion." -weight: 33 +weight: 330 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/slow_mode.md b/support/documentation/content/en/documentation/user/streamers/slow_mode.md index b16f43c3..8dd43462 100644 --- a/support/documentation/content/en/documentation/user/streamers/slow_mode.md +++ b/support/documentation/content/en/documentation/user/streamers/slow_mode.md @@ -1,7 +1,7 @@ --- title: "Slow mode" description: "Plugin peertube-plugin-livechat slow mode" -weight: 32 +weight: 320 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/tasks.md b/support/documentation/content/en/documentation/user/streamers/tasks.md index 3472a251..0c09b75b 100644 --- a/support/documentation/content/en/documentation/user/streamers/tasks.md +++ b/support/documentation/content/en/documentation/user/streamers/tasks.md @@ -1,7 +1,7 @@ --- title: "Tasks / To-do lists" description: "You can handle tasks and task lists with your moderation team." -weight: 35 +weight: 350 chapter: false --- diff --git a/support/documentation/content/en/documentation/user/streamers/terms.md b/support/documentation/content/en/documentation/user/streamers/terms.md index 498ef731..092c622d 100644 --- a/support/documentation/content/en/documentation/user/streamers/terms.md +++ b/support/documentation/content/en/documentation/user/streamers/terms.md @@ -1,7 +1,7 @@ --- title: "Terms & conditions" description: "Configure channel's chat terms & conditions" -weight: 31 +weight: 310 chapter: false --- diff --git a/support/documentation/content/en/images/moderation_delay_channel_option.png b/support/documentation/content/en/images/moderation_delay_channel_option.png new file mode 100644 index 00000000..af43303e Binary files /dev/null and b/support/documentation/content/en/images/moderation_delay_channel_option.png differ