Merge branch 'main' of https://github.com/JohnXLivingston/peertube-plugin-livechat

support/documentation/content/en/contributing/document/_index.md

@@ -93,11 +93,17 @@ To facilitate translators work, avoid making too long paragraphs.
 For now, it is not possible to use Markdown tables: the translation tools will break them.
 
 {{% notice warning %}}
-There may be links to documentation elsewhere on the web.
+There may be links to this documentation elsewhere on the web.
 Try not to change the urls of the documentation pages.
 Or at the very least, put links to the new location on the previous url.
 {{% /notice %}}
 
+When a new feature is released, you can use the `livechat_version_notice` short code to display an infobox with the version with which the features is available.
+This short code takes the version number as parameter.
+Here is an example:
+
+{{% livechat_version_notice 12.0.0 %}}
+
 ### What if I can't use hugo and/or po4a?
 
 Just edit english markdown files, and specify that you can't build translations when you make your Pull Request.

support/documentation/content/en/documentation/admin/mod_firewall.md

@@ -5,9 +5,7 @@ weight: 30
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 11.0.0.
-{{% /notice %}}
+{{% livechat_version_notice 11.0.0 %}}
 
 You can enable [mod_firewall](https://modules.prosody.im/mod_firewall) on your Prosody server.
 

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

@@ -42,9 +42,7 @@ You must use valid CSS color values, and they must be properly URL encoded.
 
 ## OBS Dock
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.1.0.
-{{% /notice %}}
+{{% livechat_version_notice 10.1.0 %}}
 
 {{% notice warning %}}
 This feature can be disabled by the instance's adminitrators.

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

@@ -0,0 +1,31 @@
+---
+title: "Announcements"
+description: "Room owners and administrators can send special announcements in the chat."
+weight: 250
+chapter: false
+---
+
+{{% livechat_version_notice 12.0.0 %}}
+
+Room owners and administrators can send special announcements in the chat.
+
+These messages will be more visible than standard messages.
+
+To send announcements, owners and administrators will have a "{{% livechat_label announcements_message_type %}}" selector on the top of the message field:
+
+![Screenshot of a chat session. On top of the message field, there is a "{{% livechat_label announcements_message_type %}}" selector. In the chat, we can see three types of announcements: a highlighted message, an announcement, and a warning. Each of these announcements have a special color to distinguish them. The announcement and the warning have also bold titles.](/peertube-plugin-livechat/images/announcements.png?classes=shadow,border&height=400px "Announcements")
+
+There are several message types:
+
+* **{{% livechat_label announcements_message_type_standard %}}**: to send a standard message.
+* **{{% livechat_label announcements_message_type_highlight %}}**: these messages will simply be highlighted in a blue box.
+* **{{% livechat_label announcements_message_type_announcement %}}**: these messages will be in a green box, and a bold "{{% livechat_label announcements_message_type_announcement %}}" title will be added.
+* **{{% livechat_label announcements_message_type_warning %}}**: these messages will be in a rend box, and a bold "{{% livechat_label announcements_message_type_announcement %}}" title will be added.
+
+{{% notice info %}}
+User that are not owner or administrator of the chatroom can't send such messages.
+{{% /notice %}}
+
+{{% notice warning %}}
+Note: Standards XMPP clients will display announcements as standard messages.
+{{% /notice %}}

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

@@ -1,7 +1,7 @@
 ---
 title: "Forbidden words"
 description: "The bot can automatically moderate messages containing forbidden words."
-weight: 10
+weight: 20
 chapter: false
 ---
 
@@ -49,13 +49,13 @@ You can [open an issue](https://github.com/JohnXLivingston/peertube-plugin-livec
 
 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_applytomoderators_label %}}
 
-{{% livechat_label livechat_configuration_channel_forbidden_words_applytomoderators_desc %}}
+{{% livechat_label livechat_configuration_applytomoderators_desc %}}
 
-## {{% livechat_label livechat_configuration_channel_forbidden_words_reason_label %}}
+## {{% livechat_label livechat_configuration_channel_retractation_reason_label %}}
 
-{{% livechat_label livechat_configuration_channel_forbidden_words_reason_desc %}}
+{{% livechat_label livechat_configuration_channel_retractation_reason_desc %}}
 
 ## {{% livechat_label livechat_configuration_channel_forbidden_words_comments_label %}}
 

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

@@ -0,0 +1,28 @@
+---
+title: "No duplicate message"
+description: "The bot can automatically moderate duplicate messages."
+weight: 12
+chapter: false
+---
+
+## {{% livechat_label livechat_configuration_channel_no_duplicate_label %}}
+
+{{% livechat_version_notice 12.0.0 %}}
+
+### Configuration
+
+{{% livechat_label livechat_configuration_channel_no_duplicate_desc %}}
+
+![Screenshot of the channel options page, with several fields to configure the "No duplicate message" option.](/peertube-plugin-livechat/images/bot_no_duplicate.png?classes=shadow,border&height=400px "No duplicate message configuration")
+
+#### {{% livechat_label livechat_configuration_channel_no_duplicate_delay_label %}}
+
+{{% livechat_label livechat_configuration_channel_no_duplicate_delay_desc %}}
+
+#### {{% livechat_label livechat_configuration_channel_retractation_reason_label %}}
+
+{{% livechat_label livechat_configuration_channel_retractation_reason_desc %}}
+
+#### {{% livechat_label livechat_configuration_applytomoderators_label %}}
+
+{{% livechat_label livechat_configuration_applytomoderators_desc %}}

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

