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

Fix the table of content for room versions (#1884)

Browse source 
* Fix ToC for room versions pages

Like for the cs-module shortcode, use .RenderShortcodes
instead of .Content for the rver-fragment shortcode,
so the headings are detected by Hugo.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Change the way "this version" is detected in added-in and changed-in shortcodes

Now that we use .RenderShortcodes in the rver-fragment shortcode,
we cannot remove the output of these shortcodes dynamically
because they are replaced by a temporary placeholder due to Hugo's internals.

Instead, since the `this` parameter was only used for room version,
we always use the `v` parameter and compare with the version
provided in the page's front matter.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add changelog

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Add version front matter for v11

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>

* Update changelogs/room_versions/newsfragments/1884.clarification

---------

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
Co-authored-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Kévin Commaille 2024-06-20 17:47:09 +02:00 • committed by GitHub
parent 18628dc5d7
commit 3af77f0cb4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
20 changed files with 60 additions and 51 deletions
Download patch file Download diff file Expand all files Collapse all files

13
layouts/shortcodes/added-in.html
View file

@ -1,8 +1,9 @@
{{ $ver := .Params.v }}
{{ $this := .Params.this }}
{{- $ver := .Params.v -}}
{{ if $this }}
<span><strong>[New in this version]</strong></span>
{{ else }}
{{- with page.Params.version -}}
{{- if eq $ver . -}}
<span><strong>[New in this version]</strong></span>
{{- end -}}
{{- else -}}
<span><strong>[Added in <code>v{{ $ver }}</code>]</strong></span>
{{ end }} {{/* Do not leave an empty line at the end of this file otherwise the inline behaviour breaks. */}}
{{- end -}}

13
layouts/shortcodes/changed-in.html
View file

@ -1,8 +1,9 @@
{{ $ver := .Params.v }}
{{ $this := .Params.this }}
{{- $ver := .Params.v -}}
{{ if $this }}
<span><strong>[Changed in this version]</strong></span>
{{ else }}
{{- with page.Params.version -}}
{{- if eq $ver . -}}
<span><strong>[Changed in this version]</strong></span>
{{- end -}}
{{- else -}}
<span><strong>[Changed in <code>v{{ $ver }}</code>]</strong></span>
{{ end }} {{/* Do not leave an empty line at the end of this file otherwise the inline behaviour breaks. */}}
{{- end -}}

2
layouts/shortcodes/rver-fragment.html
View file

@ -19,7 +19,7 @@
{{ with .Site.GetPage "rooms/fragments" }}
{{ with .Resources.GetMatch (printf "%s%s" $name ".md") }}
{{ $content := .Content }}
{{ $content := .RenderShortcodes }}
{{ if not $withVersioning }}
{{ $content = (replace $content "[New in this version]" "") }}
{{ $content = (replace $content "[Changed in this version]" "") }}