Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update tables for VocabularyAndIconography.stories.mdx #112

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update tables for VocabularyAndIconography.stories.mdx #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
339 changes: 34 additions & 305 deletions stories/content/VocabularyAndIconography.stories.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,242 +12,31 @@ Below is a list of the most common terms or concepts the average user will come

### Glossary

<table>
<tr>
<td>Category</td>
<td>Name or label</td>
<td>User-friendly description</td>
</tr>
<tr>
<td>General</td>
<td>
<strong>Element</strong>
</td>
<td>
Element is an app that individual people, professional organisations,
governments, and communities use to communicate securely, powered by
Matrix.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Matrix</strong>
</td>
<td>
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.
</td>
</tr>
<tr>
<td>Registration</td>
<td>
<strong>Account provider</strong>
</td>
<td>
This is where your conversations will live — just like you would use an
email provider to keep your emails.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Account</strong>
</td>
<td>
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.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Password</strong>
</td>
<td>
A secret code or phrase that proves it’s you before giving you access to
your account.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Username</strong>
</td>
<td>Your official name on Element, which can't be changed later.</td>
</tr>
<tr>
<td></td>
<td>
<strong>Matrix ID</strong>
</td>
<td>
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.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Display name</strong>
</td>
<td>
The name shown next to your avatar, which other people will see in their
timeline. This can be changed anytime.
</td>
</tr>
<tr>
<td>Sign in</td>
<td>
<strong>Verify device</strong>
</td>
<td>
Confirm that it's you to set up secure messaging when signing into a new
device for the first time.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Scan QR code</strong>
</td>
<td>
Automatically sign in, set up secure messaging for a device, or verify
someone's identity by scanning a QR code.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Compare 6-digit code</strong>
</td>
<td>
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.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Enter recovery key</strong>
</td>
<td>
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.
</td>
</tr>
<tr>
<td>Messaging</td>
<td>
<strong>Chat</strong>
</td>
<td>Any conversation on Element.</td>
</tr>
<tr>
<td></td>
<td>
<strong>Direct message</strong>
</td>
<td>
A conversation between you and one other person. Nobody else can join.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Room</strong>
</td>
<td>
A conversation between three or more people, either private or public.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Secure messaging</strong>
</td>
<td>
Messages are end-to-end encrypted and can only be sent or read by people
in this room.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Not encrypted</strong>
</td>
<td>
Someone outside this room may be able to intercept and read any messages.
</td>
</tr>
<tr>
<td>Verification & Trust</td>
<td>
<strong>Verify user</strong>
</td>
<td>
Confirm the identity of another user by sharing a QR code or comparing a
string of numbers.{" "}
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Trusted person</strong>
</td>
<td>Anyone you’ve confirmed as the actual owner of an account.</td>
</tr>
<tr>
<td></td>
<td>
<strong>Trusted device</strong>
</td>
<td>
You've set up secure messaging after signing in to Element, so other users
can also trust your device.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Device</strong>
</td>
<td>Anywhere you're signed in to Element.</td>
</tr>
<tr>
<td></td>
<td>
<strong>Encryption keys</strong>
</td>
<td>
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.
</td>
</tr>
<tr>
<td></td>
<td>
<strong>Secure backup</strong>
</td>
<td>
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.
</td>
</tr>
</table>
| 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

Expand All @@ -265,73 +54,13 @@ However, there are challenges to using icons. For example, how one person percei

### Core icons

<table>
<tr>
<td>Icon</td>
<td>Meaning</td>
<td>Usage</td>
</tr>
<tr>
<td>
| Icon | Meaning | Useage |
|:------------ |:-------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="/img/icon-secure-messaging.jpg" alt="" /> | **Secure messaging** | Room header dropdown, About room, chat start
| <img src="/img/icon-unencrypted.jpg" alt="" /> | **Not encrypted** | Room header dropdown, About room, chat start
| <img src="/img/icon-public-room.jpg" alt="" /> | **Public room** | Room header dropdown, About room, chat start
| <img src="/img/icon-trusted.jpg" alt="" /> | **Trusted** | Room header, About room, People, Profile
| <img src="/img/icon-information.jpg" alt="" /> | **Information** | Anywhere contextual information is needed but there’s no actual problem that must be resolved
| <img src="/img/icon-warning.jpg" alt="" /> | **Warning** | Anywhere a serious potential issue occurs
| <img src="/img/icon-error.jpg" alt="" /> | **Error** | Anywhere an actual issue occurs

<img src="/img/icon-secure-messaging.jpg" alt="" />

</td>
<td><strong>Secure messaging</strong></td>
<td>Room header dropdown, About room, chat start</td>
</tr>
<tr>
<td>

<img src="/img/icon-unencrypted.jpg" alt="" />

</td>
<td><strong>Not encrypted</strong></td>
<td>Room header dropdown, About room, chat start</td>
</tr>
<tr>
<td>

<img src="/img/icon-public-room.jpg" alt="" />

</td>
<td><strong>Public room</strong></td>
<td>Room header dropdown, About room, chat start</td>
</tr>
<tr>
<td>

<img src="/img/icon-trusted.jpg" alt="" />

</td>
<td><strong>Trusted</strong></td>
<td>Room header, room header dropdown, About room, People, Profile</td>
</tr>
<tr>
<td>

<img src="/img/icon-information.jpg" alt="" />

</td>
<td><strong>Information</strong></td>
<td>Anywhere contextual information is needed but there’s no actual problem that must be resolved</td>
</tr>
<tr>
<td>

<img src="/img/icon-warning.jpg" alt="" />

</td>
<td><strong>Warning</strong></td>
<td>Anywhere a serious potential issue occurs</td>
</tr>
<tr>
<td>

<img src="/img/icon-error.jpg" alt="" />

</td>
<td><strong>Error/problem</strong></td>
<td>Anywhere an actual issue occurs</td>
</tr>
</table>