fix(user): Split talk user documentation into pieces

Signed-off-by: Joas Schilling <[email protected]>

Author: nickvergessen

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

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. <https://nextcloud-talk.readthedocs.io/en/stable/commands/>`_

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"

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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

user_manual/talk/call_index.rst

@@ -0,0 +1,10 @@
+Calls
+=====
+
+.. toctree::
+   :maxdepth: 1
+
+   call
+   call_recording
+   webinar
+   breakout_rooms

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

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

user_manual/talk/chat_index.rst

@@ -0,0 +1,11 @@
+Chat
+====
+
+.. toctree::
+   :maxdepth: 1
+
+   chat
+   messages
+   message_integrations
+   attachments
+.. bots

user_manual/talk/conversation_index.rst

@@ -0,0 +1,10 @@
+Conversations
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   conversations
+   open_conversations
+   federation
+   files_integration