Documentation update.

This commit is contained in:
John Livingston
2024-04-11 12:41:25 +02:00
parent 4948d27fae
commit 749e56d9cb
39 changed files with 1345 additions and 3038 deletions

View File

@ -65,9 +65,9 @@ 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".
[Open the chat dropdown menu](/peertube-plugin-livechat/documentation/user/viewers), and click on "Configure".
![Top menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
![Chat menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
There are several options that can be changed.
@ -81,9 +81,7 @@ By unchecking "Persistent", the room will be cleared if there is no more partici
## 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".
If you want to delete the chat content, [open the chat dropdown menu](/peertube-plugin-livechat/documentation/user/viewers), then 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.

View File

@ -16,10 +16,9 @@ Check [the chat bot documentation](/peertube-plugin-livechat/documentation/user/
## Accessing moderation tools
You can access room settings and moderation tools by opening the chat in a new window,
and using the dropdown menu at the top right.
You can access room settings and moderation tools using the [chat dropdown menu](/peertube-plugin-livechat/documentation/user/viewers) at the top of the chat.
![Top menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
![Chat menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
{{% notice tip %}}
All instance moderators and admins will be owner of created chat rooms.

View File

@ -77,6 +77,14 @@ To see the list of participants, just open the right menu:
You can see that some participants have special rights (moderator, owner, ...).
## Chat dropdown menu
There is a dropdown menu on the top of the chat, with some advanced features.
This is especially useful for [moderation features](/peertube-plugin-livechat/documentation/user/streamers/moderation).
Available features depends on your access level.
![Chat menu](/peertube-plugin-livechat/images/top_menu.png?classes=shadow,border&height=200px)
## Opening full screen
On top of the chat, there is a button to open the chat in fullscreen.
@ -86,11 +94,8 @@ 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/streamers/moderation).
## Changing nickname
You can change your nickname by typing `/nick your_new_nickname` in the message field.
You can also change your nickname using the top menu when you are in fullscreen mode.
You can also change your nickname using the chat menu.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 14 KiB