User Tools

Site Tools


services:matrix:start

Matrix

This is just the start page of the Matrix documentation, have a look at More Documentation section at the bottom

We are running a Matrix instance. Go to meet.physik.fu-berlin.de to use the web client, where you can log in with your regular Physics account credentials.

Matrix is an instant messaging protocal, and is accessed by using a client. Analogously to how email is a protocol, and Gmail is a client. Like with email, there are many clients for Matrix. Different people can use different clients to contact each other. A good client to start using Matrix with is Element. You can use the web version of Element at meet.physik.fu-berlin.de, or use other versions of Android Clients, iOS clients or Desktop clients (Windows, MacOS, Linux) or any other Matrix client to matrix.physik.fu-berlin.de

Our Matrix server is not federated with the rest of the Matrix ecosystem, due to unresolved privacy questions, but we are giving access to external collaborators upon request.

First Steps

When you first log in at meet.physik.fu-berlin.de, you will see something like this

The important parts of the screen are these

  1. is the user menu
  2. is the bar of communities you are a part of
  3. is the button to join/make a room, and is on top of the (currently empty) list of rooms we are participating in
  4. is the button to start a direct message session with another user, and is on top of the (currently empty) list of direct conversations we are having
  5. Is a search box used to find a specific room/person in your contacts. The compass icon to the right of it is to explore public rooms.

We will now look at all of these in turn.

Direct Messages and Rooms

When you press the button to start a direct message (the plus button in the People tab) labelled with (4). You are presented with If you use Matrix for a bit longer it will be filled with suggestions, but for a new user, it is empty. In the box you can type the name or ZEDAT account of the person you are searching for. Press Go to invite the person to chat.

In this example we get an invite for such a direct message session. It pops up in the space where all our conversations are listed. By clicking on it we can choose whether to join or reject the conversation

If we join, we end up in the messaging window and can start to chat. For more information what Matrix allows have a look at Beyond Text.

Let's use this window to explain what we can see

At the bottom is the message box where you can enter your messages. To the right of the message box there are five buttons highlighted in red for (from left to right)

  • adding attachments,
  • emojis,
  • stickers (currently not supported),
  • starting a voice call, and
  • starting a video call.

The latter will add a widget to a Jitsi room on our Jitsi instance on top of the message space if you have more than two people in a room or directly start a video call if you are only two.

Furthermore, there are another four buttons on top of the screen highlighted in red and labelled 2. From left to right:

  • Pinned messages
  • search within the chat
  • access to your notifications, and
  • room info (which also contains some more settings)

Rooms

A room is a group chat. You can create a room by pressing the plus button beside the rooms tab labelled by (3). Here you have the option to choose a room name, and whether the room will be public (searchable) or not. Once the room is created, you can invite individuals to it by pressing on the information button within the room, clicking invite, and then typing in their names.

To create a private room, just give it a name and optionally a topic and press Create Room. At first you will be alone, but you can invite more people via the user list.

If you press the “Make this room public” toggle, the window changes to and will allow you to give the room a permanent identifier, the room alias, which uniquely identifies the room.

But what if you just want to join an exisiting public room. The Explore button (compass icon) (5) has you covered. When you click it you get a window where you can search the list of public rooms by name and room alias.

One such room is ZEDV-Support, where the Physics IT service answers support questions and generally interacts with users. It looks like a direct chat session, only with more people, because that's what it is.

Beyond Text

In the Matrix client we provide, you can do more than write simple text (and uploading files and images). You can style your text with Markdown, including Hyperlinks and syntaxhighlighted code.

We hope that TeX for math will be supported soon as well.

When you hover over one of your messages you get a little context menu, that we will explain now. The buttons are (from left to right) quick reactions, reply, edit and more options

Edits

Sometimes you have a typo and would like to fix it, with Matrix you can, just press the edit button on the message mouseover.

Before

After

Delete Messages

Have you sent something to the wrong person? You can delete messages via the delete options on the more options (three dots) message mouseover.

Before

After

Replies

Want to add some context that has already scrolled past in a busy room? The reply function has got you covered, just press the reply button on the message mouseover.

Tabcompletion

One last feature, names tabcomplete. If you start typing @ followed by the name or username of of a user, a little menu will pop up where you can choose the name by clicking or via the tab key if you are down to a single choice

This results in a mention that is highlighted for the user you mentioned.

Other things that tabcomplete are room names (starting with a #), emojis (starting with a :) and communities (starting with a +).

Further Steps

User Settings (Changing Your Name)

In the user menu (1) you can set many options. {{ :services:matrix:settings.png?direct&1000 |}}

Among these settings are whether and how you want to receive desktop notifications, the theme you want (currently we only have the defaults light and dark), but also how your name is displayed and what your profile picture is.

If you change your name or profile picture, other users will see it right away, but the menu will only show it once you log out and back in.

Leaving a room

You can use the context menu for rooms

Or you can just type /part as a message into the room.

Getting people into a room

You can directly link to a (public) room via the information button on the top right Press “Share room”, and you will be presented with multiple means of sharing the room with someone

Communities

You might wonder, “I have a group of people, but we also have a set of topics and a single room for that might be confusing!” That is what communities are for, they group people and rooms and can have long descriptions. Unfortunately they are currently not searchable, so you have to know about them to navigate to their group page and join them. This should become more comfortable soon™️.

You can start a new community via the community sidebar (2).

After starting a community, you can add people and rooms via sidebars, just like adding users to a room.

When you join a community it gets added to your community sidebar. When you left-click on its symbol, your list of direct message sessions and rooms get filtered to members of your community and rooms belonging to your community, left-clicking again reverts to the default. Right-clicking on the symbol gives you a context menu to get to the community page.

Element also offers end-to-end encryption. To see how to enable this, read this page dedicated to it

Usage tips

  • You can search for other users by their display name or ZEDAT username, the display name is the person's name by default, but users may change it.
  • You can highlight messages for certain users by mentioning them. You do this by typing @ followed by their name, use tab to autocomplete.
  • The little symbols to the right of messages are read markers.
  • Messages can be formatted in Markdown (tables are unfortunately not supported in the current Markdown flavour).
  • You can share images and files.
  • Emojis can be typed by starting with a colon : followed by the name, choices will pop up.
  • Messages can be edited after sending them. Use the context menu when hovering over a message.
  • You can reply to messages, quoting them thereby. Use the context menu when hovering over a message.
  • You can react to messages. Use the smilie context menu when hovering over a message.
  • You can add a Jitsi widget using our Jitsi server to bind a fixed Jitsi room to your Matrix room via the video camera button on the far right of the message input box

More Documentation

services/matrix/start.txt · Last modified: 2020/12/04 16:54 by behrmj87