From 2d474771cc928218d9e84704e0bd60e9f7b12172 Mon Sep 17 00:00:00 2001 From: Julian Waluschyk Date: Fri, 13 Dec 2024 15:02:18 +0100 Subject: [PATCH] updated communication documentation --- docs/user/communication.rst | 232 ++++++++++++++++++++++++++++++++++++ 1 file changed, 232 insertions(+) diff --git a/docs/user/communication.rst b/docs/user/communication.rst index cf28dce9c8d8..44730216e0ba 100644 --- a/docs/user/communication.rst +++ b/docs/user/communication.rst @@ -100,6 +100,238 @@ for multiple links. |link-preview-multiple| + +Communication Features Availability +----------------------------------- + +.. |AVAILABLE| raw:: html + + AVAILABLE + +.. |UNAVAILABLE| raw:: html + + UNAVAILABLE + +.. |PLANNED| raw:: html + + PLANNED + +.. |WIP| raw:: html + + WIP + +.. |NOT PLANNED| raw:: html + + NOT PLANNED + + +The following table represents the currently available communication features of Artemis on the different platforms. Note that not all +features are available to every user, which is why **Actor restrictions** have been added. The following sections will explore this in more +detail. + +Status explained +^^^^^^^^^^^^^^^^ + +.. list-table:: + :widths: 15 74 + + * - |AVAILABLE| + - This feature has been released to production. + * - |UNAVAILABLE| + - This feature is currently not available and not planned yet. + * - |PLANNED| + - This feature is planned and implemented within the next 2-4 months. + * - |WIP| + - This feature is currently being worked on and will be released soon. + * - |NOT PLANNED| + - This feature will not be implemented due to platform restrictions, or it does not make sense to implement it. + + + + +Available features on each platform +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Feature | Actor Restrictions | Web App | iOS | Android | ++======================================================+======================================+====================+=====================+=====================+ +| **General** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Send Messages | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Receive Messages | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| **Post Actions** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| React to Messages | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Reply in Thread | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Copy Text | | |NOT PLANNED| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Pin Messages | | Groups: group creators | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | | Channels: moderators | | | | +| | | DM: members of DM | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Delete Message | Moderators and authors | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Edit Message | Authors only | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Save for later | | |AVAILABLE| | |UNAVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Forward Messages | | |WIP| | |UNAVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Resolve Messages | At least tutor and authors | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Post action bar (thread view) | ||NOT PLANNED| | |AVAILABLE| | |WIP| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| **Markdown Textfield Options** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Tag other users | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Tag channels, lectures and exercises | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Tag FAQ | | |WIP| | |WIP| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Basic formatting (underline, bold, italic) | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Strikethrough formatting | | |AVAILABLE| | |UNAVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Preview | | |AVAILABLE| | |UNAVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Code Block and inline code formatting | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Reference formatting | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Link formatting | | |AVAILABLE| | |PLANNED| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| **Messages** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Profile pictures | | |AVAILABLE| | |AVAILABLE| | |WIP| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Show if message was edited, resolved or pinned | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Render links to exercises, lectures, other chats, | | |AVAILABLE| | |AVAILABLE| | |WIP| | +| | lecture-units, slides, lecture-attachment with | | | | | +| | correct icon | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Render FAQ links | | |AVAILABLE| | |AVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Mark unread messages | | |UNAVAILABLE| | |UNAVAILABLE| | |UNAVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Render images | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Render links to uploaded files | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Filter messages (unresolved, own, reacted) | | |AVAILABLE| | |AVAILABLE| | |UNAVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Sort messages (ascending, descending) | | |AVAILABLE| | |NOT PLANNED| | |UNAVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Search for messages in chat | | |UNAVAILABLE| | |UNAVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Search for messages across all chats | | |AVAILABLE| | |UNAVAILABLE| | |UNAVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Open Profile info by clicking profile picture | | |PLANNED| | |AVAILABLE| | |WIP| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Start a conversation from Profile | | |WIP| | |AVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| **Link/Attachment Handling** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Open lecture, exercise, chat links correctly in | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | the appropriate view | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Open sent images full-screen | | |AVAILABLE| | |AVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Download sent images | | |AVAILABLE| | |PLANNED| | |UNAVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| View and download attachments | | |AVAILABLE| | |PLANNED| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| **Conversation Management** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Search for chats | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Filter chats (all, unread, favorites) | | |UNAVAILABLE| | |AVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Mark unread chats | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Mute, hide, favorite chat | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Edit Chat information (name, topic, description) | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Archive Chat | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Delete Chat | | |AVAILABLE| | |UNAVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| View Members | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Search Members | | |AVAILABLE| | |UNAVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Filter Members (All Members, Instructors, | | |AVAILABLE| | |UNAVAILABLE| | |UNAVAILABLE| | +| | Tutors, Students, Moderators) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Add Members to existing chat | | Group: members of group | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | | Channel: at least instructor | | | | +| | | or moderator | | | | +| | | DM: not possible | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Filter Members while adding (Students, Tutors, | | |AVAILABLE| | |UNAVAILABLE| | |AVAILABLE| | +| | Instructors) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Add whole groups (All Students, All Tutors, All | | |AVAILABLE| | |PLANNED| | |UNAVAILABLE| | +| | Instructors) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Grant moderator roles in channels / revoke | Moderators only | |AVAILABLE| | |UNAVAILABLE| | |AVAILABLE| | +| | moderation roles | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Create direct chat | Everyone | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Create channel (public/private, | At least teaching assistant | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | announcement/unrestricted) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Update channel information (name, topic, | Moderators | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | description) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Create group chat | Everyone | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Kick users from group chat | Members of group chat | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Browse channels | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Show info in chat overview | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | (created by, created on) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Leave chat | For groups only | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Delete channel | | Creators with moderation | |AVAILABLE| | |UNAVAILABLE| | |UNAVAILABLE| | +| | | rights and instructors | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Archive channel | Moderators | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| **Notifications** | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| Notification overview for past notifications | | |AVAILABLE| | |AVAILABLE| | |PLANNED| | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ +| | Notification settings (unsubscribe/subscribe | | |AVAILABLE| | |AVAILABLE| | |AVAILABLE| | +| | to various notification types) | | | | | ++------------------------------------------------------+--------------------------------------+--------------------+---------------------+---------------------+ + +.. note:: + - Leave chat option is available on the web app for groups only, on iOS for groups and non course-wide channels, and on Android for channels, groups, and DMs. + - Creating a group chat on iOS and Android can be achieved via the 'Create Chat' option. It becomes a group when more than one user is added. + - Downloading sent images in the chat is only available through the browser option on the web app. + Features for Users ------------------