From c65995e5fa9c65dc65f5c41e5a0ea2ac4a8bfb49 Mon Sep 17 00:00:00 2001 From: John Livingston Date: Tue, 10 Sep 2024 12:02:40 +0200 Subject: [PATCH] Documentation: new shortcode for livechat version notices. --- languages/en.yml | 2 ++ languages/fr.yml | 1 + .../content/en/documentation/admin/mod_firewall.md | 4 +--- .../content/en/documentation/user/obs.md | 4 +--- .../user/streamers/bot/special_chars.md | 4 +--- .../en/documentation/user/streamers/emojis.md | 4 +--- .../en/documentation/user/streamers/emojis_only.md | 4 +--- .../en/documentation/user/streamers/moderation.md | 12 +++--------- .../documentation/user/streamers/moderation_delay.md | 4 +--- .../documentation/user/streamers/moderation_notes.md | 4 +--- .../content/en/documentation/user/streamers/polls.md | 4 +--- .../en/documentation/user/streamers/slow_mode.md | 4 +--- .../content/en/documentation/user/streamers/tasks.md | 4 +--- .../content/en/documentation/user/streamers/terms.md | 4 +--- .../content/en/documentation/user/viewers.md | 4 +--- .../layouts/shortcodes/livechat_version_notice.html | 9 +++++++++ 16 files changed, 27 insertions(+), 45 deletions(-) create mode 100644 support/documentation/layouts/shortcodes/livechat_version_notice.html diff --git a/languages/en.yml b/languages/en.yml index 7e0e8c44..649f6247 100644 --- a/languages/en.yml +++ b/languages/en.yml @@ -660,3 +660,5 @@ livechat_configuration_channel_special_chars_desc: | Special characters are those that don't fit into one of these categories: letters, numbers, punctuation symbols, currency symbols, emojis. livechat_configuration_channel_special_chars_tolerance_label: Tolerance livechat_configuration_channel_special_chars_tolerance_desc: Number of special characters to accept before deleting messages. + +features_comes_with: This feature comes with the livechat plugin version X.X.X. diff --git a/languages/fr.yml b/languages/fr.yml index 2a0d6fd0..51cf6331 100644 --- a/languages/fr.yml +++ b/languages/fr.yml @@ -619,3 +619,4 @@ prosody_firewall_name_desc: "Ne peut contenir que des caractères alphanumériqu ordre alphabétique.\n" prosody_firewall_content: Contenu du fichier chat: Tchat +features_comes_with: Cette fonctionnalité arrive avec le plugin livechat version X.X.X. diff --git a/support/documentation/content/en/documentation/admin/mod_firewall.md b/support/documentation/content/en/documentation/admin/mod_firewall.md index 404e3c00..0b87f414 100644 --- a/support/documentation/content/en/documentation/admin/mod_firewall.md +++ b/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. diff --git a/support/documentation/content/en/documentation/user/obs.md b/support/documentation/content/en/documentation/user/obs.md index ec0560ab..999d606c 100644 --- a/support/documentation/content/en/documentation/user/obs.md +++ b/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. diff --git a/support/documentation/content/en/documentation/user/streamers/bot/special_chars.md b/support/documentation/content/en/documentation/user/streamers/bot/special_chars.md index 8a21ca97..700fe359 100644 --- a/support/documentation/content/en/documentation/user/streamers/bot/special_chars.md +++ b/support/documentation/content/en/documentation/user/streamers/bot/special_chars.md @@ -7,9 +7,7 @@ chapter: false ## {{% livechat_label livechat_configuration_channel_special_chars_label %}} -{{% notice info %}} -This feature comes with the livechat plugin version 11.1.0. -{{% /notice %}} +{{% livechat_version_notice 11.1.0 %}} ### Configuration diff --git a/support/documentation/content/en/documentation/user/streamers/emojis.md b/support/documentation/content/en/documentation/user/streamers/emojis.md index f0119060..8854e9cf 100644 --- a/support/documentation/content/en/documentation/user/streamers/emojis.md +++ b/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 diff --git a/support/documentation/content/en/documentation/user/streamers/emojis_only.md b/support/documentation/content/en/documentation/user/streamers/emojis_only.md index b3ca0be6..2376c13e 100644 --- a/support/documentation/content/en/documentation/user/streamers/emojis_only.md +++ b/support/documentation/content/en/documentation/user/streamers/emojis_only.md @@ -5,9 +5,7 @@ weight: 335 chapter: false --- -{{% notice info %}} -This feature comes with the livechat plugin version 11.1.0. -{{% /notice %}} +{{% livechat_version_notice 11.1.0 %}} ## {{% livechat_label emoji_only_mode_title %}} diff --git a/support/documentation/content/en/documentation/user/streamers/moderation.md b/support/documentation/content/en/documentation/user/streamers/moderation.md index 7881553a..39cf4150 100644 --- a/support/documentation/content/en/documentation/user/streamers/moderation.md +++ b/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. diff --git a/support/documentation/content/en/documentation/user/streamers/moderation_delay.md b/support/documentation/content/en/documentation/user/streamers/moderation_delay.md index 3c6718c9..008cad9e 100644 --- a/support/documentation/content/en/documentation/user/streamers/moderation_delay.md +++ b/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 diff --git a/support/documentation/content/en/documentation/user/streamers/moderation_notes.md b/support/documentation/content/en/documentation/user/streamers/moderation_notes.md index 87cf394e..32d7b279 100644 --- a/support/documentation/content/en/documentation/user/streamers/moderation_notes.md +++ b/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 diff --git a/support/documentation/content/en/documentation/user/streamers/polls.md b/support/documentation/content/en/documentation/user/streamers/polls.md index 81fa5dc0..1ae677f3 100644 --- a/support/documentation/content/en/documentation/user/streamers/polls.md +++ b/support/documentation/content/en/documentation/user/streamers/polls.md @@ -5,9 +5,7 @@ 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 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 577cdc7d..1d07455a 100644 --- a/support/documentation/content/en/documentation/user/streamers/slow_mode.md +++ b/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 diff --git a/support/documentation/content/en/documentation/user/streamers/tasks.md b/support/documentation/content/en/documentation/user/streamers/tasks.md index 05f538fc..9ce17203 100644 --- a/support/documentation/content/en/documentation/user/streamers/tasks.md +++ b/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 diff --git a/support/documentation/content/en/documentation/user/streamers/terms.md b/support/documentation/content/en/documentation/user/streamers/terms.md index 04ed3835..993c7c7d 100644 --- a/support/documentation/content/en/documentation/user/streamers/terms.md +++ b/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 diff --git a/support/documentation/content/en/documentation/user/viewers.md b/support/documentation/content/en/documentation/user/viewers.md index d7130b4a..a7d51027 100644 --- a/support/documentation/content/en/documentation/user/viewers.md +++ b/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. diff --git a/support/documentation/layouts/shortcodes/livechat_version_notice.html b/support/documentation/layouts/shortcodes/livechat_version_notice.html new file mode 100644 index 00000000..7a848ee3 --- /dev/null +++ b/support/documentation/layouts/shortcodes/livechat_version_notice.html @@ -0,0 +1,9 @@ +{{- $_hugo_config := `{ "version": 1 }` }} +{{- partial "shortcodes/notice.html" (dict + "page" .Page + "color" (.Get "color") + "content" (replace (i18n "features_comes_with") "X.X.X" ($.Get 0)) + "icon" (.Get "icon" | default (.Get 2)) + "style" ("info") + "title" (.Get "title" | default (.Get 1)) +) }}