Release 2.10.1

[YakovL]

This PR is created to encourage the release of 2.10.1. It may still recieve some minor updates and fixes.

Todos to complete the release:

• [x] test, publish beta for testing → thread
  • [x] retest #147, close it and #148
• [x] optionally, review the upgrading flow
• [x] gather changelog (group commits like in previous release PRs) → comment below
  • [x] point out lingo changes, backward compatibility/deprecation details
  • [x] optionally illustrate UI changes (in a separate comment, for easier navigation; example, with arrows) → comment below
  • [x] describe lingo changes in history for translations → 3d41429
  • [x] optionally gather dev docs updates → none this time
  • [x] prepare updates of [[WhatsNew]] and related tiddlers (site), may be [[GettingStarted]] → bb20321
• [x] bump version (Version.js, package.json, package-lock.json), tag commit → 11da507, e035e53
  • [x] test and update the helper script → now works for Version.js, package.json; not committed yet
• [x] merge
• [x] create GH release (text based on [[WhatsNew]]), build, attach built files (example) → 2.10.1
• [x] update site
  • [x] try update-site-new-release for that (the submodule problem is supposed to be fixed) → nope, still there, but on another step
  • [x] fix: npm run build-external-core fails after jQuery moved to node_modules → #302
  • [x] fix: build tiddlywiki_externaljs.html and js files, move, stage step of the Action should also use git add *.* instead of git add * → c8ed9c6, remove the submodule → 6d4ef70, retest updating → no problem now!
  • [x] remove [[favicon.ico]] (see #300), test that the real favicon is not affected
  • [x] check if the current workflow fails to update Markup blocks, the title, etc (see #300)
  • [x] restore the blocks manually for now
  • [x] check that the site works as expected, the changes are there
• [x] debug: permalink url in context menu is incorrect (no hash) on both the site and the downloaded empty TW → fixed in 05fe9af (only updated the hash when the current url had some hash); won't update the site and GH release, will include the fix into the next release
• [x] announce in GG (mention HowToUpgrade for upgrading from below 2.10.0) → thread
  • [x] prepare summary + related changes (other plugins, savers, etc) for announcements
  • [x] announce in Telegram → post

Todos after the release:

• [x] update MTS to support 2.10.1, update the site accordingly
• [x] create a survey on ToolbarCommands defaults → link
  • [x] publish → thread
• [x] review todos from #294, move those not done yet here
• [x] update translation template, add an update example to the history for translations → 1292aaa, 20e7928
  • [x] optionally, update ru translation → 2.10.0, 2.10.1
• [x] add the new native saver as a plugin add to the savers list → 85c9633
  • [ ] minimize limitations (see GG), including supporting callback by saveFile (by mozillaSaveFile, ieSaveFile, and may be javaSaveFile)
  • [ ] consider adding it or its parts to the core
• [ ] document new tw.options for plugin developers
• [x] propose updating at Tiddlyhost (see update to 2.9.3 or to 2.9.4) → already done by Simon
  • [x] propose changes to use core updateOriginal in ThostUploadPlugin → merged
  • [ ] propose that ThostUploadPlugin overwrites saveChanges instead of adding a new macro (and may be add download macro), etc (also see new methods of 2.10.0, yllab.tiddlyhost.com)
• [ ] create release and suggestion PR templates in .github/PULL_REQUEST_TEMPLATE/ (see also using templates). suggestion should be to dev; release should have the checklist like above
• [ ] sort out old todos, distinguish most improtant ones (may be pack some of them into issues; see also existing ones):
  • [ ] update the Releasing and updating the site (explain in more details steps from here, automate where possible); automate where possible (ideally: CD on merge into master/main)
  • [ ] create a template of the checklist for "release PRs", mention in the corresponding step
  • [ ] try to modify the current workflow (probably using Puppeteer/Playwright*) to
    • [ ] update Markup blocks, the title, etc (see #300)
    • [ ] restore RSS generation (fails, is catched that))
    • [ ] get ~formatting consistency (see diff)
  • [ ] automate version bumping: support package-lock, commit the bump-version script, mention
  • [ ] automate changelog gathering
  • [ ] prepare and release Timimi saving fixer as a plugin, announce
  • [ ] move it to the core to make core upgrading work (without SUpP or downloading and importing – make callback work) ..or create a node.js analogue of Timimi
  • [ ] make core upgrading work in MTS (without SUpP [..] – support saving and loading the backups, version range issues)
  • [ ] reuse the close icon in SimpleSearchPlugin, may be in the backstage and other UIs
  • [ ] ideally, update TWs in TiddlyThemes, VisualTW, and may be other repos
  • [ ] ideally, create a script (Github Action?) to upgrade a TW in GH quickly as now it's rather an annoying procedure
  • [ ] once the fix of TW5 as a build tool issue (inception, current workaround) is merged and a new version of TW5 is released, retest and update package.json
  • [ ] introduce auto checking updates availability (disabled by default) – move from SUpP to the core
  • [ ] introduce upgrade/meta.json to reduce traffic
  • [ ] introduce upgrade/changelog.json, (optional) showing it before upgrading, autogeneration from commits/manual flow
  • [ ] discover which bits of ResponsiveThemePlugin can be added to the core; introduce contemporary core theme (not default styles update, but a theme as a tiddler/shadow inside the TW core)
  • [ ] migrate tests to Jest (already create a proof-of-concept approach), add autotests to CI
  • [ ] introduce Husky and/or GH actions to check commit prefixes; linting (lint-staged)
  • [ ] deal with the "security" issues reported by github (those are in fact issues of build tools and not TW itself)
  • [ ] consider adding the fixes for the dev space to the core
• issues counter as per 22.02.2024: 15; PRs: 2

[YakovL]

Full changelog for further summarizing:

• features:
  • default options (don't store default values in cookies)
  • 1a4f384 feature: introduce tw.options with .define and .hasDefaultValue, prevent saving default values, set core defaults
  • 00b1fce revert: don't skip default values in SystemSettings (hurts transparency and stored toggling)
  • make context menu work for permalink buttons (to copy url/open in a new tab/...) – add href to them (8ca5c18)
• fixes:
  • saving backup (and RSS and empty template) broken in 2.10.0
  • b6d56b1 feature: recalc posDiv from original in saveEmpty, if it was not passed, deal with falsy original/posDiv
  • 797225d feature: introduce tw.io.getOriginalLocalPath, use where necessary plus in postSave
  • 04b6969 feature: make sure saveMain calls callback (if defined) and passes original
  • d21d5fd fix: postSave shouldn't fail because of using undefined variables
• ui:
  • colors of inputs are now based on ColorPalette (Background, Foreground)
  • e6c6c36 set colors of inputs based on ColorPalette (#298)
  • 1a10dca fix: prevent some browsers (including Chrome) to increase border-width when setting background color
  • update ugrade wizard to look better (on mobile devices in the first place, when using with a proper viewport tag)
  • a31e612 make borders of wizard buttons symmetric
  • d278c74 don't show the https:// bit of the upgrade url in the upgrade wizard
  • 887fb13 use symmetrical margin for backstage panels, avoid overflow
  • 2b21dbd simplify wording in upgrade wizard (+ shorten the title)
  • make GettingStarted shadow clearer and more instructive, link docs about savers (e0d20ec)
  • substitute solid background of tagging, tags with thicker border (0c9f7ab)
  • prevent multiword tab labels from getting multiline (aebbeda)
• docs:
  • 6b14fbc add a link explaining plugin installation to [[Translations]]
  • def0f25 fix missing style for stores' icons (Setting up saving)
  • 6ff625d add main steps of releasing, a reference to 2.10.0 release PR
  • 33f95bb remove mention of the Wii browser (that is long gone)
  • e0d20ec make GettingStarted shadow clearer and more instructive, link docs about savers
  • d19da7b remove broken TiddlySpace icon, replace Tiddlyspot with Tiddlyhost (#296)
• infra:
  • f55134c use jQuery from node_modules, control version from package.json, use 1.9.1 (was 1.8.3)
  • a3bd6ec remove autotests of a deprecated module (Crypto) duplicating those of direct usage (Encoding)
• codestyle, refactoring:
  • e197d1c lint test/js/Options.js
• lingo:
  • 2b21dbd upgrade wizard (config.tasks.upgrade, config.macros.upgrade.wizardTitle, .step1Title)
  • e0d20ec GettingStarted shadow

Acknowledgements for contributions: to @PengjuYan (#298), @simonbaird (#296)

[YakovL]

UI changes illustrations

backstage (with <meta name="viewport" content="width=device-width, initial-scale=1" />; may differ depending on the device width):

GettingStarted:

Tags & tagging: