Skip to content

Commit 2c1efc8

Browse files
committed
[wip] feat(talk): add user documentation for 35 features
[skip ci] Assisted-by: ClaudeCode:claude-sonnet-5 Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
1 parent 96f3cb7 commit 2c1efc8

7 files changed

Lines changed: 109 additions & 4 deletions

File tree

user_manual/talk/attachments.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,24 @@ Second, you can select a file from your Nextcloud Files or a file manager by cho
2323
:alt: Talk file selection panel showing available files to share in chat
2424
:width: 600px
2525

26-
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.
26+
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. When you share several files at once, they are combined into a single message in the chat instead of one message per file, keeping the conversation easier to follow.
2727

28+
.. TODO: update screenshot to show multiple files combined into one message
2829
.. image:: images/talk-upload-files.png
29-
:alt: Talk file upload queue before sending files in chat
30+
:alt: Talk file upload queue with several files combined into one message before sending
3031
:width: 500px
3132

32-
All users will be able to click the files to view, edit or download them, regardless of whether they have a Nextcloud 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.
33+
Before you send the files, this staging area also lets you set options that apply to the upload. When you share
34+
images, they use ``Standard image quality`` by default, which compresses them to save bandwidth and storage; switch
35+
to ``Original image quality`` if you need to share the full-quality file. Depending on your instance, you can also
36+
choose ``View-only for others`` (the default) or ``Editable by others`` for the shared files.
37+
38+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
39+
.. image:: images/talk-upload-files.png
40+
:alt: Talk staging area showing the image compression and view-only/can-edit options
41+
:width: 500px
42+
43+
All users will be able to click the files to view or download them, regardless of whether they have a Nextcloud account, and edit them if you allowed it. Users with an account will have the file automatically shared with them while external guest users will get them shared as a public link.
3344

3445
.. image:: images/editing-document-in-chat-room.png
3546
:alt: Talk chat with a shared document that participants can open and edit

user_manual/talk/call.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,18 @@ and whether you have ``Moderator`` permission for the conversation.
8181
If you are joining and the call is being recorded, you might be required to consent before being allowed to join.
8282
For more information, see :ref:`Call recording <call-recording>`.
8383

84+
Restricting who can start a call (moderator)
85+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
86+
87+
An administrator can limit who is allowed to start a call server-wide, to one of: everyone, users and moderators
88+
only, moderators only, or nobody (calls disabled). An administrator can additionally restrict starting a call to
89+
members of specific groups; when such groups are configured, only their members can start a call, and this also
90+
applies to moderators, while guests and federated users can never be part of a group.
91+
92+
If you are not allowed to start a call, you can still join one already in progress, but you will not see the
93+
``Start call`` button. For conversations hosted on a federated server, the configuration of that server applies
94+
instead. Ask your administrator to check the Talk admin settings if you need to start calls yourself.
95+
8496
Start the call
8597
^^^^^^^^^^^^^^
8698

user_manual/talk/call_views.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,14 @@ Use the navigation buttons on the left and right to scroll through participants
2626
.. image:: images/talk-promoted-view.png
2727
:alt: Talk call in promoted (speaker) view with the active speaker highlighted
2828
:width: 700px
29+
30+
Multi-speaker view
31+
-------------------
32+
33+
Multi-speaker view works like speaker view, but promotes two or three active speakers into large tiles instead of
34+
just one, so you can follow a discussion between several people at once.
35+
36+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
37+
.. image:: images/talk-promoted-view.png
38+
:alt: Talk call in multi-speaker view with several active speakers highlighted
39+
:width: 700px

user_manual/talk/conversation_organization.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Similar types can also be grouped together:
4242
- **Show private ones first**: Show private conversations before groups/public
4343
- **Show group ones first**: Show groups/public conversations before private
4444

45+
.. TODO: update screenshot to show the last message time next to each conversation
4546
.. image:: images/conversations-sorting.png
4647
:alt: Talk conversations sorting and grouping options
4748
:width: 400px

