From a2e7525ba4e3e108f1fcfd6111363ec458386b20 Mon Sep 17 00:00:00 2001 From: Aaron Thornburgh <112560169+americanrefugee@users.noreply.github.com> Date: Mon, 15 May 2023 13:36:10 +0200 Subject: [PATCH] Update tables for VocabularyAndIconography.stories.mdx Replaced HTML tables with markdown. Please check that everything is laid out correctly and that the images display :) --- .../VocabularyAndIconography.stories.mdx | 339 ++---------------- 1 file changed, 34 insertions(+), 305 deletions(-) diff --git a/stories/content/VocabularyAndIconography.stories.mdx b/stories/content/VocabularyAndIconography.stories.mdx index fa83394..5575d17 100644 --- a/stories/content/VocabularyAndIconography.stories.mdx +++ b/stories/content/VocabularyAndIconography.stories.mdx @@ -12,242 +12,31 @@ Below is a list of the most common terms or concepts the average user will come ### Glossary - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CategoryName or labelUser-friendly description
General - Element - - Element is an app that individual people, professional organisations, - governments, and communities use to communicate securely, powered by - Matrix. -
- Matrix - - Matrix is an open network for secure, decentralised communication. The - official specification for Matrix is maintained by the Matrix.org - Foundation, a non-profit organisation based in the UK. -
Registration - Account provider - - This is where your conversations will live — just like you would use an - email provider to keep your emails. -
- Account - - This is where information about your identity is securely stored, such as - your username and email, which is managed separately from the Element app. - You can connect your account to any service that supports Matrix ID. -
- Password - - A secret code or phrase that proves it’s you before giving you access to - your account. -
- Username - Your official name on Element, which can't be changed later.
- Matrix ID - - This is your full identity, which others can use to find you (eg: - @username:matrix.org). "Matrix ID" refers to Matrix, the open network - which powers Element, allowing people to communicate and collaborate - securely. Element, or any other service provider, doesn't own your - conversations – you do. -
- Display name - - The name shown next to your avatar, which other people will see in their - timeline. This can be changed anytime. -
Sign in - Verify device - - Confirm that it's you to set up secure messaging when signing into a new - device for the first time. -
- Scan QR code - - Automatically sign in, set up secure messaging for a device, or verify - someone's identity by scanning a QR code. -
- Compare 6-digit code - - Set up secure messaging for a device, or verify someone's identity by - comparing a unique 6-digit code with the one shown in Element on another - device. -
- Enter recovery key - - If you're signed out of Element everywhere, use a recovery key to set up - secure messaging on a new device after signing back in. This is separate - from your account password. -
Messaging - Chat - Any conversation on Element.
- Direct message - - A conversation between you and one other person. Nobody else can join. -
- Room - - A conversation between three or more people, either private or public. -
- Secure messaging - - Messages are end-to-end encrypted and can only be sent or read by people - in this room. -
- Not encrypted - - Someone outside this room may be able to intercept and read any messages. -
Verification & Trust - Verify user - - Confirm the identity of another user by sharing a QR code or comparing a - string of numbers.{" "} -
- Trusted person - Anyone you’ve confirmed as the actual owner of an account.
- Trusted device - - You've set up secure messaging after signing in to Element, so other users - can also trust your device. -
- Device - Anywhere you're signed in to Element.
- Encryption keys - - These are used to encrypt the messages you send, or decrypt messages which - you receive from others, so that nobody else but you and the reciptiant(s) - can see your conversation. Your encryption keys are created the first time - you use Element and stored locally on your computer or mobile device, - separately from your account. -
- Secure backup - - Securely store your encryption keys in the cloud. This allows you to set - up secure messaging after signing into another device with a QR code or by - comparing a 6-digit number. Otherwise, you'll need a recovery code to - restore your encryption keys, which are needed to read or send secure - messages. -
+| Category | Name or label | User-friendly description | +|:------------ |:-------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| General | **Element** | Element is an app that individual people, professional organisations, governments, and communities use to communicate securely, powered by Matrix. +| | **Matrix** | Matrix is an open network for secure, decentralised communication. The official specification for Matrix is maintained by the Matrix.org Foundation, a non-profit organisation based in the UK. +| Registration | **Account provider** | This is where your conversations will live — just like you would use an email provider to keep your emails. +| | **Account** | This is where information about your identity is securely stored, such as your username and email, which is managed separately from the Element app. You can connect your account to any service that supports Matrix ID. +| | **Password** | A secret code or phrase that proves it’s you before giving you access to your account. +| | **Username** | Your official name on Element, which can't be changed later. +| | **Matrix ID** | This is your full identity, which others can use to find you (eg: @username:matrix.org). "Matrix ID" refers to Matrix, the open network which powers Element, allowing people to communicate and collaborate securely. Element, or any other service provider, doesn't own your conversations – you do. +| | **Display name** | The name shown next to your avatar, which other people will see in their timeline. This can be changed anytime. +| Sign in | **Verify device** | Confirm that it's you to set up secure messaging when signing into a new device for the first time. +| | **Scan QR code** | Automatically sign in, set up secure messaging for a device, or verify someone's identity by scanning a QR code. +| | **Compare 6-digit code** | The name shown next to your avatar, which other people will see in their timeline. This can be changed anytime. +| | **Enter recovery key** | If you're signed out of Element everywhere, use a recovery key to set up secure messaging on a new device after signing back in. This is separate from your account password. +| Messaging | **Chat** | Any conversation on Element. +| | **Direct message** | A conversation between you and one other person. Nobody else can join. +| | **Room** | A conversation between three or more people, either private or public. +| | **Secure messaging** | Messages are end-to-end encrypted and can only be sent or read by people in this room. +| | **Not encrypted** | Someone outside this room may be able to intercept and read any messages. +| Verification & Trust | **Verify user** | Confirm the identity of another user by sharing a QR code or comparing a string of numbers. +| | **Trusted person** | Anyone you’ve confirmed as the actual owner of an account. +| | **Trusted device** | You've set up secure messaging after signing in to Element, so other users can also trust your device. +| | **Device** | Anywhere you're signed in to Element. +| | **Encryption keys** | These are used to encrypt the messages you send, or decrypt messages which you receive from others, so that nobody else but you and the reciptiant(s) can see your conversation. Your encryption keys are created the first time you use Element and stored locally on your computer or mobile device, separately from your account. +| | **Secure backup** | Securely store your encryption keys in the cloud. This allows you to set up secure messaging after signing into another device with a QR code or by comparing a 6-digit number. Otherwise, you'll need a recovery code to restore your encryption keys, which are needed to read or send secure messages. ## Common icons and their meaning @@ -265,73 +54,13 @@ However, there are challenges to using icons. For example, how one person percei ### Core icons - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IconMeaningUsage
+| Icon | Meaning | Useage | +|:------------ |:-------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| | **Secure messaging** | Room header dropdown, About room, chat start +| | **Not encrypted** | Room header dropdown, About room, chat start +| | **Public room** | Room header dropdown, About room, chat start +| | **Trusted** | Room header, About room, People, Profile +| | **Information** | Anywhere contextual information is needed but there’s no actual problem that must be resolved +| | **Warning** | Anywhere a serious potential issue occurs +| | **Error** | Anywhere an actual issue occurs - - -Secure messagingRoom header dropdown, About room, chat start
- - - -Not encryptedRoom header dropdown, About room, chat start
- - - -Public roomRoom header dropdown, About room, chat start
- - - -TrustedRoom header, room header dropdown, About room, People, Profile
- - - -InformationAnywhere contextual information is needed but there’s no actual problem that must be resolved
- - - -WarningAnywhere a serious potential issue occurs
- - - -Error/problemAnywhere an actual issue occurs