diff --git a/support/documentation/content/en/documentation/user/streamers/moderation_notes.md b/support/documentation/content/en/documentation/user/streamers/moderation_notes.md new file mode 100644 index 00000000..00ef2acb --- /dev/null +++ b/support/documentation/content/en/documentation/user/streamers/moderation_notes.md @@ -0,0 +1,90 @@ +--- +title: "Moderation notes" +description: "Plugin peertube-plugin-livechat moderation notes" +weight: 355 +chapter: false +--- + +{{% notice info %}} +This feature comes with the livechat plugin version 11.0.0. +{{% /notice %}} + +## Introduction + +The livechat plugin includes a Moderator Notes Application: you can write some notes, that could be associated to chat participants. +Every room's admins have access to these notes, so they can edit them collaboratively. + +You can for example use this Application to: + +* share some notes between moderators +* take notes about participants that were kicked or caused troubles +* ... + +## Using the Moderator Notes Application + +### Opening the Moderator Notes Application + +To open the Moderator Notes Application, there is a "{{% livechat_label "moderator_notes" %}}" button in the top chat menu: + +![Opening the Moderator Notes Application](/peertube-plugin-livechat/images/moderation_notes_open_app_video.png?classes=shadow,border&height=200px) + +![Opening the Moderator Notes Application](/peertube-plugin-livechat/images/moderation_notes_open_app_fullpage.png?classes=shadow,border&height=200px) + +Clicking this button will toggle the Application display: + +![Moderator Notes Application](/peertube-plugin-livechat/images/moderator_notes_app_video_1.png?classes=shadow,border&height=200px) + +![Moderator Notes Application](/peertube-plugin-livechat/images/moderator_notes_app_fullpage_1.png?classes=shadow,border&height=200px) + +{{% notice tip %}} +To have more space and better readability, open the chat in full-page mode. +{{% /notice %}} + +### Access rights + +Every room's admins have access to this Application (read and write access). + +When you promote someone as room admin or owner, they gets instant access to this Application. +When you remove admin or owner rights to someone, they instantly lose access to this Application. + +### Notes + +#### Create/Edit Notes + +You can use the plus button on the top to create a new note. +You can also edit existing notes using the edit button, or delate any note. + +{{% notice tip %}} +All modification are instantly visible in all your browser tabs, and for all room's admins. +{{% /notice %}} + +You can create a note associated to a participant in several ways: + +* using the "{{% livechat_label moderator_note_create_for_participant %}}" action in the dropdown menu besides chat messages + +When a note is associated to a participant, you will see their nickname and avatar on the top of the note. + +#### Notes filtering + +You can filter notes to find all notes related to a given participant in several ways: + +* click on the "{{% livechat_label moderator_note_search_for_participant %}}" button that is available on notes to find all notes related to the same participant +* click on the "{{% livechat_label moderator_note_search_for_participant %}}" button in the dropdown menu besides chat messages + +You can remove the filter by clicking on the close button. + +![Moderator Notes Application - filtering](/peertube-plugin-livechat/images/moderation_notes_filters.png?classes=shadow,border&height=200px) + +When you filters notes on a participant, there are several informations that are shown at the right of the participant nickname: + +* if the current nickname is different than the nickname when you created the note, the original nickname will be shown +* you will see the [JID (Jabber ID)](https://xmpp.org/extensions/xep-0029.html) of the participant +* you will also see the [occupant-id](https://xmpp.org/extensions/xep-0421.html) of the participant + +The search result will also include all notes related to participants who had the same nickname. +So you can also take note for anonymous users (who don't have any consistent JID or occupant-id). +You can differenciate them by comparing JID and occupant-id. + +#### Sorting notes + +You can sort notes simply using drag & drop. diff --git a/support/documentation/content/en/images/moderation_notes_filters.png b/support/documentation/content/en/images/moderation_notes_filters.png new file mode 100644 index 00000000..1eed5de4 Binary files /dev/null and b/support/documentation/content/en/images/moderation_notes_filters.png differ diff --git a/support/documentation/content/en/images/moderation_notes_open_app_fullpage.png b/support/documentation/content/en/images/moderation_notes_open_app_fullpage.png new file mode 100644 index 00000000..4a461645 Binary files /dev/null and b/support/documentation/content/en/images/moderation_notes_open_app_fullpage.png differ diff --git a/support/documentation/content/en/images/moderation_notes_open_app_video.png b/support/documentation/content/en/images/moderation_notes_open_app_video.png new file mode 100644 index 00000000..18e2b819 Binary files /dev/null and b/support/documentation/content/en/images/moderation_notes_open_app_video.png differ diff --git a/support/documentation/content/en/images/moderator_notes_app_fullpage_1.png b/support/documentation/content/en/images/moderator_notes_app_fullpage_1.png new file mode 100644 index 00000000..3f691d80 Binary files /dev/null and b/support/documentation/content/en/images/moderator_notes_app_fullpage_1.png differ diff --git a/support/documentation/content/en/images/moderator_notes_app_video_1.png b/support/documentation/content/en/images/moderator_notes_app_video_1.png new file mode 100644 index 00000000..3ec9d5ad Binary files /dev/null and b/support/documentation/content/en/images/moderator_notes_app_video_1.png differ