Update 5.4.0 and 5.3.8 to use the new format

This commit is contained in:
Jeremy Ruston
2025-09-12 15:05:45 +01:00
parent bc40bac10b
commit d5addd4ea5
16 changed files with 194 additions and 54 deletions

View File

@@ -254,6 +254,12 @@ a.doc-deprecated-version.tc-tiddlylink {
text-decoration: underline;
}
.doc-changenote-body {
margin-left: 2em;
font-style: italic;
font-size: 0.9em;
}
.doc-tiddler-fields {
background-color: <<colour code-background>>;
border: 1px solid <<colour tiddler-border>>;
@@ -283,6 +289,7 @@ a.doc-deprecated-version.tc-tiddlylink {
list-style: none;
display: flex;
flex-wrap: wrap;
padding: 0;
}
ol.doc-github-contributors li {
display: flex;

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/#9133
description: Update Chinese translation
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: enhancement
change-category: translation
link: https://github.com/TiddlyWiki/TiddlyWiki5/pull/9133
github-contributors: BramChen

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/#9166
description: Fixed name field of fa-IR language plugin
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: bugfix
change-category: translation
link: https://github.com/TiddlyWiki/TiddlyWiki5/issue/9166
github-contributors: Leilei332

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/#9175
description: Fixed Flexoki palette regressions
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: bugfix
change-category: palette
link: https://github.com/TiddlyWiki/TiddlyWiki5/pull/9175
github-contributors: Leilei332

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/#9184
description: Update Polish translation
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: enhancement
change-category: translation
link: https://github.com/TiddlyWiki/TiddlyWiki5/pull/9184
github-contributors: EvidentlyCube

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/#9185
description: Fixed [[Highlight Plugin]] theme listing
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: bugfix
change-category: plugin
link: https://github.com/TiddlyWiki/TiddlyWiki5/pull/9185
github-contributors: Leilei332

View File

@@ -0,0 +1,10 @@
title: $:/changenotes/5.3.8/32caeb69c3e7b75a80a84a1e14363e87175b164e
description: Revert breakage of [[list-tagged-draggable Macro]]
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: bugfix
change-category: hackability
link: https://github.com/TiddlyWiki/TiddlyWiki5/commit/32caeb69c3e7b75a80a84a1e14363e87175b164e
github-contributors: Jermolene
Reverted the [[change in v5.3.7|https://github.com/TiddlyWiki/TiddlyWiki5/pull/8721]] that broke the [[list-tagged-draggable Macro]]. The change involved updating some core macros to use procedures

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/75502266176de9d4a5e1f89cd7f2e455b7a2f6da
description: Update Greek translation
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: enhancement
change-category: translation
link: https://github.com/TiddlyWiki/TiddlyWiki5/commit/75502266176de9d4a5e1f89cd7f2e455b7a2f6da
github-contributors: superuser-does

View File

@@ -0,0 +1,8 @@
title: $:/changenotes/5.3.8/93d30f374da4a6b2037b335f7f7d4eddce8192db
description: Fixed display of field names longer than the available width in the info panel
release: 5.3.8
tags: $:/tags/ChangeNote
change-type: bugfix
change-category: usability
link: https://github.com/TiddlyWiki/TiddlyWiki5/commit/93d30f374da4a6b2037b335f7f7d4eddce8192db
github-contributors: Jermolene

View File

@@ -3,4 +3,8 @@ description: Offload server-only components to a plugin
release: 5.4.0
tags: $:/tags/ChangeNote
change-type: pluginisation
change-category: internal
link: https://github.com/TiddlyWiki/TiddlyWiki5/pull/9183
github-contributors: Jermolene
This change reduces the size of the core plugin by 114.5KB or about 4.5%.

View File

@@ -3,6 +3,8 @@ description: Split release notes into individual change notes
release: 5.4.0
tags: $:/tags/ChangeNote
change-type: enhancement
change-category: internal
link: https://github.com/TiddlyWiki/TiddlyWiki5/pull/9287
github-contributors: Jermolene
Doing so enables us to filter and group changes. For example, we could show all the breaking changes between two releases.

View File

@@ -7,14 +7,7 @@ type: text/vnd.tiddlywiki
description: Under development
\define release-introduction()
Release v5.4.0 includes major improvements in a number of areas:
* One thing
* Another thing
* More things
Release v5.4.0 includes major improvements in a number of areas. See the [[project plan|https://github.com/orgs/TiddlyWiki/projects/4]] for more details.
\end release-introduction
\define release-contributors()
\end release-contributors
<<releasenote 5.4.0>>

View File

@@ -6,7 +6,8 @@ title: Release Notes and Changes
* `title` by convention titles are formed `$:/changenotes/<version>/<unique identifier>`. The unique identifier is typically a GitHub PR or issue like `#1234` or a GitHub commit ID such as `98f850609d29bc36ded83f90c0d5be231649254b`
* `tags` must include `$:/tags/ChangeNote`, see below for other valid tags
* `change-type` see below for values
* `change-type` the type of change as a single string; see below for values
* `change-category` the category of the change; see below for vqalues
Other valid tags for change notes:
@@ -16,8 +17,22 @@ Other valid tags for change notes:
Valid change note types are as follows:
* ''bugfix''
* ''feature''
* ''enhancement''
* ''deprecation''
* ''security''
* ''pluginisation''
Valid change categories are as follows:
* ''internal''
* ''translation''
* ''plugin''
* ''widget''
* ''filters''
* ''usability''
* ''palette''
* ''hackability''
* ''nodejs''
* ''performance''
* ''developer''

View File

@@ -0,0 +1,25 @@
title: $:/tw5.com/releases/info/
category-order: translation plugin usability palette hackability widget filters performance nodejs internal developer
categories/internal/caption: Internal
categories/translation/caption: Translation
categories/plugin/caption: Plugin
categories/widget/caption: Widget
categories/usability/caption: Usability
categories/palette/caption: Palette
categories/hackability/caption: Hackability
categories/nodejs/caption: Node.js
categories/performance/caption: Performance
categories/developer/caption: Developer
change-types/bugfix/caption: BUGFIX
change-types/bugfix/colour: #ffe246
change-types/feature/caption: FEATURE
change-types/feature/colour: #91ba66
change-types/enhancement/caption: ENHANCEMENT
change-types/enhancement/colour: #cba5ff
change-types/deprecation/caption: DEPRECATION
change-types/deprecation/colour: #ff9d6c
change-types/security/caption: SECURITY
change-types/security/colour: #ff6666
change-types/pluginisation/caption: PLUGINISATION
change-types/pluginisation/colour: #aaaaaa

View File

@@ -1,21 +1,18 @@
title: $:/tw5.com/releases/procedures
tags: $:/tags/Global
\procedure releasenote(release)
<$let
releaseTiddler={{{ [all[tiddlers]tag[ReleaseNotes]] :filter[{!!caption}match<release>] }}}
releaseTiddlerCreated={{{ [<releaseTiddler>get[created]] }}}
\procedure github-changes-link()
<a
class="tc-tiddlylink-external"
href=`https://github.com/TiddlyWiki/TiddlyWiki5/compare/v${ [all[tiddlers]tag[ReleaseNotes]has[released]!sort[released]] :filter[get[released]compare:number:lt<releaseTiddlerCreated>] +[get[caption]] }$...${ [<releaseTiddler>has[released]get[caption]addprefix[v]] :else[[master]] }$`
rel="noopener noreferrer"
target="_blank"
>
<a
class="tc-tiddlylink-external"
href=`https://github.com/TiddlyWiki/TiddlyWiki5/compare/v${ [all[tiddlers]tag[ReleaseNotes]has[released]!sort[released]] :filter[get[released]compare:number:lt<releaseTiddlerCreated>] +[get[caption]] }$...${ [<releaseTiddler>has[released]get[caption]addprefix[v]] :else[[master]] }$`
rel="noopener noreferrer"
target="_blank"
>
See ~GitHub for detailed change history of this release
</a>
</$let>
See ~GitHub for detailed change history of this release
</a>
\end github-changes-link
\procedure banner-credits()
<%if [<banner-credit-user-name>!match[]] %>
<img src=<<banner-credit-permalink>> width="140" style="float:left;margin-right:0.5em;"/>
@@ -37,19 +34,42 @@ for their winning design for the banner for this release (here is the
<div style="clear:both;"/>
<%endif%>
\end banner-credits
! Introduction
<$transclude $variable="release-introduction" $mode="block"/>
<%if [enlist<release-contributors>count[]!match[0]] %>
! Acknowledgements
[[@Jermolene|https://github.com/Jermolene]] would like to thank the contributors to this release who have generously given their time to help improve TiddlyWiki:
\procedure change-list()
\whitespace trim
<$list filter="[enlist{$:/tw5.com/releases/info/category-order}]" variable="category">
<%if [tag[$:/tags/ChangeNote]] :filter[{!!release}match<release>] :filter[{!!change-category}match<category>] %>
<h2>
<$text text={{{ [[$:/tw5.com/releases/info/categories/]addsuffix<category>addsuffix[/caption]get[text]] }}} />
</h2>
<ul>
<$list filter="[tag[$:/tags/ChangeNote]] :filter[{!!release}match<release>] :filter[{!!change-category}match<category>]" variable="change">
<li>
<a
href={{{ [<change>get[link]] }}}
class="doc-link-badge"
target="_blank"
rel="noopener noreferrer"
style.backgroundColor={{{ [<change>get[change-type]addprefix[$:/tw5.com/releases/info/change-types/]addsuffix[/colour]get[text]] }}}
>
<$text text={{{ [<change>get[change-type]addprefix[$:/tw5.com/releases/info/change-types/]addsuffix[/caption]get[text]] }}}/>
</a>
<$text text=" "/>
<$transclude $tiddler=<<change>> $field="description" $mode="inline"/>
<div class="doc-changenote-body">
<$transclude $tiddler=<<change>> $mode="block"/>
</div>
</li>
</$list>
</ul>
<%endif%>
</$list>
\end change-list
\procedure acknowledgements()
<ol class="doc-github-contributors">
<$list filter="[enlist<release-contributors>sort[]]" variable="username">
<$list filter="[enlist<release-github-contributors>sort[]]" variable="username">
<li>
<a href={{{ [[https://github.com/]addsuffix<username>] }}} class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer">
<img src={{{ [[https://github.com/]addsuffix<username>addsuffix[.png?size=64]] }}} width="64" height="64"/>
@@ -60,7 +80,36 @@ for their winning design for the banner for this release (here is the
</li>
</$list>
</ol>
\end acknowledgements
<%endif%>
\procedure releasenote(release)
<$let
releaseTiddler={{{ [all[tiddlers]tag[ReleaseNotes]] :filter[{!!caption}match<release>] }}}
releaseTiddlerCreated={{{ [<releaseTiddler>get[created]] }}}
release-github-contributors={{{ [tag[$:/tags/ChangeNote]] :filter[{!!release}match<release>] :map:flat[enlist{!!github-contributors}] +[sort[]format:titlelist[]join[ ]]}}}
>
<<github-changes-link>>
<<banner-credits>>
! Introduction
<$transclude $variable="release-introduction" $mode="block"/>
! Changes
This release includes the following changes.
<<change-list>>
<!-- Acknowledgement list -->
! Acknowledgements
A warm thank you to the developers who have contributed to this release:
<<acknowledgements>>
</$let>
\end releasenote

View File

@@ -9,29 +9,8 @@ type: text/vnd.tiddlywiki
\define release-introduction()
This is a bug fix release for TiddlyWiki [[Release 5.3.7]] that fixes problems introduced in that release.
! Translation improvements
* Chinese
* Polish
* Greek
! Bug Fixes
* <<.link-badge-reverted "https://github.com/TiddlyWiki/TiddlyWiki5/commit/32caeb69c3e7b75a80a84a1e14363e87175b164e">> the [[change in v5.3.7|https://github.com/TiddlyWiki/TiddlyWiki5/pull/8721]] that broke the [[list-tagged-draggable Macro]]. The change involved updating some core macros to use procedures
* <<.link-badge-fixed "https://github.com/TiddlyWiki/TiddlyWiki5/commit/93d30f374da4a6b2037b335f7f7d4eddce8192db">> display of field names longer than the available width in the info panel
* <<.link-badge-fixed "https://github.com/TiddlyWiki/TiddlyWiki5/pull/9185">> [[Highlight Plugin]] theme listing
* <<.link-badge-fixed "https://github.com/TiddlyWiki/TiddlyWiki5/pull/9175">> Flexoki palette regressions
* <<.link-badge-fixed "https://github.com/TiddlyWiki/TiddlyWiki5/issues/9166">> name field of fa-IR language plugin
\end release-introduction
\define release-contributors()
CeeBeeTree
EvidentlyCube
Leilei332
pmario
\end release-contributors
\define banner-credit-user-name() Christian Byron
\define banner-credit-user-link() https://talk.tiddlywiki.org/u/Christian_Byron
\define banner-credit-discussion-link() https://talk.tiddlywiki.org/t/planning-a-v5-3-8-bug-fix-release/12963