Documentation.

support/documentation/content/en/documentation/user/streamers/_index.md

@@ -5,85 +5,4 @@ weight: 20
 chapter: false
 ---
 
-## Enabling the chat for you live streams
-
-{{% notice warning %}}
-Instance administrators can choose to disable or enable chat in specific cases.
-Information in this section are only true in the default case.
-{{% /notice %}}
-
-When you create or modify a Peertube live, there is a "plugin settings" tab:
-
-![New live](/peertube-plugin-livechat/images/new_live.png?classes=shadow,border&height=200px)
-
-In the "plugin settings" tab, there is a "{{% livechat_label use_chat %}}" checkbox.
-Just check or uncheck it to enable or disable the chat associated to your video.
-
-![Activate the chat](/peertube-plugin-livechat/images/new_live_activate_chat.png?classes=shadow,border&height=200px)
-
-{{% notice tip %}}
-There can be other settings in this tab, depending on plugins installed on your Peertube instance.
-{{% /notice %}}
-
-### Per channel chat
-
-On the instance level, Peertube's administrators can choose if chat rooms are unique per video, or if there will be an unique chat room per channel.
-Please contact your instance's administrators for more information on how they configure the livechat plugin.
-
-## Share the chat
-
-On top of the chat, there is a "{{% livechat_label share_chat_link %}}" button.
-
-This button opens a popup, where you can obtain an url to join the chat.
-This url can be shared.
-
-![Share link popup](/peertube-plugin-livechat/images/share_readonly.png?classes=shadow,border&height=200px)
-
-You can customize some options:
-
-* {{% livechat_label read_only %}}: you will only be able to read the chat, not write. This is useful to include the chat content in your live stream (see the [OBS documentation](/peertube-plugin-livechat/documentation/user/obs)).
-* {{% livechat_label use_current_theme_color %}}: if checked, your current theme colors will be added to the url, so that any user that opens the link will have the same color set.
-* {{% livechat_label generate_iframe %}}: instead of an url, you will obtain an HTML snippet that you can add to your website to embed the chat.
-
-The "{{% livechat_label share_chat_link %}}" popup can also contain a "{{% livechat_label connect_using_xmpp %}}" tab.
-This will only be available if your instance's administators have enabled an correctly configured this option.
-Using this option, you can provide a link to join the chat using any [XMPP client software](https://en.wikipedia.org/wiki/XMPP#Clients).
-Using such softwares can for example facilitate moderation actions.
-
-## Moderation
-
-Please refer to the [moderation documentation](/peertube-plugin-livechat/documentation/user/moderation).
-
-## Include the chat in your video stream
-
-Please refer to the [OBS documentation](/peertube-plugin-livechat/documentation/user/obs).
-
-## Chat persistence
-
-By default, the chat is persistent.
-This means that the room content will be kept for a while.
-User joining will see messages posted before their arrival.
-
-You can change the persistence behaviour.
-[Open the chat in fullscreen](/peertube-plugin-livechat/documentation/user/viewers), then open the top menu and click on "Configure".
-
-![Top menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
-
-There are several options that can be changed.
-
-![Configure chat room](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
-
-You can for example set the default and maximum number of messages to return to 0, so that new incomers won't see any previously sent message.
-
-You can also uncheck "enable archiving": if unchecked, messages will be pruned if the server restarts.
-
-By unchecking "Persistent", the room will be cleared if there is no more participant.
-
-## Delete the chat content
-
-If you want to delete the chat content, [open the chat in fullscreen](/peertube-plugin-livechat/documentation/user/viewers), then open the top menu and click on "Destroy".
-A popup will open, asking a confirmation.
-To avoid errors, the popup will ask you the "XMPP address" of the chat room.
-This address can be obtain using the "Details" menu in the top menu.
-
-The chat will be automatically recreated each time someone tries to join it as long as the video exists, and has the "{{% livechat_label use_chat %}}" feature activated.
+{{% children depth="3" style="li" description="true" %}}

support/documentation/content/en/documentation/user/streamers/basics.md

@@ -0,0 +1,89 @@
+---
+title: "Some basics"
+description: "Some basics about how to setup and use the chat for your live stream"
+weight: 10
+chapter: false
+---
+
+## Enabling the chat for you live streams
+
+{{% notice warning %}}
+Instance administrators can choose to disable or enable chat in specific cases.
+Information in this section are only true in the default case.
+{{% /notice %}}
+
+When you create or modify a Peertube live, there is a "plugin settings" tab:
+
+![New live](/peertube-plugin-livechat/images/new_live.png?classes=shadow,border&height=200px)
+
+In the "plugin settings" tab, there is a "{{% livechat_label use_chat %}}" checkbox.
+Just check or uncheck it to enable or disable the chat associated to your video.
+
+![Activate the chat](/peertube-plugin-livechat/images/new_live_activate_chat.png?classes=shadow,border&height=200px)
+
+{{% notice tip %}}
+There can be other settings in this tab, depending on plugins installed on your Peertube instance.
+{{% /notice %}}
+
+### Per channel chat
+
+On the instance level, Peertube's administrators can choose if chat rooms are unique per video, or if there will be an unique chat room per channel.
+Please contact your instance's administrators for more information on how they configure the livechat plugin.
+
+## Share the chat
+
+On top of the chat, there is a "{{% livechat_label share_chat_link %}}" button.
+
+This button opens a popup, where you can obtain an url to join the chat.
+This url can be shared.
+
+![Share link popup](/peertube-plugin-livechat/images/share_readonly.png?classes=shadow,border&height=200px)
+
+You can customize some options:
+
+* {{% livechat_label read_only %}}: you will only be able to read the chat, not write. This is useful to include the chat content in your live stream (see the [OBS documentation](/peertube-plugin-livechat/documentation/user/obs)).
+* {{% livechat_label use_current_theme_color %}}: if checked, your current theme colors will be added to the url, so that any user that opens the link will have the same color set.
+* {{% livechat_label generate_iframe %}}: instead of an url, you will obtain an HTML snippet that you can add to your website to embed the chat.
+
+The "{{% livechat_label share_chat_link %}}" popup can also contain a "{{% livechat_label connect_using_xmpp %}}" tab.
+This will only be available if your instance's administators have enabled an correctly configured this option.
+Using this option, you can provide a link to join the chat using any [XMPP client software](https://en.wikipedia.org/wiki/XMPP#Clients).
+Using such softwares can for example facilitate moderation actions.
+
+## Moderation
+
+Please refer to the [moderation documentation](/peertube-plugin-livechat/documentation/user/streamers/moderation).
+
+## Include the chat in your video stream
+
+Please refer to the [OBS documentation](/peertube-plugin-livechat/documentation/user/obs).
+
+## Chat persistence
+
+By default, the chat is persistent.
+This means that the room content will be kept for a while.
+User joining will see messages posted before their arrival.
+
+You can change the persistence behaviour.
+[Open the chat in fullscreen](/peertube-plugin-livechat/documentation/user/viewers), then open the top menu and click on "Configure".
+
+![Top menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
+
+There are several options that can be changed.
+
+![Configure chat room](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
+
+You can for example set the default and maximum number of messages to return to 0, so that new incomers won't see any previously sent message.
+
+You can also uncheck "enable archiving": if unchecked, messages will be pruned if the server restarts.
+
+By unchecking "Persistent", the room will be cleared if there is no more participant.
+
+## Delete the chat content
+
+If you want to delete the chat content, [open the chat in fullscreen](/peertube-plugin-livechat/documentation/user/viewers), then open the top menu and click on "Destroy".
+A popup will open, asking a confirmation.
+To avoid errors, the popup will ask you the "XMPP address" of the chat room.
+This address can be obtain using the "Details" menu in the top menu.
+
+The chat will be automatically recreated each time someone tries to join it as long as the video exists, and has the "{{% livechat_label use_chat %}}" feature activated.

support/documentation/content/en/documentation/user/streamers/bot/_index.md

@@ -0,0 +1,21 @@
+---
+title: "Chat bot"
+description: "Chat bot setup"
+weight: 40
+chapter: false
+---
+
+{{% notice info %}}
+This feature comes with the livechat plugin version 8.0.0, and can be disabled by your instance's admins.
+{{% /notice %}}
+
+You can enable a chat bot on your chatrooms.
+The bot configuration is made channel per channel, and will apply to all related videos' chatrooms.
+
+![Channel configuration](/peertube-plugin-livechat/images/channel_configuration.png?classes=shadow,border&height=400px)
+
+To access this page, check the [channel configuration documentation](/peertube-plugin-livechat/documentation/user/streamers/channel).
+
+Once there, you can enable the bot, and setup several options:
+
+{{% children style="li" depth="3" description="true" %}}

support/documentation/content/en/documentation/user/streamers/bot/commands.md

@@ -0,0 +1,20 @@
+---
+title: "Commands"
+description: "The bot can respond to several commands."
+weight: 40
+chapter: false
+---
+
+{{% livechat_label livechat_configuration_channel_command_desc %}}
+
+![Commands configuration](/peertube-plugin-livechat/images/bot_commands.png?classes=shadow,border&height=400px)
+
+You can setup several commands.
+
+## {{% livechat_label livechat_configuration_channel_command_cmd_label %}}
+
+{{% livechat_label livechat_configuration_channel_command_cmd_desc %}}
+
+## {{% livechat_label livechat_configuration_channel_quote_delay_label %}}
+
+{{% livechat_label livechat_configuration_channel_quote_delay_desc %}}

support/documentation/content/en/documentation/user/streamers/bot/forbidden_words.md

@@ -0,0 +1,54 @@
+---
+title: "Forbidden words"
+description: "The bot can automatically moderate messages containing forbidden words."
+weight: 10
+chapter: false
+---
+
+{{% livechat_label livechat_configuration_channel_forbidden_words_desc %}}
+
+![Forbidden words configuration](/peertube-plugin-livechat/images/bot_forbidden_words.png?classes=shadow,border&height=400px)
+
+![Deleted message](/peertube-plugin-livechat/images/bot_deleted_message.png?classes=shadow,border&height=100px)
+
+You can fill several "{{% livechat_label livechat_configuration_channel_forbidden_words_label %}}" fields.
+When a user sends a message that match the configured criteria, the message will automatically be deleted.
+
+## {{% livechat_label livechat_configuration_channel_forbidden_words_label %}}
+
+In this field, you can set several words, group of words, or "regular expressions".
+
+{{% livechat_label livechat_configuration_channel_forbidden_words_desc2 %}}
+
+Each time a user sends a message, these words will be tested.
+If the message containes one of them, the message will be deleted.
+
+You can for example fill this field with a swear words list.
+
+To get some examples, please check these [forbidden words suggestions](https://framagit.org/Livingston/peertube-plugin-livechat/-/tree/main/support/forbidden_words).
+
+If you have some usefull words lists, you are welcome to contribute to this suggestion page.
+There are in the `support/forbidden_words` folder of the livechat source code.
+See the [contribution guide](/peertube-plugin-livechat/contributing/) for more information.
+
+{{% notice tip %}}
+These words are case insensitive.
+{{% /notice %}}
+
+{{% notice warning %}}
+This features is still experimental.
+There might be some issues with non-latin alphabets.
+You can [open an issue](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues) to report your problems.
+{{% /notice %}}
+
+## {{% livechat_label livechat_configuration_channel_forbidden_words_regexp_label %}}
+
+By checking this option, each line of the "{{% livechat_label livechat_configuration_channel_forbidden_words_label %}}" field will be considered as a [regular expression](https://en.wikipedia.org/wiki/Regular_expression).
+
+## {{% livechat_label livechat_configuration_channel_forbidden_words_applytomoderators_label %}}
+
+{{% livechat_label livechat_configuration_channel_forbidden_words_applytomoderators_desc %}}
+
+## {{% livechat_label livechat_configuration_channel_forbidden_words_reason_label %}}
+
+{{% livechat_label livechat_configuration_channel_forbidden_words_reason_desc %}}

support/documentation/content/en/documentation/user/streamers/bot/quotes.md

@@ -0,0 +1,24 @@
+---
+title: "Pre-recorded messages"
+description: "The bot can send periodically some messages."
+weight: 20
+chapter: false
+---
+
+{{% livechat_label livechat_configuration_channel_quote_desc %}}
+
+{{% notice tip %}}
+If there is no user in the chatroom, the bot won't send any message.
+{{% /notice %}}
+
+![Pre-recorded messages configuration](/peertube-plugin-livechat/images/bot_quotes.png?classes=shadow,border&height=200px)
+
+## {{% livechat_label livechat_configuration_channel_quote_label %}}
+
+{{% livechat_label livechat_configuration_channel_quote_desc %}}
+
+{{% livechat_label livechat_configuration_channel_quote_desc2 %}}
+
+## {{% livechat_label livechat_configuration_channel_quote_delay_label %}}
+
+{{% livechat_label livechat_configuration_channel_quote_delay_desc %}}

support/documentation/content/en/documentation/user/streamers/channel.md

@@ -0,0 +1,24 @@
+---
+title: "Channel configuration"
+description: "Peertube channel chatrooms configuration"
+weight: 30
+chapter: false
+---
+
+{{% notice info %}}
+This feature comes with the livechat plugin version 8.0.0, and can be disabled by your instance's admins.
+{{% /notice %}}
+
+In the Peertube left menu, there is a "{{% livechat_label menu_configuration_label %}}" entry:
+
+![Chatrooms menu](/peertube-plugin-livechat/images/chatrooms_menu.png?classes=shadow,border&height=400px)
+
+This "{{% livechat_label menu_configuration_label %}}" link takes you to a list of your channels.
+By clicking on a channel, you will then be able to setup some options for your channels:
+
+![Channel configuration](/peertube-plugin-livechat/images/channel_configuration.png?classes=shadow,border&height=400px)
+
+Here you can configure:
+
+* [The chat bot](/peertube-plugin-livechat/documentation/user/streamers/bot)
+* More feature to come...

support/documentation/content/en/documentation/user/streamers/moderation.md

@@ -1,7 +1,7 @@
 ---
 title: "Moderation"
-description: "Plugin peertube-plugin-livechat moderation"
-weight: 30
+description: "Plugin peertube-plugin-livechat advances moderation features"
+weight: 60
 chapter: false
 ---
 
@@ -9,6 +9,11 @@ chapter: false
 This section is still incomplete.
 {{% /notice %}}
 
+## The chat bot
+
+You can use a chat bot, that will help you for moderation.
+Check [the chat bot documentation](/peertube-plugin-livechat/documentation/user/streamers/bot) for more information.
+
 ## Accessing moderation tools
 
 You can access room settings and moderation tools by opening the chat in a new window,

support/documentation/content/en/documentation/user/viewers.md

@@ -72,7 +72,7 @@ This will open a new browser tab with the following content:
 It can be easier to chat using a full browser tab.
 
 This fullscreen view also adds a top menu with advances features.
-This is especially useful for [moderation features](/peertube-plugin-livechat/documentation/user/moderation).
+This is especially useful for [moderation features](/peertube-plugin-livechat/documentation/user/streamers/moderation).
 
 ## Changing nickname