annotate doc/user/chat.rst @ 1636:691f6c8afb31

doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections: Document the new features. rel 461
author Goffi <goffi@goffi.org>
date Fri, 04 Jul 2025 18:11:30 +0200
parents 7a97408f32bb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1621
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
1 =================
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
2 Instant Messaging
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
3 =================
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
4
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
5 You can find the instant messaging feature on the **Chat** tab. Libervia's chat
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
6 functionality supports a wide range of use cases, from professional collaboration to
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 personal communication.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
8
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
9 Accessing the Chat Feature
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
10 --------------------------
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
12 1. Navigate to the main menu.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
13 2. Select the **Chat** option.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
14
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
15 Panels
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
16 ------
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
17
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
18 There are three main panels for managing chats (not all may be visible simultaneously):
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
19
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
20 - **Left panel**: Displays current group chats and direct conversations. You can also
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
21 start a new chat from this panel.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
22 - **Main panel**: Shows the active conversation.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
23 - **Right panel**: Provides information about the current discussion, such as participants
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
24 in a chat room.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
25
1633
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
26
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
27 Main Panel Header
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
28 -----------------
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
29
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
30 The main panel header displays information about the current conversation.
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
31
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
32 On the left side of the header, you'll find a button to toggle the visibility of the left
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
33 panel. Next to this button is the identifier (JID) of the conversation recipient. This
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
34 recipient can be a single user or a group chat room.
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
35
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
36 When available, a "Data Policy" badge may appear next to the JID. This badge indicates the
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
37 privacy and data practices of the service associated with the recipient. The badge is
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
38 scored on a scale of ten and uses the following color scheme:
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
39
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
40 - **Green:** Indicates good data practices and respect for privacy.
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
41 - **Yellow:** Indicates a moderate score – data practices are neither good nor bad.
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
42 - **Red:** Indicates poor data practices and potential privacy concerns.
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
43
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
44 Hovering or touching the Data Policy badge will open a report panel with more detailed
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
45 information about the service's data handling.
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
46
7a97408f32bb doc (user/chat): Document header and data policy:
Goffi <goffi@goffi.org>
parents: 1629
diff changeset
47
1621
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
48 Threads and Replies
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
49 -------------------
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
50
1626
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
51 In a message, you'll see a "Reply" button represented by a left-pointing arrow. Click
1621
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
52 it to reply to a specific message. This action creates a thread, which functions as a
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
53 focused discussion within the main conversation or a series of replies on the same topic.
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
54
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
55 When a thread exists, a chat bubble icon with three dots will appear in the message
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
56 header, next to the timestamp. Hovering over this icon highlights all messages in the
1626
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
57 thread. Clicking it opens a submessage panel containing all messages from that thread.
1621
d7c8a986f4fb doc (chat): chat documentation first draft:
Goffi <goffi@goffi.org>
parents:
diff changeset
58 Messages written in this panel will be posted as replies to the thread.
1626
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
59
1636
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
60 Forwarding Messages
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
61 -------------------
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
62 To forward a message, use the context menu (3-dots icon) associated with any message
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
63
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
64 1. Tap or click the **3-dots icon** next to the message you want to forward.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
65 2. Select **Forward** from the menu.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
66 3. A prompt will appear where you can enter the recipient's identifier (JID).
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
67 4. Confirm the action to send the message to the specified entity.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
68
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
69 This feature allows you to share messages with users outside the current conversation.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
70
1626
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
71 Keywords
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
72 --------
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
73
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
74 Chat messages can have "keywords", which may help to categorize them. They can, for
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
75 instance, be added by an email gateway or a bot.
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
76
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
77 When present, these keywords will appear under the message. Clicking on one of these
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
78 keywords will show a submessage panel on the right side, where you'll see only messages
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
79 with this keyword. If you write a message in this panel, the keyword will be automatically
00abe08875f5 doc (user/chat): Add documentation for keywords handling:
Goffi <goffi@goffi.org>
parents: 1621
diff changeset
80 added to the message.
1629
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
81
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
82 Origin
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
83 ------
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
84
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
85 If a message originates from a gateway to another protocol (e.g., email, SMS,
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
86 ActivityPub), a label will indicate its origin. Clicking this label displays a submessage
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
87 panel showing only messages from this source. If a message was generated by a bot (i.e.,
961468588131 doc (chat): Add documentation for message origin:
Goffi <goffi@goffi.org>
parents: 1626
diff changeset
88 an automated program), a corresponding label will appear.
1636
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
89
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
90 Rich Editing Mode
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
91 -----------------
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
92 Libervia supports rich text formatting for messages, enabling you to apply text styles:
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
93
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
94 1. Locate the **extra menu** (vertical 3-dots icon) next to the message input bar.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
95 2. Select **Switch to Rich Editing** from the menu.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
96 3. Use the formatting tools to apply styles like bold, italic, underline, etc.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
97
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
98 .. note::
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
99
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
100 While rich formatting enhances message presentation, not all XMPP clients support
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
101 styled messages. Recipients using incompatible clients will receive a plain text
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
102 version of your message. The core content remains intact regardless of formatting
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
103 compatibility.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
104
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
105 Adding Extra Recipients
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
106 -----------------------
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
107 You can specify additional recipients for a message using the "extra recipients" feature:
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
108
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
109 1. Open the **extra menu** (vertical 3-dots icon) next to the message input bar.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
110 2. Select **Add Recipients** to display a dynamic field.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
111 3. Enter a recipient's JID and choose their delivery type from the dropdown:
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
112
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
113 - **To**: Primary recipient (visible to all recipients)
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
114 - **Cc**: Carbon Copy, secondary recipient (visible to all recipients)
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
115 - **Bcc**: Blind Carbon Copy (hidden from other recipients)
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
116
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
117 Pressing **Enter** after adding a recipient automatically creates a new field with the
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
118 same delivery type, allowing you to quickly add multiple recipients of the same category.
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
119
691f6c8afb31 doc (user/chat): Add `Forwarding Messages`, `Rich Editing Mode` and `Adding Extra Recipients` sections:
Goffi <goffi@goffi.org>
parents: 1633
diff changeset
120