Skip to content

Commit

Permalink
Merge pull request #61 from famedly/malin/add-presences
Browse files Browse the repository at this point in the history
docs: Add help center changes for the new presences feature
  • Loading branch information
nico-famedly authored Dec 4, 2023
2 parents 01d24ed + 01c1e60 commit 34659dd
Show file tree
Hide file tree
Showing 11 changed files with 82 additions and 53 deletions.
8 changes: 4 additions & 4 deletions docs/help-center/first-steps/first-login.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ User accounts are always created by the employer. The employer will provide you
<ol>
<li>Enter the organization URL in your desired browser.</li>
<li>Enter <code>username</code> and <code>password</code>.</li>
<li>Set your avatar on the welcome screen.</li>
<li>Set your profile picture on the welcome screen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobile" default>
<ol>
<li>Install the Famedly app on your smartphone.</li>
<li>Enter the organization URL.</li>
<li>Enter <code>username</code> and <code>password</code>.</li>
<li>Set your avatar on the welcome screen.</li>
<li>Set your profile picture on the welcome screen.</li>
</ol>
</TabItem>
</Tabs>
Expand All @@ -48,7 +48,7 @@ It is very important to setup the Chat-Backup. To enable the Chat-Backup, follow
<Tabs groupId="operating-systems">
<TabItem value="desktop" label="Desktop">
<ol>
<li>Click on your avatar to open settings.</li>
<li>Click on your profile picture to open settings.</li>
<li>Click on <b>Chat-Backup.</b></li>
<li>Click on <b>Activate Chat-Backup</b>.</li>
<li>Store passphrase at a secure place.</li>
Expand All @@ -57,7 +57,7 @@ It is very important to setup the Chat-Backup. To enable the Chat-Backup, follow
</TabItem>
<TabItem value="mobile" label="Mobile" default>
<ol>
<li>Tap on your avatar to open settings.</li>
<li>Tap on your profile picture to open settings.</li>
<li>Tap on <b>Chat-Backup</b>.</li>
<li>Tap on <b>Chat-Backup</b>.</li>
<li>Store passphrase at a secure place.</li>
Expand Down
21 changes: 19 additions & 2 deletions docs/help-center/using-famedly/chats.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,23 @@ Loading the archive may take some time.
</TabItem>
</Tabs>

## Check the online status of users

You can see the online status of other users on the profile pictures in the following places:
- in the chats list
- in the contact list (when opening a new chat)
- on the title bar of 1:1 chats
- in group chats above the single messages from other users
- in the member list of group chats

### Which symbol shows which online status?

**Online** &rarr; Green dot on the profile picture
**Busy** &rarr; Red dot with a white line on the profile picture
**Offline** &rarr; Grey dot on the profile picture

Also you can see the online status as text in the title bar of 1:1 chats.

## Group chat settings

### Edit a group name
Expand Down Expand Up @@ -284,7 +301,7 @@ From both your desktop and mobile devices, you can see group descriptions when v
<li>Click on the <b>three dots</b> in the top right corner of a group's screen to open the menu.</li>
<li>Click on the <b>Show Information</b> to open the group settings.</li>
<li>Click on <b>Edit</b> in the top right corner.</li>
<li>Click the avatar.</li>
<li>Click the profile picture.</li>
<li>Select picture from your file system.</li>
<li>Click <b>Save</b> to finish the process.</li>
</ol>
Expand All @@ -294,7 +311,7 @@ From both your desktop and mobile devices, you can see group descriptions when v
<li>Tap on the <b>three dots</b> in the top right corner of a group's screen to open the menu.</li>
<li>Tap on the <b>Show Information</b> to open the group settings.</li>
<li>Tap on <b>Edit</b> in the top right corner.</li>
<li>Tap the avatar.</li>
<li>Tap the profile picture.</li>
<li>Select picture from your file system.</li>
<li>Tap <b>Save</b> to finish the process.</li>
</ol>
Expand Down
2 changes: 1 addition & 1 deletion docs/help-center/using-famedly/messages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ With shift + enter, you can jump in a new line.

## Read new messages

A <b>bold</b> group chat or private chat in your chat list means that there are unread messages in the conversation. Click on or tap the bold conversation name to view the unread messages.
A <b>bold</b> group chat or private chat in your chats list means that there are unread messages in the conversation. Click on or tap the bold conversation name to view the unread messages.

Because mistakes happen, it is possible to edit and delete messages in Famedly.

Expand Down
17 changes: 7 additions & 10 deletions docs/help-center/your-account/account-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -242,27 +242,24 @@ Here you will find all the devices connected to your account. You have the optio

## Privacy