user_manual/talk/conversation_presets.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,40 @@ Presentation
4040
Presentation preset is useful for internal meetings, where it is expected to have more listeners than speakers.
4141
Participant permissions are optimized to ensure the best performance and moderation experience, allowing presenters to speak uninterrupted.
4242

43+
Classified conversation
44+
------------------------
45+
46+
A locked-down conversation preset for confidential topics. It cannot be made public, so there is no public link and
47+
no guest access, and SIP dial-in/out and call recording are disabled. Messages expire after one hour by default.
48+
49+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
50+
.. image:: images/new-conversation-presets.png
51+
:alt: Talk new conversation dialog with the classified conversation preset selected
52+
:width: 400px
53+
54+
Channel
55+
-------
56+
57+
A broadcast conversation preset for a large audience. Only moderators can post messages; everyone else can only
58+
react, unless a moderator grants individual participants more permissions. Calls are disabled, and the conversation
59+
is searchable and joinable by registered users.
60+
61+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
62+
.. image:: images/new-conversation-presets.png
63+
:alt: Talk new conversation dialog with the channel preset selected
64+
:width: 400px
65+
66+
Announcement
67+
------------
68+
69+
An announcement preset works like a channel, with the same posting and call restrictions, but the conversation is
70+
not openly joinable and participants who are added to it cannot leave.
71+
72+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
73+
.. image:: images/new-conversation-presets.png
74+
:alt: Talk new conversation dialog with the announcement preset selected
75+
:width: 400px
76+
4377
See also:
4478

4579
- :doc:`conversations`

user_manual/talk/conversations.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,30 @@ Here you can configure the description, guest access, if the conversation is vis
168168
:alt: Talk conversation settings dialog showing description and access configuration
169169
:width: 600px
170170

171+
Owner role
172+
----------
173+
174+
The person who created a conversation is its owner. An owner can promote other moderators to owners, and demote
175+
co-owners back to moderator, from the participant list ``...`` menu.
176+
177+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
178+
.. image:: images/participant-menu.png
179+
:alt: Talk participant menu with promote/demote owner options
180+
:width: 400px
181+
182+
Unlike moderators, an owner cannot be removed or demoted by another moderator, only by another owner.
183+
184+
Preserved conversations
185+
------------------------
186+
187+
An owner can mark a conversation as preserved, to protect it from accidental deletion, purging or from having its
188+
visibility changed. This is useful for conversations that must be kept for record-keeping or compliance reasons.
189+
190+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
191+
.. image:: images/conversation-settings-dialog.png
192+
:alt: Talk conversation settings showing the preserve conversation option
193+
:width: 600px
194+
171195
Ban participants
172196
----------------
173197

user_manual/talk/messages.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,22 @@ In the submenu, you can select an appropriate time to receive a notification lat
4343

4444
You can also forward a message to another conversation using the ``...`` menu, or send it to your **Note to self** conversation for personal reference.
4545

46+
Global message search
47+
----------------------
48+
49+
You can search for messages across all your conversations at once from the conversation list search field, without
50+
opening each conversation individually. Results show a preview of the matching message and its conversation, so you
51+
can jump straight to it.
52+
53+
.. TODO: mock screenshot below, replace with a real capture once the feature ships
54+
.. image:: images/chat-search-messages.png
55+
:alt: Talk global search results showing matching messages across conversations
56+
:width: 500px
57+
4658
Messages search in a conversation
4759
---------------------------------
4860

49-
In addition to global unified search, you can search for messages within a specific conversation. In the content sidebar of a conversation, click the search icon to open the search tab.
61+
In addition to the global message search, you can search for messages within a specific conversation. In the content sidebar of a conversation, click the search icon to open the search tab.
5062

5163
.. image:: images/chat-search-messages.png
5264
:alt: Talk in-conversation message search field

0 commit comments

Comments
 (0)