@@ -1,7 +1,7 @@
 ---
 title: "Timers"
 description: "The bot can send periodically some messages."
-weight: 20
+weight: 30
 chapter: false
 ---
 

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

@@ -0,0 +1,28 @@
+---
+title: "Special characters"
+description: "The bot can automatically moderate messages containing too many special characters."
+weight: 10
+chapter: false
+---
+
+## {{% livechat_label livechat_configuration_channel_special_chars_label %}}
+
+{{% livechat_version_notice 12.0.0 %}}
+
+### Configuration
+
+{{% livechat_label livechat_configuration_channel_special_chars_desc %}}
+
+![Screenshot of the channel options page, with several fields to configure the "Forbid special characters" option.](/peertube-plugin-livechat/images/forbid_special_chars_configuration.png?classes=shadow,border&height=400px "Forbid special characters configuration")
+
+#### {{% livechat_label livechat_configuration_channel_special_chars_tolerance_label %}}
+
+{{% livechat_label livechat_configuration_channel_special_chars_tolerance_desc %}}
+
+#### {{% livechat_label livechat_configuration_channel_retractation_reason_label %}}
+
+{{% livechat_label livechat_configuration_channel_retractation_reason_desc %}}
+
+#### {{% livechat_label livechat_configuration_applytomoderators_label %}}
+
+{{% livechat_label livechat_configuration_applytomoderators_desc %}}

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

@@ -5,9 +5,7 @@ weight: 330
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.1.0.
-{{% /notice %}}
+{{% livechat_version_notice  10.1.0 %}}
 
 ## Channel emojis
 

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

@@ -0,0 +1,22 @@
+---
+title: "Emojis only mode"
+description: "Plugin peertube-plugin-livechat emojis only mode"
+weight: 335
+chapter: false
+---
+
+{{% livechat_version_notice 12.0.0 %}}
+
+## {{% livechat_label emoji_only_mode_title %}}
+
+{{% livechat_label emoji_only_mode_desc_1 %}}
+
+This mode can be usefull for example:
+
+* To avoid spam or offensive message when you are not here to moderate.
+* When there are too many speaking participants, and you can't no more moderate correctly.
+
+To enable or disable this feature, use the [chat dropdown menu](/peertube-plugin-livechat/documentation/user/viewers), open the "configure" menu.
+In the form, you will find a "{{% livechat_label emoji_only_mode_title %}}" checkbox.
+
+If you want to enable it for all your chatrooms at once, open the [channel emojis configuration page](/peertube-plugin-livechat/documentation/user/streamers/emojis/), and use the "{{% livechat_label emoji_only_enable_all_rooms %}}" button.

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

@@ -41,9 +41,7 @@ When you open the chat room in full screen, there will also be a menu with dedic
 
 ## {{% livechat_label livechat_configuration_channel_mute_anonymous_label %}}
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.2.0.
-{{% /notice %}}
+{{% livechat_version_notice  10.2.0 %}}
 
 You can prevent anonymous users to send messages. In such case, only registered users will be able to talk in the chat.
 
@@ -75,9 +73,7 @@ You can promote users as moderators, if you need some help.
 
 ## {{% livechat_label livechat_configuration_channel_anonymize_moderation_label %}}
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 11.0.0.
-{{% /notice %}}
+{{% livechat_version_notice 11.0.0 %}}
 
 It is possible to anonymize moderation actions, to avoid disclosing who is banning/kicking/… occupants.
 
@@ -88,9 +84,7 @@ You can choose to enable or disable this feature for new chatrooms on the [chann
 
 ## Participant message history search
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 11.0.0.
-{{% /notice %}}
+{{% livechat_version_notice 11.0.0 %}}
 
 As a room admin or owner, you can search all messages sent by a given participant.
 

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

@@ -5,9 +5,7 @@ weight: 325
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.3.0.
-{{% /notice %}}
+{{% livechat_version_notice 10.3.0 %}}
 
 ## Introduction
 

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

@@ -5,9 +5,7 @@ weight: 355
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 11.0.0.
-{{% /notice %}}
+{{% livechat_version_notice  11.0.0 %}}
 
 ## Introduction
 

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

@@ -1,13 +1,11 @@
 ---
 title: "Polls"
-description: "You can create polls to ask viewers their opinion."
-weight: 330
+description: "You can create polls to ask viewers their opinion"
+weight: 340
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.2.0.
-{{% /notice %}}
+{{% livechat_version_notice 10.2.0 %}}
 
 ## Create a poll
 

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

@@ -5,9 +5,7 @@ weight: 320
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 8.3.0.
-{{% /notice %}}
+{{% livechat_version_notice 8.3.0 %}}
 
 ## Introduction
 

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

@@ -5,9 +5,7 @@ weight: 350
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.0.0.
-{{% /notice %}}
+{{% livechat_version_notice 10.0.0 %}}
 
 ## Introduction
 

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

@@ -5,9 +5,7 @@ weight: 310
 chapter: false
 ---
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 10.2.0.
-{{% /notice %}}
+{{% livechat_version_notice 10.2.0 %}}
 
 ## Configuration
 

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

@@ -59,9 +59,7 @@ To do so, just open the video on your instance (you can for example copy/paste t
 
 ## If you have a Peertube account on another Peertube instance
 
-{{% notice info %}}
-This feature comes with the livechat plugin version 9.0.0.
-{{% /notice %}}
+{{% livechat_version_notice  9.0.0 %}}
 
 If you have a Peertube account, but not on the current instance, there is a "{{% livechat_label login_using_external_account %}}" button.
 This button will open a dialog where you can enter your Peertube instance URL.