Here you have options to choose if you want to share read receipts, typing indicators or your online status with others and if you want to share crash reports with Famedly to help us enhance the app.
Here you have options to choose if you want to share read receipts, typing indicators or your [online status](../using-famedly/chats#check-the-online-status-of-users) with others and if you want to share crash reports with Famedly to help us enhance the app.
To protect your privacy, all those features are opt-in, so they are turned off by default.

### What are read receipts?

When the switch for sending read receipts is turned on, other user can see if you read a message.
At the bottom right corner of every chat room just above the message input field you can see the avatars of the users who read the last message. If more than four users read the last message, only four avatars will be displayed there and the number of other users who read the message will be shown left to the avatars like e.g. <b>+3</b> if seven users read the last message.
At the bottom right corner of every chat room just above the message input field you can see the profile pictures of the users who read the last message. If more than four users read the last message, only four profile pictures will be displayed there and the number of other users who read the message will be shown left to the profile pictures like e.g. <b>+3</b> if seven users read the last message.
You can also enter the <b>Read by</b> page on the message settings to see who read a message.
If you turn off the switch for sending read receipts, others will not see your avatar at the bottom of the chat or in the <b>Read by</b> list.
If you turn off the switch for sending read receipts, others will not see your profile picture at the bottom of the chat or in the <b>Read by</b> list.

### What are typing indicators?

When the switch for sending typing indicators is turned on, this means that whenever you are typing and another person has the same chat room opened, the other person gets a notification above the message input field on the bottom left corner with your avatar or initials saying <b>User is typing...</b> where “User” stands for your own username.
When the switch for sending typing indicators is turned on, this means that whenever you are typing and another person has the same chat room opened, the other person gets a notification above the message input field on the bottom left corner with your profile picture or initials saying <b>User is typing...</b> where “User” stands for your own username.
If you turn off sending typing indicators, this notification will not be shown for other users when you are typing.

### What is your online status?

Currently on Famedly we do not show the online status of users but that might change in the future.
Since matrix accounts can be used with other messengers, it is possible that a user you have a chat room with uses another client which does show the online status like e.g. Element.
When the switch for sending online status is turned on, those users might see a green dot on your Avatar or other indicators for the online status when you have the app on foreground or a yellow dot for inactivity when you minimize the app.
With the switch turned off, you will be shown as offline to any matrix messenger that can indicate the online status.
Other users that have an up-to-date version of Famedly will be able to see if you are online when you activate the toggle for sending the [online status](../using-famedly/chats#check-the-online-status-of-users).

### How to enable/disable chat features

Expand All @@ -271,7 +268,7 @@ With the switch turned off, you will be shown as offline to any matrix messenger
<ol>
<li>To access the settings, click on your profile picture or name initials.</li>
<li>Click on <b>Privacy</b>.</li>
<li>You can activate all chat features by clicking on <b>Enable all chat features</b>, this would mean sending read receipts, typing indicators, online status and crash reports.</li>
<li>You can activate all chat features by clicking on <b>Enable all chat features</b>, this would mean sending read receipts, typing indicators, <a href="../using-famedly/chats#check-the-online-status-of-users">online status</a> and crash reports.</li>
<li>You can also deactivate all chat features by clicking on <b>Enable all chat features</b> when all switches are already turned on, this would mean <b>not</b> sending read receipts, typing indicators, online status and crash reports anymore.</li>
<li>To turn on/off the other chat features, just click on the single switches.</li>
</ol>
Expand All @@ -280,7 +277,7 @@ With the switch turned off, you will be shown as offline to any matrix messenger
<ol>
<li>To access the settings, tap on your profile picture or name initials.</li>
<li>Click on <b>Privacy</b>.</li>
<li>You can activate all chat features by tapping on <b>Enable all chat features</b>, this would mean sending read receipts, typing indicators, online status and crash reports.</li>
<li>You can activate all chat features by tapping on <b>Enable all chat features</b>, this would mean sending read receipts, typing indicators, <a href="../using-famedly/chats#check-the-online-status-of-users">online status</a> and crash reports.</li>
<li>You can also deactivate all chat features by tapping on <b>Enable all chat features</b> when all switches are already turned on, this would mean <b>not</b> sending read receipts, typing indicators, online status and crash reports anymore.</li>
<li>To turn on/off the other chat features, just tap on the single switches.</li>
</ol>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ Sie benötigen diese Passphrase, um Ihren Chatverlauf wiederherzustellen, wenn S
Aktuell wird die Bildschirmsperre auf Desktopsystemen nicht unterstützt.

</TabItem>
<TabItem value="mobile" label="Mobile" default>
<TabItem value="mobil" label="Mobil" default>

Wenn Sie auf Ihrem Gerät keine allgemeine Bildschirmsperre eingerichtet haben, werden Sie dazu verpflichtet, in Famedly eine Bildschirmsperre einzurichten. Wie das geht ist unter [**Einstellungen**](../your-account/account-settings#screen-lock) beschrieben.
Wenn Sie auf Ihrem Gerät keine allgemeine Bildschirmsperre eingerichtet haben, werden Sie dazu verpflichtet, in Famedly eine Bildschirmsperre einzurichten. Wie das geht ist unter [**Einstellungen**](../your-account/account-settings#bildschirm-sperren) beschrieben.
Wenn eine Bildschirmsperre für Sie in Famedly Pflicht ist, werden Sie automatisch dazu aufgefordert, eine einzurichten. Sie können Ihren PIN zurücksetzen, indem Sie sich aus- und wieder einloggen.

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Um Sprachnachrichten wiederzugeben, gehen Sie wie folgt vor:
<li>Klicken Sie auf den <b>Play-Button</b> auf der linken Seite der Nachricht.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Öffnen Sie den Chat mit der Audionachricht.</li>
<li>Klicken Sie auf den <b>Play-Button</b> auf der linken Seite der Nachricht.</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Um einen direkten Chat mit anderen Personen in Famedly zu starten, befolgen Sie
<li>Klicke auf <b>Chat starten</b> um einen Chat zu starten.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Stellen Sie sicher, dass Sie sich im Bereich "Chats" befinden.</li>
<li>Tippen Sie <b>+ Taste</b> oben rechts auf dem Bildschirm.</li>
Expand All @@ -58,7 +58,7 @@ Um einen direkten Chat mit anderen Personen in Famedly zu starten, befolgen Sie
<li>Klicken Sie auf <b>Erstellen</b> um den Gruppenchat zu erstellen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Stellen Sie sicher, dass Sie sich in dem Chat-Bereich befinden.</li>
<li>Tippen Sie auf dem <b>+ Symbol</b> neben dem Filter oben auf dem Bildschirm.</li>
Expand Down Expand Up @@ -89,7 +89,7 @@ Um an einem Chat teilzunehmen, müssen Sie von einem Mitglied dieses Chats einge
<li>Einladung annehmen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Sie können nur einem Chat beitreten, wenn Sie eine Einladung erhalten haben.</li>
<li>Alle Einladungen finden Sie oben in der Chat-Liste.</li>
Expand All @@ -116,7 +116,7 @@ Es ist möglich, Benachrichtigungen für Chats stummzuschalten. Dies kann hilfre
<li>Klicken Sie auf den <b>Chat stummschalten</b>.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der oberen rechten Ecke des Chats, den Sie stummschalten möchten.</li>
<li>Tippe auf den <b>Chat stummschalten</b>.</li>
Expand All @@ -142,7 +142,7 @@ Sie können Chaträume jederzeit verlassen und damit das Gespräch beenden. Wenn
<li>Klicken Sie auf <b>Chat verlassen</b>.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der oberen rechten Ecke des Chat-Bildschirms.</li>
<li>Tippen Sie auf <b>Chat verlassen</b>.</li>
Expand Down Expand Up @@ -183,7 +183,7 @@ Das Laden des Archivs kann einige Zeit in Anspruch nehmen.
<li>Klicken Sie auf <b>Löschen</b></li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf Ihr <b>Profilbild</b> oder <b>Initialen</b> oben links um die Einstellungen zu öffnen.</li>
<li>Tippen Sie auf <b>Archiv</b>.</li>
Expand All @@ -194,6 +194,23 @@ Das Laden des Archivs kann einige Zeit in Anspruch nehmen.
</TabItem>
</Tabs>

## Den Online-Status anderer Nutzer prüfen

Sie können den Online-Status anderer Nutzer an folgenden Stellen auf den Profilbildern unten rechts sehen:
- in der Chat-Liste
- in der Kontaktliste (beim Erstellen eines neuen Chats)
- in der Titelleiste von 1:1 Chats
- in Gruppenchats über in den einzelnen Nachrichten anderer Nutzer
- in der Mitgliederliste von Gruppenchats

### Welches Symbol zeigt welchen Online-Status?

**Online** &rarr; Grüner Punkt auf dem Profilbild
**Beschäftigt** &rarr; Roter Punkt mit einem weißen Strich auf dem Profilbild
**Offline** &rarr; Grauer Punkt auf dem Profilbild

Außerdem können Sie den Online-Status als Text in der Titelleiste von 1:1 Chats sehen.

## Gruppenchat Einstellungen

### Gruppenname bearbeiten
Expand All @@ -210,7 +227,7 @@ Der Gruppenname erscheint in der Überschrift der Gruppe und Administratoren der
<li>Klicken Sie auf <b>Speichern</b> um den Prozess abzuschließen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der Ecke rechts oben in einem Gruppenchat um das Menü zu öffnen.</li>
<li>Tippen Sie auf <b>Informationen anzeigen</b> um die Gruppeneinstellungen zu öffnen.</li>
Expand All @@ -237,7 +254,7 @@ Sowohl auf Ihrem Desktop als auch auf mobilen Geräten können Sie Gruppenbeschr
<li>Klicken Sie auf <b>Speichern</b> um den Prozess abzuschließen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der oberen rechten Ecke einer Gruppe um das Menü zu öffnen.</li>
<li>Tippen Sie auf <b>Informationen anzeigen</b> um die Gruppeneinstellungen zu öffnen.</li>
Expand All @@ -261,7 +278,7 @@ Sowohl auf Ihrem Desktop als auch auf mobilen Geräten können Sie Gruppenbeschr
<li>Klicken Sie auf <b>Speichern</b> um den Prozess abzuschließen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der Ecke rechts oben in einem Gruppenchat um das Menü zu öffnen.</li>
<li>Tippen Sie auf <b>Informationen anzeigen</b> um die Gruppeneinstellungen zu öffnen.</li>
Expand All @@ -286,7 +303,7 @@ Sowohl auf Ihrem Desktop als auch auf mobilen Geräten können Sie Gruppenbeschr
<li>Klicken Sie auf <b>Speichern</b> um den Prozess abzuschließen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der Ecke rechts oben in einem Gruppenchat um das Menü zu öffnen.</li>
<li>Tippen Sie auf <b>Informationen anzeigen</b> um die Gruppeneinstellungen zu öffnen.</li>
Expand All @@ -311,7 +328,7 @@ Gruppenchats sind der beste Weg, um Unterhaltungen über verschiedene Projekte,
<li>Klicken Sie auf die Person, die Sie hinzufügen möchten.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der oberen rechten Ecke in einer Gruppe.</li>
<li>Tippen Sie auf <b>Teilnehmer zeigen</b>.</li>
Expand Down Expand Up @@ -339,7 +356,7 @@ Wenn Sie eine Person aus einer Gruppe entfernen, kann diese Person nicht mehr an
<li>Klicken Sie auf <code>Aus der Gruppe entfernen</code>.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der oberen rechten Ecke in einer Gruppe.</li>
<li>Tippen Sie auf <b>Teilnehmer zeigen</b>.</li>
Expand Down Expand Up @@ -386,7 +403,7 @@ In diesem Fall können nur Administratoren einer Gruppe Ankündigungen verschick
<li>Klicken Sie auf <code>Zum Admin machen</code>.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die <b>drei Punkte</b> in der oberen rechten Ecke in einer Gruppe.</li>
<li>Tippen Sie auf <b>Teilnehmer anzeigen</b>.</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Oftmals kann eine weitere Nachricht durch eine Emoji-Reaktion ersetzt werden. Si
<li>Wählen Sie einen Emoji aus den Vorschlägen oder klicken Sie auf das <b>+ Plus-Symbol</b> um ein anderes Emoji auszuwählen.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die Nachricht, worauf Sie reagieren wollen.</li>
<li>Wählen Sie einen Emoji aus den Vorschlägen oder tippen Sie auf das <b>+ Plus-Symbol</b> um ein anderes Emoji auszuwählen.</li>
Expand Down Expand Up @@ -210,7 +210,7 @@ Indem Sie mit dem @ jemanden in einer Nachricht erwähnen, können Sie Personen
<li>Verschicken Sie die Nachricht.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Schreiben Sie das <b>@-Symbol</b> in die Nachrichtenleiste.</li>
<li>Geben Sie den Namen von der Person, die Sie erwähnen wollen ein oder wählen Sie sie aus der Liste aus. Sie können diesen Schritt für jede Person wiederholen, die Sie in Ihrer Nachricht erwähnen möchten.</li>
Expand All @@ -235,7 +235,7 @@ Sie können nur Personen erwähnen die Mitglieder der Unterhaltung sind, sowohl
<li>Wählen Sie die Unterhaltung, in die Sie die Nachricht weiterleiten möchten.</li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Tippen Sie auf die Nachricht, die Sie weiterleiten möchten.</li>
<li>Tippen Sie auf <b>Nachricht weiterleiten</b></li>
Expand All @@ -255,7 +255,7 @@ Die Nachricht wird dem Administrator Ihrer Organisation gemeldet.
<li>Klicken Sie auf <b>Anstößigen Inhalt melden</b></li>
</ol>
</TabItem>
<TabItem value="mobile" label="Mobil">
<TabItem value="mobil" label="Mobil">
<ol>
<li>Halten Sie die Nachricht gedrückt mit der Maus oder mit Ihrem Finger.</li>
<li>Tippen Sie auf <b>Anstößigen Inhalt melden</b></li>
Expand Down
Loading

0 comments on commit 34659dd

Please sign in to comment.