From 6a10de27fbc19db4225757707401525f5c6e4a82 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 14 Apr 2025 22:56:12 +0200 Subject: [PATCH 1/2] fix(user): Split talk user documentation into pieces Signed-off-by: Joas Schilling --- user_manual/talk/advanced_features.rst | 232 ------------- user_manual/talk/attachments.rst | 33 ++ user_manual/talk/bots.rst | 21 ++ user_manual/talk/breakout_rooms.rst | 51 +++ user_manual/talk/call.rst | 74 +++++ user_manual/talk/call_index.rst | 10 + user_manual/talk/call_recording.rst | 68 ++++ user_manual/talk/chat.rst | 107 ++++++ user_manual/talk/chat_index.rst | 11 + user_manual/talk/conversation_index.rst | 10 + user_manual/talk/conversations.rst | 82 +++++ user_manual/talk/federation.rst | 37 +++ user_manual/talk/files_integration.rst | 27 ++ ..._a_call_or_chat_as_guest.rst => guest.rst} | 2 + user_manual/talk/index.rst | 7 +- user_manual/talk/matterbridge.rst | 24 ++ user_manual/talk/message_integrations.rst | 35 ++ user_manual/talk/messages.rst | 46 +++ user_manual/talk/open_conversations.rst | 17 + user_manual/talk/talk_basics.rst | 313 ------------------ user_manual/talk/webinar.rst | 14 + 21 files changed, 673 insertions(+), 548 deletions(-) delete mode 100644 user_manual/talk/advanced_features.rst create mode 100644 user_manual/talk/attachments.rst create mode 100644 user_manual/talk/bots.rst create mode 100644 user_manual/talk/breakout_rooms.rst create mode 100644 user_manual/talk/call.rst create mode 100644 user_manual/talk/call_index.rst create mode 100644 user_manual/talk/call_recording.rst create mode 100644 user_manual/talk/chat.rst create mode 100644 user_manual/talk/chat_index.rst create mode 100644 user_manual/talk/conversation_index.rst create mode 100644 user_manual/talk/conversations.rst create mode 100644 user_manual/talk/federation.rst create mode 100644 user_manual/talk/files_integration.rst rename user_manual/talk/{join_a_call_or_chat_as_guest.rst => guest.rst} (97%) create mode 100644 user_manual/talk/matterbridge.rst create mode 100644 user_manual/talk/message_integrations.rst create mode 100644 user_manual/talk/messages.rst create mode 100644 user_manual/talk/open_conversations.rst delete mode 100644 user_manual/talk/talk_basics.rst create mode 100644 user_manual/talk/webinar.rst diff --git a/user_manual/talk/advanced_features.rst b/user_manual/talk/advanced_features.rst deleted file mode 100644 index c6078101459..00000000000 --- a/user_manual/talk/advanced_features.rst +++ /dev/null @@ -1,232 +0,0 @@ -Advanced Talk features -====================== - -Nextcloud Talk has a number of advanced features users might find useful. - -Matterbridge ------------- - -Matterbridge integration in Nextcloud Talk makes it possible to create 'bridges' between Talk conversations and conversations on other chat services like MS Teams, Discord, Matrix and others. You can find a list of supported protocols `on the Matterbridge github page. `_ - -A moderator can add a Matterbridge connection in the chat conversation settings. - -.. image:: images/matterbridge-settings.png - :width: 700px - -Each of the bridges has its own need in terms of configuration. Information for most is available on the Matterbridge wiki and can be accessed behind ``more information`` menu in the ``...`` menu. You can also `access the wiki directly. `_ - -Lobby ------ - -The lobby feature allows you to show guests a waiting screen until the call starts. This is ideal for webinars with external participants, for example. - -.. image:: images/lobby-in-talk.png - :width: 600px - -You can choose to let the participants join the call at a specific time, or when you dismiss the lobby manually. - -Commands --------- - -Nextcloud allows users to execute actions using commands. A command typically looks like: - - ``/wiki airplanes`` - -Administrators can configure, enable and disable commands. Users can use the ``help`` command to find out what commands are available. - - ``/help`` - -.. image:: images/command-help.png - :width: 600px - -Find more information in the `administrative documentation for Talk. `_ - -Talk from Files ---------------- - -In the Files app, you can chat about files in the sidebar, and even have a call while editing it. You first have to join the chat. - -.. image:: images/join-chat.png - :width: 500px - -| - -.. image:: images/sidebar-chat.png - :width: 500px - -You can then chat or have a call with other participants, even when you start editing the file. - -.. image:: images/text-and-talk.png - :width: 700px - -In Talk, a conversation will be created for the file. You can chat from there, or go back to the file using the ``...`` menu in the top-right. - -.. image:: images/file-room.png - :width: 400px - -Create tasks from chat or share tasks in chat ---------------------------------------------- - -If Deck is installed, you can use the ``...`` menu of a chat message and turn the message into a Deck task. - -.. image:: images/deck-talk-create-card-menu.png - :width: 500px - -| - -.. image:: images/deck-talk-create-card-dialog.png - :width: 400px - -From within Deck, you can share tasks into chat conversations. - -.. image:: images/deck-talk-share-card-to-chat-menu.png - :width: 400px - -| - -.. image:: images/deck-talk-share-card-to-chat-in-talk.png - :width: 600px - -Breakout rooms --------------- -Breakout rooms allow you to divide a Nextcloud Talk call into smaller groups for more focused discussions. The moderator -of the call can create multiple breakout rooms and assign participants to each room. - -.. note:: Breakout rooms are currently not available in conversations that are joinable by guests (public conversations). - -Configure breakout rooms -^^^^^^^^^^^^^^^^^^^^^^^^ - -To create breakout rooms, you need to be a moderator in a group conversation. Click on the top-bar menu and click on -"Setup breakout rooms". - -.. image:: images/talk-breakout-rooms-setup.png - :width: 400px - -A dialog will open where you can specify the number of rooms you want to create and the participants assignment method. -Here you'll be presented with 3 options: - -- **Automatically assign participants**: Talk will automatically assign participants to the rooms. -- **Manually assign participants**: You'll go through a participants editor where you can assign participants to rooms. -- **Allow participants choose**: Participants will be able to join breakout rooms themselves. - -.. image:: images/talk-breakout-rooms-setup-dialog.png - :width: 500px - -Manage breakout rooms -^^^^^^^^^^^^^^^^^^^^^ - -Once the breakout rooms are created, you will be able to see them in the sidebar. - -.. image:: images/talk-breakout-rooms-sidebar.png - :width: 500px - -From the sidebar header - -- **Start and stop the breakout rooms**: this will move all the users in the parent conversation to their respective breakout rooms. -- **Broadcast a message to all the rooms**: this will send a message to all the rooms at the same time. -- **Make changes to the assigned participants**: this will open the participants editor where you can change which participants are assigned to which breakout room. From this dialog it's also possible to delete the breakout rooms. - -.. image:: images/talk-breakout-rooms-sidebar-header.png - :width: 400px - -From the breakout room element in the sidebar, you can also join a particular breakout room or send a message to a -specific room. - -.. image:: images/talk-breakout-rooms-sidebar-item.png - :width: 400px - -Call recording --------------- -The recording feature provides users with an opportunity to: - -- Start and stop recordings during a call. -- Record the video and audio stream of the speaker, as well as screen share. -- Access, share and download recorded files for future reference or distribution. - -Enabling this feature requires the recording server to be set up by the system administration. - -Manage a recording -^^^^^^^^^^^^^^^^^^ - -The moderator of the conversation can start a recording together with a call start or anytime during a call: - -- **Before the call**: tick the checkbox "Start recording immediately with the call" in "Media settings", then click on "Start call". -- **During the call**: click on the top-bar menu, then click "Start recording". - -.. image:: images/start-recording-before-call.png - :width: 400px - -| - -.. image:: images/start-recording-in-call.png - :width: 300px - -The recording will start shortly, and you will see a red indicator next to the call time. You can stop the recording at any time while the call is still ongoing by clicking on that indicator and selecting "Stop recording", or by using the same action in the top-bar menu. If you do not manually stop the recording, it will end automatically when the call ends. - -.. image:: images/stop-recording.png - :width: 500px - -After stopping a recording, the server will take some time to prepare and save the recorded file. The moderator, who started the recording, receives a notification when the file is uploaded. From there, it can be shared in the chat. - -.. image:: images/share-recording-notification.png - :width: 300px - -| - -.. image:: images/shared-recordings.png - :width: 400px - -Recording consent -^^^^^^^^^^^^^^^^^ - -For compliance reasons with various privacy rights, it is possible to ask participants for consent to be recorded before joining the call. The system administration has the flexibility to utilize this feature in several ways: - -- Disable consent completely. -- Enable mandatory consent system-wide, requiring consent for all conversations. -- Allow moderators to configure this option on a conversation level. In such cases, moderators can access the conversation settings to configure this option accordingly: - -.. image:: images/enable-recording-consent.png - :width: 500px - -If recording consent is enabled, every participant, including moderators, will see a highlighted section in the "Media settings" before joining a call. -This section informs participants that the call may be recorded. To give explicit consent for recording, participants must check the box. If they do not give consent, they will not be allowed to join the call. - -.. image:: images/give-recording-consent.png - :width: 500px - -| - -.. image:: images/give-recording-consent-checked.png - :width: 500px - -Federated conversation ----------------------- -With Federation feature, users can create conversations across different federated Talk instances and use Talk features as if they were on a same server. - -**Important** Under current development. Basic chat features are available, more to come in the future! - -Feature is required to be set up by the system administration. - -Send and accept invites -^^^^^^^^^^^^^^^^^^^^^^^ - -The moderator of the conversation can send an invite to participant on a different server: - -.. image:: images/federation-invite-send.png - :width: 400px - -When receiving a notification, user will see a counter of pending invites above the conversations list. - -.. image:: images/federation-invite-pending.png - :width: 400px - -Upon clicking it, more information will be provided about inviting party, and user can either accept or decline the invitation. - -.. image:: images/federation-invite-dialog.png - :width: 500px - -By accepting the invite, conversation will appear in the list as any other one. - -.. image:: images/federation-conversations-list.png - :width: 400px diff --git a/user_manual/talk/attachments.rst b/user_manual/talk/attachments.rst new file mode 100644 index 00000000000..bcfd4a07539 --- /dev/null +++ b/user_manual/talk/attachments.rst @@ -0,0 +1,33 @@ +=========== +Attachments +=========== + +Sharing files in a chat +----------------------- + +You can share files in a chat in 3 ways. + +First, you can simply drag'n'drop them on the chat. + +.. image:: images/drag-and-drop.png + :width: 600px + +Second, you can select a file from your Nextcloud Files or a file manager by choosing the little paperclip and selecting where you'd like to pick the file from. + +.. image:: images/share-files-in-chat.png + :width: 500px + +.. image:: images/share-files-in-chat-selection.png + :width: 600px + +You can add more files until you are done and decide to share the files. You can also add a text caption to your shared files, providing a brief description or context. + +.. image:: images/talk-upload-files.png + :width: 500px + +All users will be able to click the files to view, edit or download them, irrespective of them having a user account. Users with an account will have the file automatically shared with them while external guest users will get them shared as a public link. + +.. image:: images/editing-document-in-chat-room.png + :width: 600px + +.. FIXME Add polls, voice messages?, shared items view \ No newline at end of file diff --git a/user_manual/talk/bots.rst b/user_manual/talk/bots.rst new file mode 100644 index 00000000000..9dd7f1adca4 --- /dev/null +++ b/user_manual/talk/bots.rst @@ -0,0 +1,21 @@ +:orphan: +Bots +==== + +.. FIXME Replace with bots as commands are removed, or remove? + +Commands +-------- + +Nextcloud allows users to execute actions using commands. A command typically looks like: + + ``/wiki airplanes`` + +Administrators can configure, enable and disable commands. Users can use the ``help`` command to find out what commands are available. + + ``/help`` + +.. image:: images/command-help.png + :width: 600px + +Find more information in the `administrative documentation for Talk. `_ diff --git a/user_manual/talk/breakout_rooms.rst b/user_manual/talk/breakout_rooms.rst new file mode 100644 index 00000000000..8602d1b8b94 --- /dev/null +++ b/user_manual/talk/breakout_rooms.rst @@ -0,0 +1,51 @@ +Breakout rooms +============== + +Breakout rooms allow you to divide a Nextcloud Talk call into smaller groups for more focused discussions. The moderator +of the call can create multiple breakout rooms and assign participants to each room. + +.. note:: Breakout rooms are currently not available in conversations that are joinable by guests (public conversations). + +Configure breakout rooms +------------------------ + +To create breakout rooms, you need to be a moderator in a group conversation. Click on the top-bar menu and click on +"Setup breakout rooms". + +.. image:: images/talk-breakout-rooms-setup.png + :width: 400px + +A dialog will open where you can specify the number of rooms you want to create and the participants assignment method. +Here you'll be presented with 3 options: + +- **Automatically assign participants**: Talk will automatically assign participants to the rooms. +- **Manually assign participants**: You'll go through a participants editor where you can assign participants to rooms. +- **Allow participants choose**: Participants will be able to join breakout rooms themselves. + +.. image:: images/talk-breakout-rooms-setup-dialog.png + :width: 500px + +Manage breakout rooms +--------------------- + +Once the breakout rooms are created, you will be able to see them in the sidebar. + +.. image:: images/talk-breakout-rooms-sidebar.png + :width: 500px + +From the sidebar header + +- **Start and stop the breakout rooms**: this will move all the users in the parent conversation to their respective breakout rooms. +- **Broadcast a message to all the rooms**: this will send a message to all the rooms at the same time. +- **Make changes to the assigned participants**: this will open the participants editor where you can change which participants are assigned to which breakout room. From this dialog it's also possible to delete the breakout rooms. + +.. image:: images/talk-breakout-rooms-sidebar-header.png + :width: 400px + +From the breakout room element in the sidebar, you can also join a particular breakout room or send a message to a +specific room. + +.. image:: images/talk-breakout-rooms-sidebar-item.png + :width: 400px + +.. FIXME Ask for assistance, demo "free selection for a user" \ No newline at end of file diff --git a/user_manual/talk/call.rst b/user_manual/talk/call.rst new file mode 100644 index 00000000000..cb58372628c --- /dev/null +++ b/user_manual/talk/call.rst @@ -0,0 +1,74 @@ +==== +Call +==== + +Starting a call +--------------- + +When you're in a conversation, you can start a call any time with the ``Start call`` button. Other participants will get notified and can join the call. + +.. image:: images/device-settings-before-call.png + :width: 400px + +If somebody else has started a call already, the button will change in a green ``Join call`` button. + +.. image:: images/join-call.png + :width: 600px + +During a call, you can mute your microphone and disable your video with the buttons on the right side of the top bar, or using the shortcuts ``M`` to mute audio and ``V`` to disable video. You can also use the space bar to toggle mute. When you are muted, pressing space will unmute you so you can speak until you let go of the space bar. If you are unmuted, pressing space will mute you until you let go. + +You can hide your video (useful during a screen share) with the little arrow just above the video stream. Bring it back with the little arrow again. + +You can access your settings and choose a different webcam, microphone and other settings in the ``...`` menu in the top bar. + +.. image:: images/media-settings.png + :width: 300px + +From media settings dialog, you can also change the background of your video. + +.. image:: images/background-settings-in-call.png + :width: 400px + +You can change other settings in the ``Talk settings`` dialog. + +.. image:: images/talk-settings.png + :width: 600px + +Starting a screen share +----------------------- + +You can click the monitor icon on your video stream to share your screen. Depending on your browser, you will get the option to share a monitor, an application window or a single browser tab. +If video from your camera is also available, other participants will see it in a small presenter view next to the screen share. + +.. image:: images/share-screen-with-camera.png + :width: 700px + +Changing view in a call +----------------------- + +You can switch the view in a call with the little four-block icon in the top-right between promoted-view and grid view. The grid view will show everyone equally big and if the people do not fit on the screen, buttons will appear on the left and right that let you navigate. + +.. image:: images/talk-grid-view.png + :width: 700px + +The promoted view shows the speaker large and others in a row below. If the people do not fit on the screen, buttons will appear on the left and right that let you navigate. + +.. image:: images/talk-promoted-view.png + :width: 700px + + + + + + + + + + + + + + + + + diff --git a/user_manual/talk/call_index.rst b/user_manual/talk/call_index.rst new file mode 100644 index 00000000000..870df656e8c --- /dev/null +++ b/user_manual/talk/call_index.rst @@ -0,0 +1,10 @@ +Calls +===== + +.. toctree:: + :maxdepth: 1 + + call + call_recording + webinar + breakout_rooms diff --git a/user_manual/talk/call_recording.rst b/user_manual/talk/call_recording.rst new file mode 100644 index 00000000000..3872909d8b6 --- /dev/null +++ b/user_manual/talk/call_recording.rst @@ -0,0 +1,68 @@ +Call recording +============== + +The recording feature provides users with an opportunity to: + +- Start and stop recordings during a call. +- Record the video and audio stream of the speaker, as well as screen share. +- Access, share and download recorded files for future reference or distribution. + +Enabling this feature requires the recording server to be set up by the system administration. + +Manage a recording +------------------ + +The moderator of the conversation can start a recording together with a call start or anytime during a call: + +- **Before the call**: tick the checkbox "Start recording immediately with the call" in "Media settings", then click on "Start call". +- **During the call**: click on the top-bar menu, then click "Start recording". + +.. image:: images/start-recording-before-call.png + :width: 400px + +| + +.. image:: images/start-recording-in-call.png + :width: 300px + +The recording will start shortly, and you will see a red indicator next to the call time. You can stop the recording at any time while the call is still ongoing by clicking on that indicator and selecting "Stop recording", or by using the same action in the top-bar menu. If you do not manually stop the recording, it will end automatically when the call ends. + +.. image:: images/stop-recording.png + :width: 500px + +After stopping a recording, the server will take some time to prepare and save the recorded file. The moderator, who started the recording, receives a notification when the file is uploaded. From there, it can be shared in the chat. + +.. image:: images/share-recording-notification.png + :width: 300px + +| + +.. image:: images/shared-recordings.png + :width: 400px + +Recording consent +----------------- + +For compliance reasons with various privacy rights, it is possible to ask participants for consent to be recorded before joining the call. The system administration has the flexibility to utilize this feature in several ways: + +- Disable consent completely. +- Enable mandatory consent system-wide, requiring consent for all conversations. +- Allow moderators to configure this option on a conversation level. In such cases, moderators can access the conversation settings to configure this option accordingly: + +.. image:: images/enable-recording-consent.png + :width: 500px + +.. FIXME make screenshots below from user perspective not moderator + +If recording consent is enabled, every participant, including moderators, will see a highlighted section in the "Media settings" before joining a call. +This section informs participants that the call may be recorded. To give explicit consent for recording, participants must check the box. If they do not give consent, they will not be allowed to join the call. + +.. image:: images/give-recording-consent.png + :width: 500px + +| + +.. image:: images/give-recording-consent-checked.png + :width: 500px + +.. FIXME add where they can be rewatched afterwards \ No newline at end of file diff --git a/user_manual/talk/chat.rst b/user_manual/talk/chat.rst new file mode 100644 index 00000000000..513fe15832a --- /dev/null +++ b/user_manual/talk/chat.rst @@ -0,0 +1,107 @@ +================ +Sending messages +================ + +Using Markdown +--------------- + +You can enhance your messages with a markdown syntax support. See list for usage: + +**Headings and dividers** + +.. code-block:: none + + # Heading 1 + ## Heading 2 + ### Heading 3 + #### Heading 4 + ##### Heading 5 + ###### Heading 6 + + Heading + === + Normal text + *** + Normal text + +**Inline decorations** + +.. code-block:: none + + **bold text** __bold text__ + *italicized text* _italicized text_ + `inline code` ``inline code`` + ``` + .code-block { + display: pre; + } + ``` + +**Lists** + +.. code-block:: none + + 1. Ordered list + 2. Ordered list + + * Unordered list + - Unordered list + + Unordered list + +**Quotes** + +.. code-block:: none + + > blockquote + second line of blockquote + +**Task lists** + +.. code-block:: none + + - [ ] task to be done + - [x] completed task + +**Tables** + +.. code-block:: none + + Column A | Column B + -- | -- + Data A | Data B + +Inserting emoji +--------------- + +You can add emoji using the picker on the left of the text input field. + +.. image:: images/emoji-picker.png + :width: 400px + +.. FIXME Smart picker + +.. FIXME Mention integration apps like github, gitlab, giphy, … + +Replying to messages and more +----------------------------- + +You can reply to a message using the arrow that appears when you hover a message. + +.. image:: images/reply.png + :width: 600px + +In the ``...`` menu you can also choose to reply privately. This will open a one-on-one conversation. + +.. image:: images/chat-message-menu.png + :width: 600px + +Here you can also create a direct link to the message or mark it unread so you will scroll back there next time you enter the chat. When it is a file, you can view the file in Files. + +Silent messages +--------------- + +If you don't want to disturb anyone in the middle of the night, there is a silent mode for chatting. +While it is enabled, other participants will not receive notifications from your messages. + +.. image:: images/message-silent.png + :width: 600px diff --git a/user_manual/talk/chat_index.rst b/user_manual/talk/chat_index.rst new file mode 100644 index 00000000000..f3f2ef5fe80 --- /dev/null +++ b/user_manual/talk/chat_index.rst @@ -0,0 +1,11 @@ +Chat +==== + +.. toctree:: + :maxdepth: 1 + + chat + messages + message_integrations + attachments +.. bots diff --git a/user_manual/talk/conversation_index.rst b/user_manual/talk/conversation_index.rst new file mode 100644 index 00000000000..2735419c24f --- /dev/null +++ b/user_manual/talk/conversation_index.rst @@ -0,0 +1,10 @@ +Conversations +============= + +.. toctree:: + :maxdepth: 1 + + conversations + open_conversations + federation + files_integration diff --git a/user_manual/talk/conversations.rst b/user_manual/talk/conversations.rst new file mode 100644 index 00000000000..bf42a96b8ec --- /dev/null +++ b/user_manual/talk/conversations.rst @@ -0,0 +1,82 @@ +============= +Conversations +============= + +Nextcloud Talk lets you chat and have video calls on your own server. + +Chats and calls take place in conversations. You can create any number of conversations. There are two kinds of conversations: + +1. **One-on-one conversations.** This is where you have a private chat or call with another Talk user. You can't add other people to this conversation or share it with a link. You start a direct one-on-one chat by looking for another user in the search bar and then clicking their name. +2. **Group conversations.** Besides the person who created the conversation, a group conversation can have any number of people in it. A group conversation can be shared publicly with a link, so external guest users can join a call. It can also be listed, so other people on your Nextcloud server can join the conversation. + +Creating a conversation +----------------------- + +You can create a direct, one-on-one chat by searching for the name of a user, a group or a team and clicking it. For a single user, a conversation is immediately created and you can start your chat. For a group or circle you get to pick a name and settings before you create the conversation and add the participants. + +.. image:: images/chat-with-one-user.png + :width: 400px + +If you want to create a custom group conversation, click the button next to the search field and filters button and then on ``Create a new conversation``. + +.. image:: images/create-new-conversation.png + :width: 400px + +You can then pick a name for the conversation, put a description, and set up an avatar for it (with uploaded photo or emoji), and select if the conversation should be open to external users and if other users on the server can see and join the conversation. + +.. image:: images/creating-open-conversation.png + :width: 500px + +In the second step, you get to add participants and finalize the creation of the conversation. + +.. image:: images/add-participants.png + :width: 500px + +After confirmation you will be redirected to the new conversation and can start communicating right away. + +.. image:: images/new-room.png + :width: 700px + +Filter your conversations +------------------------- + +You can filter your conversations using the filter button located next to the search field. There are two options for filtering: +1. Filter unread mentions: This option allows you to view group conversations with unread mentions or unread one-on-one conversations. +2. Filter unread messages: This option allows you to view all unread messages in all joined conversations. + +.. image:: images/filters-menu.png + :width: 400px + +You can then clear the filter from the filters menu. + +.. image:: images/clear-filter.png + :width: 400px + +Managing a conversation +----------------------- + +You are always moderator in your new conversation. In the participant list you can promote other participants to moderators using the ``...`` menu to the right of their user name, assign them custom permissions or remove them from the conversation. + +Changing permissions of a user that joined a public conversation will also permanently add them to the conversation. + +.. image:: images/participant-menu.png + :width: 400px + +Moderators can configure the conversation. Select ``Conversation settings`` from the ``...`` menu of the conversation on the top to access the settings. + +.. image:: images/open-settings.png + :width: 400px + +Here you can configure the description, guest access, if the conversation is visible to others on the server and more. + +.. image:: images/conversation-settings-dialog.png + :width: 600px + +Messages expiration +------------------- + +A moderator can configure message expiration under the ``Conversation settings`` within the ``Moderation`` section. Once a message reaches its expiration time, it is automatically removed from the conversation. +The available expiration durations are 1 hour, 8 hours, 1 day, 1 week, 4 weeks, or never (which is the default setting). + +.. image:: images/messages-expiration.png + :width: 500px diff --git a/user_manual/talk/federation.rst b/user_manual/talk/federation.rst new file mode 100644 index 00000000000..515287ab773 --- /dev/null +++ b/user_manual/talk/federation.rst @@ -0,0 +1,37 @@ +Federation +========== +With Federation feature, users can create conversations across different federated Talk instances and use Talk features as if they were on a same server. + +.. FIXME clarify the statement + +**Important** Under current development. Basic chat features are available, more to come in the future! + +Feature is required to be set up by the system administration. + +Sending an invitation +--------------------- + +.. FIXME document where a user can find their CloudID to get invited + +The moderator of the conversation can send an invite to participant on a different server: + +.. image:: images/federation-invite-send.png + :width: 400px + +Accepting an invitation +----------------------- + +When receiving a notification, user will see a counter of pending invites above the conversations list. + +.. image:: images/federation-invite-pending.png + :width: 400px + +Upon clicking it, more information will be provided about inviting party, and user can either accept or decline the invitation. + +.. image:: images/federation-invite-dialog.png + :width: 500px + +By accepting the invite, conversation will appear in the list as any other one. + +.. image:: images/federation-conversations-list.png + :width: 400px diff --git a/user_manual/talk/files_integration.rst b/user_manual/talk/files_integration.rst new file mode 100644 index 00000000000..52c93a039af --- /dev/null +++ b/user_manual/talk/files_integration.rst @@ -0,0 +1,27 @@ +Files integration +================= + +Talk from Files +--------------- + +In the Files app, you can chat about files in the sidebar, and even have a call while editing it. You first have to join the chat. + +.. image:: images/join-chat.png + :width: 500px + +| + +.. image:: images/sidebar-chat.png + :width: 500px + +You can then chat or have a call with other participants, even when you start editing the file. + +.. image:: images/text-and-talk.png + :width: 700px + +In Talk, a conversation will be created for the file. You can chat from there, or go back to the file using the ``...`` menu in the top-right. + +.. image:: images/file-room.png + :width: 400px + +.. FIXME Add video verification for public shares \ No newline at end of file diff --git a/user_manual/talk/join_a_call_or_chat_as_guest.rst b/user_manual/talk/guest.rst similarity index 97% rename from user_manual/talk/join_a_call_or_chat_as_guest.rst rename to user_manual/talk/guest.rst index 004b561d8a1..35bd3f59309 100644 --- a/user_manual/talk/join_a_call_or_chat_as_guest.rst +++ b/user_manual/talk/guest.rst @@ -6,6 +6,8 @@ a web interface as well as mobile apps. You can find out more about Nextcloud Talk `on our website `_. +.. FIXME Link to dedicated pages and keep this one as a "quick intro" + Joining a chat -------------- diff --git a/user_manual/talk/index.rst b/user_manual/talk/index.rst index 6b01b344965..2625bf79585 100644 --- a/user_manual/talk/index.rst +++ b/user_manual/talk/index.rst @@ -12,6 +12,7 @@ You can find out more about Nextcloud Talk `on our website `_ + +A moderator can add a Matterbridge connection in the chat conversation settings. + +.. image:: images/matterbridge-settings.png + :width: 700px + +Each of the bridges has its own need in terms of configuration. Information for most is available on the Matterbridge wiki and can be accessed behind ``more information`` menu in the ``...`` menu. You can also `access the wiki directly. `_ + +Lobby +----- + +The lobby feature allows you to show guests a waiting screen until the call starts. This is ideal for webinars with external participants, for example. + +.. image:: images/lobby-in-talk.png + :width: 600px + +You can choose to let the participants join the call at a specific time, or when you dismiss the lobby manually. diff --git a/user_manual/talk/message_integrations.rst b/user_manual/talk/message_integrations.rst new file mode 100644 index 00000000000..3a521d4af6d --- /dev/null +++ b/user_manual/talk/message_integrations.rst @@ -0,0 +1,35 @@ +============================== +Apps integrating with messages +============================== + +.. FIXME Mention integration with Notes, Tasks, … + +Deck +---- + +Create tasks from chat message +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If Deck is installed, you can use the ``...`` menu of a chat message and turn the message into a Deck card. + +.. image:: images/deck-talk-create-card-menu.png + :width: 500px + +| + +.. image:: images/deck-talk-create-card-dialog.png + :width: 400px + + +Share card into a chat +^^^^^^^^^^^^^^^^^^^^^^ + +From within Deck, you can share cards into a chat. + +.. image:: images/deck-talk-share-card-to-chat-menu.png + :width: 400px + +| + +.. image:: images/deck-talk-share-card-to-chat-in-talk.png + :width: 600px diff --git a/user_manual/talk/messages.rst b/user_manual/talk/messages.rst new file mode 100644 index 00000000000..07ddef7d846 --- /dev/null +++ b/user_manual/talk/messages.rst @@ -0,0 +1,46 @@ +========================= +Interacting with messages +========================= + +Editing messages +---------------- + +You can edit messages and captions to file shares up to 6 hours after sending. + +.. image:: images/message-editing.png + :width: 600px + +Setting reminder on messages +---------------------------- + +You can set reminders on specific messages. If there's an important message you want to be notified about later, simply hover over it and click on the reminder icon. + +.. image:: images/set-message-reminder.png + :width: 400px + +In the submenu, you can select an appropriate time to receive a notification later. + +.. image:: images/configure-message-reminder.png + :width: 400px + +Silent messages +--------------- + +If you don't want to disturb anyone in the middle of the night, there is a silent mode for chatting. +While it is enabled, other participants will not receive notifications from your messages. + +.. image:: images/message-silent.png + :width: 600px + +Messages expiration +------------------- + +.. FIXME Duplicate with conversation management but worth it? + +A moderator can configure message expiration under the ``Conversation settings`` within the ``Moderation`` section. Once a message reaches its expiration time, it is automatically removed from the conversation. +The available expiration durations are 1 hour, 8 hours, 1 day, 1 week, 4 weeks, or never (which is the default setting). + +.. image:: images/messages-expiration.png + :width: 500px + +.. FIXME Mention integration with Note-to-self and Forwarding diff --git a/user_manual/talk/open_conversations.rst b/user_manual/talk/open_conversations.rst new file mode 100644 index 00000000000..9e6aae8f097 --- /dev/null +++ b/user_manual/talk/open_conversations.rst @@ -0,0 +1,17 @@ +================== +Open Conversations +================== + +Creating an open conversation +----------------------------- + +.. image:: images/creating-open-conversation.png + :width: 500px + +View all open conversations +--------------------------- + +You can view all the conversations that you can join by clicking the button next to the search field and filters button and then on ``Join open conversations.`` + +.. image:: images/join-open-conversations.png + :width: 400px diff --git a/user_manual/talk/talk_basics.rst b/user_manual/talk/talk_basics.rst deleted file mode 100644 index 4b56e58c624..00000000000 --- a/user_manual/talk/talk_basics.rst +++ /dev/null @@ -1,313 +0,0 @@ -======================== -Basics of Nextcloud Talk -======================== - -Nextcloud Talk lets you chat and have video calls on your own server. - -Chats and calls take place in conversations. You can create any number of conversations. There are two kinds of conversations: - -1. **One-on-one conversations.** This is where you have a private chat or call with another Talk user. You can't add other people to this conversation or share it with a link. You start a direct one-on-one chat by looking for another user in the search bar and then clicking their name. - - -2. **Group conversations.** Besides the person who created the conversation, a group conversation can have any number of people in it. A group conversation can be shared publicly with a link, so external guest users can join a call. It can also be listed, so other people on your Nextcloud server can join the conversation. - -Creating a chat ---------------- - -You can create a direct, one-on-one chat by searching for the name of a user, a group or a team and clicking it. For a single user, a conversation is immediately created and you can start your chat. For a group or circle you get to pick a name and settings before you create the conversation and add the participants. - -.. image:: images/chat-with-one-user.png - :width: 400px - -If you want to create a custom group conversation, click the button next to the search field and filters button and then on ``Create a new conversation``. - -.. image:: images/create-new-conversation.png - :width: 400px - -You can then pick a name for the conversation, put a description, and set up an avatar for it (with uploaded photo or emoji), and select if the conversation should be open to external users and if other users on the server can see and join the conversation. - -.. image:: images/creating-open-conversation.png - :width: 500px - -In the second step, you get to add participants and finalize the creation of the conversation. - -.. image:: images/add-participants.png - :width: 500px - -After confirmation you will be redirected to the new conversation and can start communicating right away. - -.. image:: images/new-room.png - :width: 700px - -View all open conversations ---------------------------- - -You can view all the conversations that you can join by clicking the button next to the search field and filters button and then on ``Join open conversations.`` - -.. image:: images/join-open-conversations.png - :width: 400px - -Filter your conversations -------------------------- - -You can filter your conversations using the filter button located next to the search field. There are two options for filtering: -1. Filter unread mentions: This option allows you to view group conversations with unread mentions or unread one-on-one conversations. -2. Filter unread messages: This option allows you to view all unread messages in all joined conversations. - -.. image:: images/filters-menu.png - :width: 400px - -You can then clear the filter from the filters menu. - -.. image:: images/clear-filter.png - :width: 400px - -Sharing files in a chat ------------------------ - -You can share files in a chat in 3 ways. - -First, you can simply drag'n'drop them on the chat. - -.. image:: images/drag-and-drop.png - :width: 600px - -Second, you can select a file from your Nextcloud Files or a file manager by choosing the little paperclip and selecting where you'd like to pick the file from. - -.. image:: images/share-files-in-chat.png - :width: 500px - -.. image:: images/share-files-in-chat-selection.png - :width: 600px - -You can add more files until you are done and decide to share the files. You can also add a text caption to your shared files, providing a brief description or context. - -.. image:: images/talk-upload-files.png - :width: 500px - -All users will be able to click the files to view, edit or download them, irrespective of them having a user account. Users with an account will have the file automatically shared with them while external guest users will get them shared as a public link. - -.. image:: images/editing-document-in-chat-room.png - :width: 600px - -Inserting emoji ---------------- - -You can add emoji using the picker on the left of the text input field. - -.. image:: images/emoji-picker.png - :width: 400px - -Editing messages ----------------- - -You can edit messages and captions to file shares up to 6 hours after sending. - -.. image:: images/message-editing.png - :width: 600px - -Using Markdown ---------------- - -You can enhance your messages with a markdown syntax support. See list for usage: - -**Headings and dividers** - -.. code-block:: none - - # Heading 1 - ## Heading 2 - ### Heading 3 - #### Heading 4 - ##### Heading 5 - ###### Heading 6 - - Heading - === - Normal text - *** - Normal text - -**Inline decorations** - -.. code-block:: none - - **bold text** __bold text__ - *italicized text* _italicized text_ - `inline code` ``inline code`` - ``` - .code-block { - display: pre; - } - ``` - -**Lists** - -.. code-block:: none - - 1. Ordered list - 2. Ordered list - - * Unordered list - - Unordered list - + Unordered list - -**Quotes** - -.. code-block:: none - - > blockquote - second line of blockquote - -**Task lists** - -.. code-block:: none - - - [ ] task to be done - - [x] completed task - -**Tables** - -.. code-block:: none - - Column A | Column B - -- | -- - Data A | Data B - -Setting reminder on messages ----------------------------- - -You can set reminders on specific messages. If there's an important message you want to be notified about later, simply hover over it and click on the reminder icon. - -.. image:: images/set-message-reminder.png - :width: 400px - -In the submenu, you can select an appropriate time to receive a notification later. - -.. image:: images/configure-message-reminder.png - :width: 400px - -Replying to messages and more ------------------------------ - -You can reply to a message using the arrow that appears when you hover a message. - -.. image:: images/reply.png - :width: 600px - -In the ``...`` menu you can also choose to reply privately. This will open a one-on-one chat. - -.. image:: images/chat-message-menu.png - :width: 600px - -Here you can also create a direct link to the message or mark it unread so you will scroll back there next time you enter the chat. When it is a file, you can view the file in Files. - -Silent messages ---------------- - -If you don't want to disturb anyone in the middle of the night, there is a silent mode for chatting. -While it is enabled, other participants will not receive notifications from your messages. - -.. image:: images/message-silent.png - :width: 600px - -Managing a conversation ------------------------ - -You are always moderator in your new conversation. In the participant list you can promote other participants to moderators using the ``...`` menu to the right of their user name, assign them custom permissions or remove them from the conversation. - -Changing permissions of a user that joined a public conversation will also permanently add them to the conversation. - -.. image:: images/participant-menu.png - :width: 400px - -Moderators can configure the conversation. Select ``Conversation settings`` from the ``...`` menu of the conversation on the top to access the settings. - -.. image:: images/open-settings.png - :width: 400px - -Here you can configure the description, guest access, if the conversation is visible to others on the server and more. - -.. image:: images/conversation-settings-dialog.png - :width: 600px - -Messages expiration -------------------- - -A moderator can configure message expiration under the ``Conversation settings`` within the ``Moderation`` section. Once a message reaches its expiration time, it is automatically removed from the conversation. -The available expiration durations are 1 hour, 8 hours, 1 day, 1 week, 4 weeks, or never (which is the default setting). - -.. image:: images/messages-expiration.png - :width: 500px - - -Starting a call ---------------- - -When you're in a conversation, you can start a call any time with the ``Start call`` button. Other participants will get notified and can join the call. - -.. image:: images/device-settings-before-call.png - :width: 400px - -If somebody else has started a call already, the button will change in a green ``Join call`` button. - -.. image:: images/join-call.png - :width: 600px - -During a call, you can mute your microphone and disable your video with the buttons on the right side of the top bar, or using the shortcuts ``M`` to mute audio and ``V`` to disable video. You can also use the space bar to toggle mute. When you are muted, pressing space will unmute you so you can speak until you let go of the space bar. If you are unmuted, pressing space will mute you until you let go. - -You can hide your video (useful during a screen share) with the little arrow just above the video stream. Bring it back with the little arrow again. - -You can access your settings and choose a different webcam, microphone and other settings in the ``...`` menu in the top bar. - -.. image:: images/media-settings.png - :width: 300px - -From media settings dialog, you can also change the background of your video. - -.. image:: images/background-settings-in-call.png - :width: 400px - -You can change other settings in the ``Talk settings`` dialog. - -.. image:: images/talk-settings.png - :width: 600px - -Starting a screen share ------------------------ - -You can click the monitor icon on your video stream to share your screen. Depending on your browser, you will get the option to share a monitor, an application window or a single browser tab. -If video from your camera is also available, other participants will see it in a small presenter view next to the screen share. - -.. image:: images/share-screen-with-camera.png - :width: 700px - -Changing view in a call ------------------------ - -You can switch the view in a call with the little four-block icon in the top-right between promoted-view and grid view. The grid view will show everyone equally big and if the people do not fit on the screen, buttons will appear on the left and right that let you navigate. - -.. image:: images/talk-grid-view.png - :width: 700px - -The promoted view shows the speaker large and others in a row below. If the people do not fit on the screen, buttons will appear on the left and right that let you navigate. - -.. image:: images/talk-promoted-view.png - :width: 700px - - - - - - - - - - - - - - - - - diff --git a/user_manual/talk/webinar.rst b/user_manual/talk/webinar.rst new file mode 100644 index 00000000000..965cf1dcb62 --- /dev/null +++ b/user_manual/talk/webinar.rst @@ -0,0 +1,14 @@ +Webinar +====================== + +Nextcloud Talk has a number of advanced features users might find useful. + +Lobby +----- + +The lobby feature allows you to show guests a waiting screen until the call starts. This is ideal for webinars with external participants, for example. + +.. image:: images/lobby-in-talk.png + :width: 600px + +You can choose to let the participants join the call at a specific time, or when you dismiss the lobby manually. From 93ac360f35ab2cf710fb9205e9c3694a04881c60 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Mon, 14 Apr 2025 23:04:04 +0200 Subject: [PATCH 2/2] fixup! fix(user): Split talk user documentation into pieces --- user_manual/talk/bots.rst | 1 + user_manual/talk/index.rst | 2 +- user_manual/talk/matterbridge.rst | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/user_manual/talk/bots.rst b/user_manual/talk/bots.rst index 9dd7f1adca4..91514ecf1a1 100644 --- a/user_manual/talk/bots.rst +++ b/user_manual/talk/bots.rst @@ -1,4 +1,5 @@ :orphan: + Bots ==== diff --git a/user_manual/talk/index.rst b/user_manual/talk/index.rst index 2625bf79585..457afa7c760 100644 --- a/user_manual/talk/index.rst +++ b/user_manual/talk/index.rst @@ -10,7 +10,7 @@ You can find out more about Nextcloud Talk `on our website