tiddlywiki 5.1.21 → 5.2.1

package/editions/tw5.com/tiddlers/releasenotes/Release 5.2.0.tid

@@ -0,0 +1,297 @@
+caption: 5.2.0
+created: 20211003151502543
+modified: 20211003151502543
+released: 20211003151502543
+tags: ReleaseNotes
+title: Release 5.2.0
+type: text/vnd.tiddlywiki
+
+\define contributor(username)
+<a href="https://github.com/$username$" style="text-decoration:none;font-size:24px;" class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer"><img src="https://github.com/$username$.png?size=32" width="32" height="32"/> @<$text text=<<__username__>>/></a>
+\end
+
+//[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.1.23...v5.2.0]]//
+
+! Highlights
+
+!! Unrestricted Fieldnames and the New JSON Store Area
+
+The major change in this release is that the format used to store tiddlers in TiddlyWiki's HTML file has changed from an HTML DIV-based format to a new JSON-based format. The consequences of this change are far-reaching. They are thus the primary rationale for bumping the version number from v5.1.x to v5.2.0:
+
+Firstly, the ''characters that can be used in field names are now unrestricted'' (just like tiddler titles), making it possible to use fieldnames like `My^Field` or `☃️`. This has become possible because every other part of TiddlyWiki was already capable of dealing with unrestricted field names apart from saving as an HTML file.
+
+Secondly, external tools that read, write or otherwise process TiddlyWiki HTML files will need modification to understand the new store area format.  The details are documented in the [[/dev wiki|https://tiddlywiki.com/dev/#Data%20Storage%20in%20Single%20File%20TiddlyWiki]].
+
+For more details, see ticket [[#5708|https://github.com/Jermolene/TiddlyWiki5/pull/5708]] on GitHub.
+
+!! Dragging and Dropping Images into the Editor
+
+It is now possible to drag and drop an image file directly into the tiddler text editor. A popup allows the incoming image tiddler to be renamed, and then `[img[title]]` is automatically inserted into the tiddler text at the insertion point.
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5699">> (and again [[here|https://github.com/Jermolene/TiddlyWiki5/pull/5705]]) ability to drag and drop images directly in the editor
+
+!! Simplified Access to Tiddler Title with ActionCreateTiddlerWidget
+
+It is now possible to embed actions within the body of the ActionCreateTiddlerWidget, and those actions can directly access the title of the newly created tidddler via the variable `createTiddler-title`, and the title of the corresponding draft in the variable `createTiddler-draftTitle`. The old `$savetitle` and `$savedrafttitle` attributes are now deprecated.
+
+```
+<$button>
+  <$action-createtiddler $basetitle="Homemade Button" tags="$:/tags/PageControls" text={{$:/state/new-button-caption}}>
+    <$action-navigate $to=<<createTiddler-title>>/>
+  </$action-createtiddler>
+  Create a new non-functional page control button and open the tiddler
+</$button>
+```
+
+For more details:
+
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/9faaa312998d48c56bd50335820b6b881266af4b">> [[ActionCreateTiddlerWidget]] to make the new title available as a variable
+
+!! More Flexible Parsing of Macros
+
+Two long-standing limitations of TiddlyWiki's macro syntax have been resolved.
+
+First, it is now possible to nest macro calls within the parameters to other macros. For example:
+
+```
+<<mymacro arg:"""nested <<macro>> call""">>
+```
+
+Second, macro parameters can now be used within filter expressions. For example:
+
+```
+[<qualify "$:/state/mydata">addsuffix[-]addsuffix<now "YYYY MM DDD hh:mm:ss">]
+```
+
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5451">> macro calls to use the same parser as that used for widget attributes
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5836">> support for macro parameters within filters (see [[Filter Parameter]])
+
+!! Optimised Refreshing of Transclusions
+
+This simple-sounding change has several important consequences:
+
+The first consequence is that it makes the TranscludeWidget much more efficient, and improves the performance of the refresh cycle.
+
+The second consequence resolves a long-standing difficulty for many users: it is now possible to use an EditWidget to edit another field of the same tiddler. Previously, the edit widget would not work properly in such cases because it would be refreshed on every keypress, leading to the current editing caret/selection position being lost.
+
+As sometimes happens, the third consequence is that constructions that relied on the old, buggy behaviour may no longer work as expected. A common example of such a construction is an invocation of a JavaScript macro. The problem stems from the fact that JavaScript macros are designed to be as simple as possible from the developers perspective, being pure functions that have no side effects, and that always return the same value for the same parameters. In particular, JavaScript macros cannot participate in TiddlyWiki's refresh mechansim, so they cannot force themselves to be updated when underlying data changes (for situations where such processing is needed, JavaScript widgets should be used instead of JavaScript macros).
+
+However, developers have sometimes worked around this limitation by using the TranscludeWidget to force refreshing of a macro invocation when a particular tiddler changes. The newer, more selective behaviour means that sometimes such widgets will avoid a refresh that was previously relied upon to update the JavaScript macro.
+
+For end users, if an upgrade to v5.2.0 causes problems then consult the discussion [[Forums]] to see if other users have encountered the same problem, and make a new posting if needed.
+
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5736">> the TranscludeWidget to avoid triggering a refresh unless the transcluded field changes (previously it was also triggered for changes to other fields)
+
+!! Other Notable Improvements
+
+<<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5611">> (and [[here|https://github.com/Jermolene/TiddlyWiki5/commit/4a99e0cc7d4a6b9e7071c0b2a9a0f63c3c7d2492]]) the [[ListWidget]] with an optional `counter` attribute specifying a variable to contain the numeric index of each list item. This is useful for creating a list of numbered items, and for detecting the first and last entries in a list
+
+<<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/3094e062366830bdecfb91e3d852667fa951dc50">> action widget execution with an optional new mode that ensures that all widgets are refreshed before invocation -- see [[ActionWidget Execution Modes]]. This resolves a long-standing inconsistency in the way that ActionWidgets are executed, making them behave much more like a conventional programming language
+
+<<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5726">> the HTML comment syntax to enable it to be used before and in between pragmas such as macro definitions. This makes it much easier to provide documentation within complex wikitext tiddlers
+
+<<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/a360adbba924d222c5b55709133c18890c04398d">> size of dropzone when story river is empty. For a long time, TiddlyWiki confusingly wouldn't recognise a drag and drop operation if the story river was empty
+
+! Performance Improvements
+
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5380">> (and again [[here|https://github.com/Jermolene/TiddlyWiki5/pull/5488]]) the efficiency of the linked list implementation used in filter processing
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5362">> the [[all Operator]] and [[here|https://github.com/Jermolene/TiddlyWiki5/pull/5369"]] the [[links Operator]], and [[here|https://github.com/Jermolene/TiddlyWiki5/pull/6050]] the [[backlinks Operator]] to use the new linked list implementation
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5436">> [[ETag|https://en.wikipedia.org/wiki/HTTP_ETag]]-based browser-side caching for all resources and GZip or Deflate compression for all responses to GET requests
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/commit/70e60cd93fe26e9cde1e350e3236578fa5abfe48">> plugin internal formatting to remove unneeded whitespace, saving about 6% on the size of the $:/core plugin
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/6053">> performance of [[sort Operator]] through optimising common cases
+
+! Usability Improvements
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5479">> ability to import previously blocked system tiddlers
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5812">> warning message when cancelling a pending import
+* <<.link-badge-updated "https://github.com/Jermolene/TiddlyWiki5/commit/f97850dd05693e84dd36b8af5d72b22fbfd74958">> the default font weights in the "Snow White" theme to be thicker and more legible
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5816">> modal mechanism to prevent page from scrolling while modals are displayed
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5326">> fill colour for "remove tag" button
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5370">> page title so that the separating em-dash is only used if the site subtitle is present
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5397">> broken aria-label in $:/PaletteManager
+* <<.link-badge-updated "https://github.com/Jermolene/TiddlyWiki5/commit/caec6bc3fea9155eb2b0aae64d577c565dd7b088">> SVG optimiser script
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/c325380231a8c592a6e51d4498c1e6c3a241b539">> plus/minus SVG icons: <<.icon $:/core/images/plus-button>> and <<.icon $:/core/images/minus-button>>
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5672">> link to the existing tiddler when the warning "Target tiddler already exists" is displayed in the edit template
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5727">> class to make tag pills in the edit template look like those in the ViewTemplate
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/1661">> overflow of long field values that do not contain whitespace
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/commit/a4421f50c6886b02c3595b7ffa6ba72674d6bf21">> GitHub, Gitea and GitLab savers to wikify the commit message, enabling macros to be used in the message
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5981">> the [[text editor stamp toolbar button|Using Stamp]] dropdown to allow sorting by drag and drop
+
+! Widget Improvements
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/9eda02868f21e9dd1733ffe26352bd7ac96285b4">> (and [[here|https://github.com/Jermolene/TiddlyWiki5/commit/f87b3bfcdba79b6ad198af286bd827c61044891f]]) new MessageCatcherWidget to catch arbitrary messages and execute action strings
+* <<.link-badge-modified "https://github.com/Jermolene/TiddlyWiki5/commit/b9647b2c48152dac069a1099a0822b32375a66cf">> [[FieldManglerWidget]] to ensure it doesn't propogate events that it traps
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5597">> [[DropzoneWidget]] to optionally invoke actions after the `tm-import-tiddlers` message has been sent, and to specify an optional `contentTypesFilter` which determines which content types are accepted by the dropzone.
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/07caa16e8714afe9a64eb202375e4a2f95da1508">> [[DropzoneWidget]] to also use the specified deserializer for strings either dropped or pasted on to the dropzone
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5635">> [[SelectWidget]] refreshing
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5644">> [[ActionListopsWidget]] bug by avoiding concatenating fragments of filter expressions
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/3f986861538a3cc5c3c6da578b45d0d9138a6b2b">> [[ActionPopupWidget]] to create floating popups that must be manually cleared
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5648">> (and [[here|https://github.com/Jermolene/TiddlyWiki5/pull/5782]]) [[KeyboardWidget]] to provide additional information variables
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/e9e5d37ff01cc1aaa3419798904dac8b0e9775af">> DraggableWidget with option to hide the drag image
+
+! Filter improvements
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5813">> new [[:map filter run prefix|Map Filter Run Prefix]]
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5653">> new [[:sort filter run prefix|Sort Filter Run Prefix]]
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5612">> [[average Operator]], [[median Operator]], [[variance Operator]] and [[standard-deviation Operator]] for calculating averages of a list of numbers
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5673">> [[deserializers filter Operator|deserializers Operator]] for obtaining a list of the available deserializers
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5665">> [[format:titlelist operator|format Operator]] for selectively adding double square brackets around titles
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/83ee363cb4c19246ac977f55e46439dd8a1508ba">> [[charcode Operator]] for easily accessing special characters like tab and linefeed
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5252">> support for suffixes to filter run prefixes
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5968">> [[search-replace Operator]] with ''m'' flag for multiline mode
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/e6fd0caf6b997c24c116def354b2a65d8909279e">> [[range Operator]] to allow parameters to be specified as separate operands
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6055">> [[moduleproperty Operator]] and extended [[modules Operator]] to provide access to internal JavaScript modules
+
+! Hackability Improvements
+
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5361">> [[unusedtitle Macro]] to add ''separator'' and ''template'' parameters
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5720">> ''color-scheme'' field to all themes to differentiate between light and dark themes
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/d25e540dd2f0decf61c52fdc665a28a5dfeda93f">> support for `image/vnd.microsoft.icon` content type
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5458">> support for throttling refreshes for changed tiddlers with the title prefix $:/temp/volatile/
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/89546b3357b0696a7047e6915bd6cd137b589de6">> a hidden setting to control sandboxing of tiddlers of type `text/html`
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5707">> text operation [[insert-text|WidgetMessage: tm-edit-text-operation]]
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/e157d16b724172f752da0ff714847e0c0ca9664d">> ''data-tag-title'' attribute to tag pills
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5294">> support for [[dynamic toolbar buttons|How to create dynamic editor toolbar buttons]]
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5694">> new [[SystemTag: $:/tags/ControlPanel/Plugins]] for customising the tabs shown under the "Plugins" tab of control panel
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/59a53e695b28144f8f788469dad7865499d95d79">> support for DateFormat tokens for weekday number and day of year
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/ebf563ac70b2053fcaed8c544ae83e839878e3bd">> further transliteration pairs for the [[slugify Operator]]
+
+! Client-server Improvements
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/e96a54c7531a2d9e07745e27d2015d8d7d09588f">> crash running in client server configuration when 'ETag' header is missing
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5423">> blank favicon when using lazily loaded images
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/issues/4461">> web server issue with custom path prefix and basic authentication
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5416">> crash on Node.js with ActionSetFieldWidget when type field is given a value upon new tiddler creation
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5329">> issue with saving tiddler files with titles that already end in the required extension
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5465">> several consistency issues with the filesystem plugin
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/issues/5483">> issue with encoding of $:/config/OriginalTiddlerPaths outside the wiki folder
+* <<.link-badge-updated "https://github.com/Jermolene/TiddlyWiki5/pull/5628">> the TiddlySpot Saver settings form
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5638">> 401 and 403 error messages for PUT saver
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5570">> the [[external JavaScript template|Using the external JavaScript template]] to be easier to use and work more smoothly when offline
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5931">> incorrect usage of X-Requested-With header for simple HTTP requests
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/a67b1b8bb5dcff5e6e3151844d96bf882ae4a976">> security issue allowing [[access to files|Using the integrated static file server]] outside the `./files/` folder
+
+! Node.js Improvements
+
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/a38dc1730010c6a2b6a011aff4818bbc67c04055">> RenderCommand to allow multiple variables to be passed
+
+! Plugin Improvements
+
+!! [[Markdown Plugin]]
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5846">> support for using the [[KaTeX Plugin]] in Markdown
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5848">> extraneous paragraph tags in lists
+
+!! [[XLSX Utilities Plugin|XLSX Utilities Edition]]
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/issues/5400">> crash with the XLSX Utils plugin
+
+!! [[KaTeX Plugin]]
+
+* <<.link-badge-updated "https://github.com/Jermolene/TiddlyWiki5/commit/a2ca5e4d1ef67374628d2d78afa1550443900ec0">> to KaTeX v0.13.18
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5933">> custom macro editor
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6046">> automatic numbering reset for each displayed tiddler
+
+!! [[Freelinks Plugin]]
+
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/0ed32fded996826a59832d7a7555bb16c4a57864">> the Freelinks plugin with a filter to determine which tiddlers can be the targets of freelinks
+
+!! [[Menubar Plugin]]
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/discussions/5533">> Menu plugin to support optional ''dropdown-position'' field
+
+!! [[BibTeX Plugin]]
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/issues/5581">> BibTeX Plugin to report errors more sensibly
+* <<.link-badge-modified "https://github.com/Jermolene/TiddlyWiki5/commit/953fb9f237ad78e409c03d4b29b9854d8abf6cdf">> BibTex Plugin to force fieldnames to be lowercase
+
+! Developer Experience Improvements
+
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5382">> the widget subclassing mechanism to work with widgets that add event listeners in their constructor
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/pull/5377">> the Jasmine test suite output
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/commit/9f9ce6595b08032a602981f82940ca113cff8211">> wikitext parser with a subclassing mechanism
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/commit/ef76349c37662e9706acfffc2c2edb51a920183d">> added support for ''utils-browser'' modules
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5464">> ''th-before-importing'' hook to allow plugins to inspect or modify the `importTiddler` object before any tiddlers are imported
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/3797">> ''th-closing-tiddler'' hook when tiddlers are closed
+
+! Translation improvements
+
+* <<.link-badge-added>> Polish translation
+* <<.link-badge-improved>> Catalan translation
+* <<.link-badge-improved>> Chinese translations
+* <<.link-badge-improved>> French translation
+* <<.link-badge-improved>> German translations
+* <<.link-badge-improved>> Spanish translation
+
+! Other Bug Fixes
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5999">> crash with malformed input to `decodeURIComponent()`
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5376">> issue with [[lookup Operator]] returning "undefined" under some circumstances
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/issues/5396">> crash with unterminated wikitext comments
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5453">> tiddler info area content bleeding on close animation
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5452">> inline/block widget parsing glitch
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5401">> runaway regexp when parsing filters
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5440">> right margin of tag pill when used outside of the tags wrapper
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/5455">> upload saver to optionally work without a username or password
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/5e4430dbf9ff66d9a18fbdf3005abcd716efc07d">> RadioWidget to refresh selectively, and to use the ''checked'' attribute correctly
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5542">> "invert" option of `wiki.search()` method
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/7b1a0c6e6a8bd2d3badf8766af0cd3f5f7ac5ec8">> ES5 compatibility issue
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/226df2ad7d2978d3d7400d94767a0503e495cf98">> exporting of tiddlers that begin and end with double quotes
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/commit/d56e8764a1f02a214df5da1cc95191be2da2491b">> accessibility of button widget when controlling a popup
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/d6ea369f5ef9d3092a360a4286a99902df37782b">> EditTextWidget to use default text for missing fields
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5552">> css-escape-polyfill to work under Node.js
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/dbd3f835bf8399ed1a3da7cc322ec9b6ab783d53">> (and [[here|https://github.com/Jermolene/TiddlyWiki5/commit/fb4d77ef46e23c23f4e46c13f4a529aa29a27dcd]]) crash when sorting by non-string fields
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5711">> (and [[here|https://github.com/Jermolene/TiddlyWiki5/pull/5868]]) some bugs in the [[EventCatcherWidget]], introduced new `stopPropagation` attribute and new syntax for specifying actions
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5691">> CurrentTiddler variable consistency in subfilters and prefixes
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/485779f5b2136b7bcd739352b56188d94b0eb9e4">> crash when accessing variables in filters that don't have a widget context
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/8fbf52e419e71d726ea32b6c44e3ccfc4245d825">> unnecessary triggering of reload warning when JavaScript tiddlers are not subsequently imported
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5521">> minor issue with import pragma 
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5700">> leading and trailing whitespace in themes
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5469">> configuration list of HTML5 block elements
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5692">> shape and color for disabled button to work with `tc-btn-invisible` class
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/5473">> inconsistent spacing of view toolbar items
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/2720072b23593c87e7909d12c75c5b136e1bdf99">> crash when assigning new value to file input controls
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6003">> [[text editor stamp button|Using Stamp]] to work with prefixes and suffixes in shadow tiddlers
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/62b8a83741e6eccfaead5ea7960c0400b6db5f4a">> Internet Explorer crash when pasting text using an HTA
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6036">> bug with `[all[shadows]]` sometimes returning overridden shadow tiddlers
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6044">> refresh bug with radio widget where the tc-radio-selected class is not correctly updated
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/f6eadbd1c900b5f779ebbf3c539192cd3c2b98cc">> crash with reading invalid JSON files
+
+! 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:
+
+* <<contributor 8d1h>>
+* <<contributor Arlen22>>
+* <<contributor BlueGreenMagick>>
+* <<contributor BramChen>>
+* <<contributor BurningTreeC>>
+* <<contributor cdruan>>
+* <<contributor clutterstack>>
+* <<contributor CodaCodr>>
+* <<contributor dixonge>>
+* <<contributor donmor>>
+* <<contributor felixhayashi>>
+* <<contributor FlashSystems>>
+* <<contributor flibbles>>
+* <<contributor FND>>
+* <<contributor hoelzro>>
+* <<contributor jeremyredhead>>
+* <<contributor joebordes>>
+* <<contributor joshuafontany>>
+* <<contributor kookma>>
+* <<contributor laomaiweng>>
+* <<contributor leehawk787>>
+* <<contributor Marxsal>>
+* <<contributor morosanuae>>
+* <<contributor neumark>>
+* <<contributor NicolasPetton>>
+* <<contributor OdinJorna>>
+* <<contributor pmario>>
+* <<contributor rryan>>
+* <<contributor saqimtiaz>>
+* <<contributor simonbaird>>
+* <<contributor slaymaker1907>>
+* <<contributor sobjornstad>>
+* <<contributor twMat>>
+* <<contributor xcazin>>

package/editions/tw5.com/tiddlers/releasenotes/Release 5.2.1.tid

@@ -0,0 +1,118 @@
+caption: 5.2.1
+created: 20211208115833846
+modified: 20211208115833846
+released: 20211208115833846
+tags: ReleaseNotes
+title: Release 5.2.1
+type: text/vnd.tiddlywiki
+
+\define contributor(username)
+<a href="https://github.com/$username$" style="text-decoration:none;font-size:24px;" class="tc-tiddlylink-external" target="_blank" rel="noopener noreferrer"><img src="https://github.com/$username$.png?size=32" width="32" height="32"/> @<$text text=<<__username__>>/></a>
+\end
+
+//[[See GitHub for detailed change history of this release|https://github.com/Jermolene/TiddlyWiki5/compare/v5.2.0...v5.2.1]]//
+
+! Highlights
+
+!! <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6168">> New Filter Cascade Mechanism
+
+The [[cascade mechanism|Cascades]] provides a flexible way to choose between multiple options. Crucially, it is done in a way that makes it simple for plugins to tweak the logic or add their own options.
+
+Some of the things that can be done with cascades are:
+
+* Replacing the default tiddler body template with a custom one for a certain type of tiddler
+* Giving all journal tiddlers a custom icon
+* Implementing a custom editor for certain types of tiddler
+
+There are two parts to these changes. The underpinning is a new [[Cascade Filter Run Prefix]] that takes a list of filters and runs them in order, returning the result of the first one to return a value.
+
+The second part is a series of improvements based on this new filter cascade mechanism. Conditional logic that was previously hidden within core templates can now be extended and tweaked much more easily than before.
+
+Choosing the following elements of the core user interface is now handled with cascades:
+
+* [[Story Tiddler Templates|Story Tiddler Template Cascade]]
+* [[Tiddler Colour|Tiddler Colour Cascade]]
+* [[Tiddler Icons|Tiddler Icon Cascade]]
+* [[View Template Body|View Template Body Cascade]]
+* [[View Template Title|View Template Title Cascade]]
+* [[Edit Template Body|Edit Template Body Cascade]]
+
+The cascades can be inspected in $:/ControlPanel under ''Info'' -> ''Advanced'' -> ''Cascades''.
+
+See [[Cascades]] for more information.
+
+!! <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6148">> New LetWidget
+
+The LetWidget is an improved alternative to the existing VarsWidget. It is recommended to use the new LetWidget instead of the VarsWidget in all circumstances.
+
+The chief advantage is that the LetWidget performs the variable assignments in the same order as they are written, and permits references to earlier assignments. For example, here we swap the values of two variables:
+
+```
+<$let temp=<<foo>> foo=<<bar>> bar=<<temp>>>
+...
+</$let>
+```
+
+! Bug Fixes
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6261">> fixed issue with drag and drop in Chrome 96
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6278">> fixed issue with drag and drop and the [[CodeMirror Plugin]] in Chrome 96
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6013">> refreshing of LinkWidget attributes
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6107">> crash when using "source=basename-uri-decoded" in tiddlywiki.files
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/8ae4428332e03a1fdaee26f777a0c3a372fff401">> ''$timestamp'' attribute ignored when using ActionSetFieldWidget to set the value of an index
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/2af632a46d74e223f99a67c6aaa5bc6931e9466e">> crash during static rendering of [[CodeMirror Plugin]]
+
+! Usability Improvements
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6015">> image picker in theme tweaks to not dismiss when an image is selected
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5998">> a [[new hidden setting|Hidden Setting: Show Edit Preview per Tiddler]] for controlling the visibility of the editor preview pane on a per-tiddler basis
+* <<.link-badge-improved "https://github.com/Jermolene/TiddlyWiki5/commit/b0f72d069086dee8506758c643f953f9ec55f403">> sidebar plugin listing to show icon and more details
+
+! Widget Improvements
+
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/commit/9caba544eb04f56ed772340a2d8767974b2617c9">> refreshing of the CodeBlockWidget
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/6145">> EditTextWidget to provide a new ''actionValue'' variable to action strings that contains the value of the input
+
+! Filter improvements
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6127">> new trigonometric operators: [[acos|acos Operator]], [[asin|asin Operator]], [[atan|atan Operator]], [[cos|cos Operator]], [[sin|sin Operator]] and [[tan|tan Operator]]
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6150">> new [[zth Operator]] that works like [[nth Operator]] but counts from zero instead of one
+* <<.link-badge-extended "https://github.com/Jermolene/TiddlyWiki5/pull/6149">> [[Map Filter Run Prefix]] to provide additional variables to the filter
+* <<.link-badge-fixed "https://github.com/Jermolene/TiddlyWiki5/pull/6164">> macro parameters in filter run prefixes
+
+! Hackability Improvements
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6130">> new ActionSetMultipleFieldsWidget, new SetMultipleVariablesWidget and extended ActionSendMessageWidget for working with multiple variables/fields/indexes/parameters in one operation
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6012/files">> new `focus-editor` operation to [[WidgetMessage: tm-edit-text-operation]]
+
+! Developer Improvements
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/6132">> support for widgets to access the order in which attributes are defined
+
+! Node.js Improvements
+
+* <<.link-badge-added "https://github.com/Jermolene/TiddlyWiki5/pull/5275">> support for recursively loading subdirectories with [[tiddlywiki.files Files]]
+
+! Translation improvements
+
+* Polish
+* Chinese
+
+! 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:
+
+* <<contributor bmann>>
+* <<contributor btheado>>
+* <<contributor BramChen>>
+* <<contributor BurningTreeC>>
+* <<contributor eiro10>>
+* <<contributor EvidentlyCube>>
+* <<contributor flibbles>>
+* <<contributor joshuafontany>>
+* <<contributor Marxsal>>
+* <<contributor pmario>>
+* <<contributor saqimtiaz>>
+* <<contributor Telumire>>
+* <<contributor tw-FRed>>
+* <<contributor twMat>>

package/editions/tw5.com/tiddlers/releasenotes/ReleaseTemplate.tid

@@ -1,3 +1,6 @@
+created: 20211117231152248
+modified: 20211119231156728
+tags: [[Release Template]]
 title: ReleaseTemplate
 
 <h2><$link to=<<currentTab>>><$view tiddler=<<currentTab>> field="title"/></$link></h2>

package/editions/tw5.com/tiddlers/releasenotes/alpha/AlphaReleases.tid

@@ -1,6 +1,6 @@
 created: 20131109105400007
-modified: 20140701201607494
-tags: Releases
+modified: 20211117225858830
+tags: Releases AlphaReleaseNotes
 title: AlphaReleases
 type: text/vnd.tiddlywiki
 

package/editions/tw5.com/tiddlers/roadmap/RoadMap.tid

@@ -1,17 +1,10 @@
 created: 20130823203800000
-modified: 20160418123722695
+modified: 2020051619421803
 tags: About
 title: RoadMap
 type: text/vnd.tiddlywiki
 
-There are still some areas of TiddlyWiki that have not been fully developed beyond the experimental stage:
+TiddlyWiki 5 is now a mature, stable project that is relied upon by many people. Simultaneously, it is rapidly evolving in many directions thanks to the broad community of developers and users. This paradoxical situation is possible because the project strictly maintains backwards compatibility, adding new features alongside the existing ones.
 
-* Multiple users with the client-server configuration
-* Smartphone user experience
-* New tiddler manager, including bulk operations like search and replace
-* Federation that can run in the browser or under Node.js
-* Improved editions
-* Improved support for third party plugin libraries
-
-Also see the issues list on GitHub: https://github.com/Jermolene/TiddlyWiki5
+There is no formal roadmap, but quite a few areas that have yet to be fully implemented, such as search and replace, and rich text editing. Current work can be found on ~GitHub at https://github.com/Jermolene/TiddlyWiki5/
 

package/editions/tw5.com/tiddlers/saving/Emergency Tiddler Export.tid

@@ -1,14 +1,14 @@
 caption: Emergency Export
+color: #7986CB
 created: 20180309211328412
 delivery: Saver
 description: Awkward but useful emergency technique for saving tiddlers
 method: save
-modified: 20180309221402430
-tags: Mac Android Windows Linux Saving Chrome Safari Firefox Opera InternetExplorer
+modified: 20200507202809334
+tags: Android Chrome Firefox [[Internet Explorer]] Linux Mac Opera Safari Saving Windows Edge
 title: Emergency Tiddler Export
 type: text/vnd.tiddlywiki
 
-
 This method is useful if, for any reason, you should find your current TiddlyWiki instance is not saving (e.g. a plugin or a server has stopped working). It should work on just about any platform.
 
 * Go to advanced search {{$:/core/ui/Buttons/advanced-search}}
@@ -21,7 +21,7 @@ This method is useful if, for any reason, you should find your current TiddlyWik
 ```
 * Check the list of tiddlers.
 * Adjust the number "25" in the filter to make sure you found  all your recently modified tiddlers
-* Press the bucket with the up arrow [<button class="tc-btn-invisible" disabled>{{$:/core/images/export-button}}</button>] which appears on the right
+* Press the bucket with the up arrow [<button class="tc-btn-invisible" disabled><<.icon $:/core/images/export-button>></button>] which appears on the right
 * A dialogue window will ask for a location to download a file called tiddler.json on your local drive, or depending on browser configuration, just alert you that such a file will be downloaded. Press save.
 * The `tiddlers.json` file can be imported (tools in sidebar) or drag and drop the file on the top line of the story river of another TW . 
 ** You can (de)select specific tiddlers. 

package/editions/tw5.com/tiddlers/saving/Encryption.tid

@@ -7,12 +7,12 @@ type: text/vnd.tiddlywiki
 When used as a single HTML file, TiddlyWiki5 allows content to be encrypted using the [[Stanford JavaScript Crypto Library]].
 
 # Switch to the ''Tools'' tab in the sidebar and look for the button with a padlock icon
-# If the button is labelled {{$:/core/images/unlocked-padlock}} ''set password'' then the current wiki is not encrypted. Clicking the button will prompt for a password that will be used to encrypt subsequent saves
-# If the button is labelled {{$:/core/images/locked-padlock}} ''clear password'' then the current wiki is already encrypted. Clicking the button will remove the password so that subsequent saves will be unencrypted
+# If the button is labelled <<.icon $:/core/images/unlocked-padlock>> ''set password'' then the current wiki is not encrypted. Clicking the button will prompt for a password that will be used to encrypt subsequent saves
+# If the button is labelled <<.icon $:/core/images/locked-padlock>> ''clear password'' then the current wiki is already encrypted. Clicking the button will remove the password so that subsequent saves will be unencrypted
 # Optionally, open the saved file in a text editor and verify that your data is encrypted
 # Open the file in your browser. You will be prompted for a password before the content is displayed
 
 Note that TiddlyWiki has two other unrelated features concerned with passwords/encryption:
 
-* The ability to set a password when saving to TiddlySpot. This is done in the "Saving" tab of ''control panel'' {{$:/core/images/options-button}}.
+* The ability to set a password when saving to TiddlySpot. This is done in the "Saving" tab of ''control panel'' <<.icon $:/core/images/options-button>>.
 * The ability to use standard HTTP basic authentication with the [[Node.js|TiddlyWiki on Node.js]] server configuration. This is done on the command line with the ServerCommand. Combined with SSL, this gives the same level of transit encryption as you'd get with online services like Google or Dropbox, but there is no encryption of data on disk

package/editions/tw5.com/tiddlers/saving/Example config-tiddlyweb-host for IIS.txt.meta

@@ -1,5 +1,5 @@
 title: Example config-tiddlyweb-host for IIS
 created: 20180328145039530
 modified: 20180328145234871
-tags: 
+tags: Saving
 type: text/plain

package/editions/tw5.com/tiddlers/saving/Example package.json for IIS.txt.meta

@@ -1,5 +1,5 @@
 created: 20180328145039530
 modified: 20180328145234871
-tags: 
+tags: Saving
 title: Example package.json for IIS
 type: text/plain

package/editions/tw5.com/tiddlers/saving/Example tiddlywiki.info for IIS.txt.meta

@@ -1,5 +1,5 @@
 created: 20180328151124878
 modified: 20180328151214616
-tags: 
+tags: Saving
 title: Example tiddlywiki.info for IIS
 type: text/plain

package/editions/tw5.com/tiddlers/saving/Example web.config for IIS.txt.meta

@@ -1,5 +1,5 @@
 created: 20180328145259455
 modified: 20180701185215523
-tags: 
+tags: Saving
 title: Example web.config for IIS
 type: text/plain

package/editions/tw5.com/tiddlers/saving/Installing TiddlyWiki on Microsoft Internet Information Server.tid

@@ -1,9 +1,10 @@
 caption: Internet Information Services
+color: #F06292
 created: 20180328120356008
 delivery: DIY
 description: Windows' built-in web server
 method: sync
-modified: 20180701185718671
+modified: 20200507105855400
 tags: Saving [[TiddlyWiki on Node.js]] Windows
 title: Installing TiddlyWiki on Microsoft Internet Information Server
 type: text/vnd.tiddlywiki

package/editions/tw5.com/tiddlers/saving/Saving on Android.tid

@@ -1,26 +1,34 @@
-caption: ~AndTidWiki
+caption: Tiddloid and Tiddloid Lite
+color: #FF8A65
+community-author: donmor
 created: 20130825161400000
 delivery: App
 description: Android app for saving changes locally to device storage
 method: save
-modified: 20171113105950965
+modified: 20200507103926292
 tags: Saving Android
 title: Saving on Android
 type: text/vnd.tiddlywiki
+url: https://github.com/donmor/Tiddloid
 
-The AndTidWiki app for Android devices makes it possible to edit and save changes to TiddlyWiki5, including working offline without a network connection. [[Download it here|https://play.google.com/store/apps/details?id=de.mgsimon.android.andtidwiki&hl=en]].
+The Tiddloid and Tiddloid Lite app are Android apps that makes it possible to edit and save changes to TiddlyWiki HTML files. 
 
-Instructions for use:
+* For more information: [[Tiddloid|https://github.com/donmor/Tiddloid]] [[Tiddloid Lite|https://github.com/donmor/TiddloidLite]].
+* Download apks: [[Tiddloid|https://github.com/donmor/Tiddloid/releases]], [[TiddloidLite|https://github.com/donmor/TiddloidLite/releases]]
 
-# [[Download]] an empty TiddlyWiki on another web browser
-# Move the file you just downloaded to the directory `/sdcard/andtidwiki`
-#* You may rename it, but be sure to keep the `.html` or `.htm` extension
-# Open AndTidWiki
-#* Don't use ''Menu''/''new ~TiddlyWiki'' menu option (it only supports the older TiddlyWikiClassic)
-# Open the file by touching its filename
-# Try creating a new tiddler using the ''new tiddler'' {{$:/core/images/new-button}} button in the sidebar. Type some content for the tiddler, and click the {{$:/core/images/done-button}} ''ok'' button
-#* The wiki will be saved, and a confirmation message should appear at the top right of the window
 
-''Note:'' You can save your changes by clicking the {{$:/core/images/save-button}} ''save changes'' button in the sidebar even if you have not clicked the {{$:/core/images/done-button}} ''ok'' button to complete editing a tiddler
+!!! Features
 
-//Note that AndTidWiki is published independently of TiddlyWiki//
+* Create new ~TiddlyWiki importing latest edition from internet
+* Import existing ~TiddlyWikis stored on device/internal storage. ([[TiddloidLite|https://github.com/donmor/TiddloidLite/releases]] supports external SD card too)
+* Fork interesting ~Tiddlywikis from internet  (Supports TW5 only)
+* TiddlyWiki detection
+* Locally stored ~Tiddlywikis are updated simultaneously on saving changes to ~TiddlyWikis imported to the app
+* Backup system that is compatible with TiddlyDesktop, the desktop TiddlyWiki saver
+* Creating shortcuts to existing ~TiddlyWiki  on Android Homepage
+* [[TiddloidLite|https://github.com/donmor/TiddloidLite/releases]] supports cloud storages like GDrive and ~OneDrive
+
+!!! Please note
+
+* Tiddloid Lite feature better support for devices running Android Q or later. It also supports cloud storages like GDrive and ~OneDrive, while Tiddloid keeps the compatibility to TiddlyWikiClassic. To know more about differences between Tiddloid and  Tiddloid Lite, please visit [[Tiddloid's homepage|https://github.com/donmor/Tiddloid]].
+* You should keep the `.html` or `.htm` extension of the files to be imported.