wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Remove boxes/added-in-paragraph shortcode (#1970)

Browse source
This commit is contained in:
Kévin Commaille 2024-10-14 18:57:33 +02:00 • committed by GitHub
parent ae3673d2ef
commit 1e47d7ec48
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 1 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

23
assets/scss/_styles_project.scss
View file

@ -277,29 +277,6 @@ footer {
border-left-width: 5px;
background: $warning-background;
}
// XXX: See the added-in-paragraph.html shortcode for more information on these styles.
&.added-in-paragraph {
// Remove the padding and margin to remove the box look
margin: 0 !important; // !important on both to override table-related rules
padding: 0 !important;
// Make pairs of "added-in" and content inline to each other. We do pairs so authors can
// describe two paragraphs with added-in prefixes within a single box, reducing DOM
// complexity. Each paragraph is expected to be prefixed with an added-in, however.
//
// XXX: We assume the added-in and text will be rendered as paragraph elements.
> p {
display: inline;
}
> p:nth-child(2n) { // "even" rule to target just the content paragraphs
// Force a paragraph break after the content (insert a couple <br /> tags)
&::after {
content: '\A\A';
white-space: pre;
}
}
}
}
/* Styles for sections that are rendered from data, such as HTTP APIs and event schemas */

1
changelogs/internal/newsfragments/1970.clarification Normal file
View file

@ -0,0 +1 @@
Remove `boxes/added-in-paragraph` shortcode.

6
content/client-server-api/modules/content_repo.md
View file

@ -16,21 +16,17 @@ When serving content, the server SHOULD provide a
`Content-Security-Policy` header. The recommended policy is
`sandbox; default-src 'none'; script-src 'none'; plugin-types application/pdf; style-src 'unsafe-inline'; object-src 'self';`.
{{% boxes/added-in-paragraph %}}
{{< added-in v="1.4" >}} The server SHOULD additionally provide
`Cross-Origin-Resource-Policy: cross-origin` when serving content to allow
(web) clients to access restricted APIs such as `SharedArrayBuffer` when
interacting with the media repository.
{{% /boxes/added-in-paragraph %}}
{{% boxes/added-in-paragraph %}}
{{< changed-in v="1.11" >}} The unauthenticated download endpoints have been
deprecated in favour of newer, authenticated, ones. This change includes updating
the paths of all media endpoints from `/_matrix/media/*` to `/_matrix/client/{version}/media/*`,
with the exception of the `/upload` and `/create` endpoints. The upload/create
endpoints are expected to undergo a similar transition in a later version of the
specification.
{{% /boxes/added-in-paragraph %}}
#### Matrix Content (`mxc://`) URIs
@ -48,11 +44,9 @@ mxc://<server-name>/<media-id>
Clients can access the content repository using the following endpoints.
{{% boxes/added-in-paragraph %}}
{{< changed-in v="1.11" >}} A number of endpoints under the /_matrix/media hierarchy
have been deprecated and replaced with new endpoints which require authentication.
The deprecated endpoints are marked in the section below.
{{% /boxes/added-in-paragraph %}}
{{% boxes/warning %}}
By Matrix 1.12, servers SHOULD "freeze" the deprecated, unauthenticated, endpoints

2
content/server-server-api.md
View file

@ -1204,7 +1204,6 @@ Servers MUST use the server described in the [Matrix Content URI](/client-server
Formatted as `mxc://{ServerName}/{MediaID}`, servers MUST download the media from
`ServerName` using the below endpoints.
{{% boxes/added-in-paragraph %}}
{{< changed-in v="1.11" >}} Servers were previously advised to use the `/_matrix/media/*`
endpoints described by the [Content Repository module in the Client-Server API](/client-server-api/#content-repository),
however, those endpoints have been deprecated. New endpoints are introduced which
@ -1213,7 +1212,6 @@ the required access token to those endpoints. Instead, servers MUST try the endp
described below before falling back to the deprecated `/_matrix/media/*` endpoints
when they receive a `404 M_UNRECOGNIZED` error. When falling back, servers MUST
be sure to set `allow_remote` to `false`.
{{% /boxes/added-in-paragraph %}}
{{% http-api spec="server-server" api="content_repository" %}}

22
layouts/shortcodes/boxes/added-in-paragraph.html
View file

@ -1,22 +0,0 @@
{{/*
"Temporary" shortcode for rendering paragraphs which want/need inline added-in tags. It is
assumed that your content is described as follows:
{{% boxes/added-in-paragraph %}}
{{< added-in v="1.4" >}} Your text here
{{< added-in v="1.4" >}} Your other text here
{{% /boxes/added-in-paragraph %}}
The assumption is that at a later date this added-in-paragraph shortcode can be removed, making
the angle bracket-defined added-in shortcodes *just work*.
It is important that each new "content" paragraph (the bit after added-in) is preceded with
and added-in, otherwise you might find your text being weirdly merged.
This exists while the added-in shortcode cannot be inline in the client-server spec.
See https://github.com/matrix-org/matrix-spec/issues/1204
*/}}
{{ partial "alert" (dict "type" "added-in-paragraph" "content" .Inner) }}