Terms&Conditions (#18) WIP:

* user documentation
* settings documentation
This commit is contained in:
John Livingston 2024-06-25 12:19:36 +02:00
parent d14c2868fd
commit af04f70611
No known key found for this signature in database
GPG Key ID: B17B5640CE66CDBC
8 changed files with 56 additions and 3 deletions

View File

@ -131,7 +131,7 @@ export function tplChannelConfiguration (el: ChannelConfigurationElement): Templ
<livechat-configuration-section-header
.label=${ptTr(LOC_LIVECHAT_CONFIGURATION_CHANNEL_TERMS_LABEL)}
.description=${ptTr(LOC_LIVECHAT_CONFIGURATION_CHANNEL_TERMS_DESC, true)}
.helpPage=${'documentation/user/streamers/channel'}>
.helpPage=${'documentation/user/streamers/terms'}>
</livechat-configuration-section-header>
<div class="form-group">
<textarea

View File

@ -7,6 +7,16 @@ chapter: false
This section describes the plugin settings page.
## {{% livechat_label livechat_configuration_channel_terms_label %}}
{{% livechat_label livechat_configuration_channel_terms_desc %}}
For more information on this feature, check the documentation for [channel's terms & conditions](/peertube-plugin-livechat/documentation/user/streamers/terms).
{{% notice info %}}
Changing this settings will restart the chat server, and all users will be disconnected for a short time.
{{% /notice %}}
## {{% livechat_label "list_rooms_label" %}}
When pressing the «List rooms» button, all existing chatrooms will be listed.

View File

@ -20,6 +20,7 @@ By clicking on a channel, you will then be able to setup some options for your c
Here you can configure:
* [{{% livechat_label livechat_configuration_channel_terms_label %}}](/peertube-plugin-livechat/documentation/user/streamers/terms)
* [{{% livechat_label livechat_configuration_channel_mute_anonymous_label %}}](/peertube-plugin-livechat/documentation/user/streamers/moderation) default value
* [The slow mode](/peertube-plugin-livechat/documentation/user/streamers/slow_mode)
* [The chat bot](/peertube-plugin-livechat/documentation/user/streamers/bot)

View File

@ -1,7 +1,7 @@
---
title: "Custom emojis"
description: "Plugin peertube-plugin-livechat custom emojis"
weight: 32
weight: 33
chapter: false
---

View File

@ -1,7 +1,7 @@
---
title: "Slow mode"
description: "Plugin peertube-plugin-livechat slow mode"
weight: 31
weight: 32
chapter: false
---

View File

@ -0,0 +1,42 @@
---
title: "Terms & conditions"
description: "Configure channel's chat terms & conditions"
weight: 31
chapter: false
---
{{% notice info %}}
This feature comes with the livechat plugin version 10.2.0.
{{% /notice %}}
## Configuration
You can add terms & conditions to your channel.
These terms will be shown to all users joining the chat.
To configure the terms & conditions, go to the [channel configuration page](/peertube-plugin-livechat/documentation/user/streamers/channel):
![Channel configuration / Terms](/peertube-plugin-livechat/images/channel_terms_config.png?classes=shadow,border&height=400px)
URL in the message will be clickable.
You can also do some styling: [Message Styling](https://xmpp.org/extensions/xep-0393.html).
## Viewers
When joining the chat, viewers will see the terms:
![Terms](/peertube-plugin-livechat/images/terms.png?classes=shadow,border&height=400px)
{{% notice info %}}
Peertube instance's admin can also set global terms & conditions.
If so, these terms will be shown above your channel's terms.
{{% /notice %}}
{{% notice info %}}
Anonymous users will only see the terms & conditions once they have chosen their nickname (in other words: once they are able to talk).
{{% /notice %}}
You can change the terms content at any time, it will be instantly updated for all viewers.
Users can hide the terms & conditions.
When doing so, terms won't be shown again, unless you change the content.

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB