From 519ddf32de262d94d70792b1841311b7dae7e1a7 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Wed, 26 Oct 2022 11:29:03 +0100 Subject: [PATCH] Replace misuses of 'plaintext' with 'cleartext' Also replaces the term in the documentation of spoilers, where 'spoilered text' makes more sense, in my opinion. --- content/client-server-api/_index.md | 6 +++--- content/client-server-api/modules/instant_messaging.md | 7 ++++--- content/identity-service-api.md | 2 +- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index 1407441b..d6dec7a2 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -1945,14 +1945,14 @@ parent event, for example. {{% /boxes/note %}} To allow the server to aggregate and find child events for a parent, the `m.relates_to` -key of an event MUST be included in the plaintext copy of the event. It cannot be +key of an event MUST be included in the cleartext portion of the event. It cannot be exclusively recorded in the encrypted payload as the server cannot decrypt the event for processing. {{% boxes/warning %}} If an encrypted event contains an `m.relates_to` in its payload, it should be -ignored and instead favour the plaintext `m.relates_to` copy (including when there -is no plaintext copy). This is to ensure the client's behaviour matches the server's +ignored and instead favour the cleartext `m.relates_to` copy (including when there +is no cleartext copy). This is to ensure the client's behaviour matches the server's capability to handle relationships. {{% /boxes/warning %}} diff --git a/content/client-server-api/modules/instant_messaging.md b/content/client-server-api/modules/instant_messaging.md index 47440cd3..88ed31c0 100644 --- a/content/client-server-api/modules/instant_messaging.md +++ b/content/client-server-api/modules/instant_messaging.md @@ -327,11 +327,12 @@ If a reason were to be supplied, it would look like: } ``` -When sending a spoiler, clients SHOULD provide the plain text fallback in the `body` +When sending a spoiler, clients SHOULD provide the spoilered text fallback in the `body` as shown above (including the reason). The fallback SHOULD omit the spoiler text verbatim since `body` might show up in text-only clients or in notifications. To prevent spoilers -showing up in such situations, clients are strongly encouraged to first upload the plaintext -to the media repository then reference the MXC URI in a markdown-style link, as shown above. +showing up in such situations, clients are strongly encouraged to first upload the spoilered +text to the media repository then reference the MXC URI in a markdown-style link, as shown +above. Clients SHOULD render spoilers differently with some sort of disclosure. For example, the client could blur the actual text and ask the user to click on it for it to be revealed. diff --git a/content/identity-service-api.md b/content/identity-service-api.md index c4d4a31a..9c5a93c4 100644 --- a/content/identity-service-api.md +++ b/content/identity-service-api.md @@ -280,7 +280,7 @@ request. #### `none` -This algorithm performs plaintext lookups on the identity server. +This algorithm performs cleartext lookups on the identity server. Typically this algorithm should not be used due to the security concerns of unhashed identifiers, however some scenarios (such as LDAP-backed identity servers) prevent the use of hashed identifiers. Identity