v2.10.1: default options, fix of saving backups, UI updates, a more instructive GettingStarted, context menu support in permalink buttons, and more

Changes summary:

• Behavior improvements:
  • Default option values are no longer stored in cookies;
  • Permalink buttons now support context menus (to copy url/open in a new tab/...).
• UI updates (see the visual summary):
  • Colors of inputs are now based on ColorPalette (Background, Foreground);
  • Upgrade wizard now looks better (on mobile devices in the first place, when using with a proper viewport tag):
    • Symmetrical margin for backstage panels (avoid viewport overflow);
    • Shorter and clearer title and subtitle;
    • The upgrade url is now shown without the https:// bit;
    • Borders of wizard buttons are now symmetric (and look better in the dark mode);
  • GettingStarted shadow is now clearer and more instructive, has a link to quickly find custom savers;
  • Tagging, tags blocks now use thick borders instead of solid background color;
  • Preventing multiword tab labels from getting multiline in some cases.
• Fixes:
  • Native backups saving broken in 2.10.0 works again.
• Hackability:
  • tw.options.define(name, defaultValue, description) is now available for plugins;
  • tw.io.getOriginalLocalPath is now available to use and decorate (used in the core);
  • saveMain always passes original to the callback;
  • saveEmpty can be called without posDiv (recalcs if it's not passed) and handles problematic original.
• Infrastructure:
  • jQuery is now a dependency defined by package.json (forced updating 1.8.3 → 1.9.1);
  • removed autotests of a deprecated module (Crypto) duplicating those of direct usage (Encoding).
• Lingo updates (for translations)
• Docs updates include added steps of releasing, replacing Tiddlyspot with Tiddlyhost, minor links and styles updates, removing mentions of the (long gone) Wii browser, and the update of the ~GettingStarted shadow mentioned above.

Acknowledgements for contributions: to @PengjuYan , @simonbaird .

See the full changelog in #299

v2.10.0: fully async saving, safe upgrading, reusable icon(s), UI updates (including tabs), fixes, and more

Changes summary:

• Behavior improvements:
  • Upgrading wizard is now more instructive and prevents losing content when trying to upgrade with some savers;
  • <<version>> now also shows the number of a "nightly" build.
• UI updates (see visual summary below the changelog):
  • Tabs now use common background (instead of gray), don't "sink" into the content and are not broken into 2 lines;
  • Remove an excessive link in GettingStarted;
  • Search button now looks the same as other buttons in the sidebar;
  • Nice toggle backstage button's padding;
  • Wizard status now supports html (links) and looks nicely when multiline;
  • Added bottom padding to tiddlers.
• Fixes:
  • Make Array.prototype.find fall back to the native implementation if a predicate is provided;
  • Story.prototype.setTiddlerField failed for tags (affected IntelliTaggerPlugin);
  • Checkboxes in the Disabled column of <<plugins>> should show correct state;
  • Don't overwrite Array.prototype.indexOf if it's defined.
• Hackability:
  • Introduces fully async saving (disabled by default: unset chkPreventAsyncSaving to enable):
    • new general method tw.io.saveFile (use it over the global saveFile), similar to tw.io.loadFile;
    • saveMain now supports callback (tries async saving if it is passed and chkPreventAsyncSaving is unset);
    • new method tw.io.saveMainAndReport separates the whole "load original, update, and save" thing, so may be a better target of decorating/overriding than saveChanges in some plugins/savers.
  • Icons (the close icon) are now stored in tw.assets.icons and are reusable.
• Deprecated: Array's .setItem, Java IO (only javaSaveFile and javaLoadFile are left, returning null).
• Infrastructure:
  • updates of some autotests, removed legacy reporter;
  • fix: freeze TW5 version used for building (versions 5.2.2 and above break things) in package.json.
• Lingo updates (for translations)
• Docs:
  • repairing links in [[Examples]] and [[TutorialsAndGuides]] and adding the Volvo page and Dutch usermanual there;
  • more compact and accurate [[Setting up saving]] and related tiddlers ([[Advanced download options]], details for some browsers);
  • up-to-date instructions for updating (both inside TW and in [[HowToUpgrade]]);
  • rewrite of [[slider macro]], mentions of plugins introducing additional filters;
  • updates of [[HelloThere]] and [[TiddlyWiki5]];
  • various minor updates, including site plugins.
• Dev docs:
  • several new articles about using git and GitHub and contributing;
  • new 'Releasing and updating the site' section in the build readme;
  • clean up of DeveloperDocumentation, updating links, and also various updates of the dev space for its further editing.

Acknowledgements for contributions: to Okido, Mark.

See the full changelog here: #294

v2.9.4: cleaner tables and popups, async loading, better hackability of saving and upgrading, more UI updates and fixes, big codestyle update, and more

Changes summary:

• features, hackability:
  • added async loading into saving (disabled by default: unset chkPreventAsyncSaving to enable)
    • this is the first stage of implementing fully async saving (however, most savers will have to support it separately)
    • extended loadFile, loadOriginal to support async loading (and introduced tw.io.xhrLoadFile, tw.io.loadFile)
    • reportedly, it even improves performance of saving in some cases
  • added async loading into upgrading, stage 2 (upgradeFrom)
  • hackability: extracted end of saving main (messages of success/failure) into tw.io.onSaveMainFail and tw.io.onSaveMainSuccess
    • warning: savers like Timimi (async ones that don't support "callbacks") call these before saving and give false positive behavior (as it was previously)
  • hackability: turned onStartUpgrade into a config.macros.upgrade method
• UI: see here (mostly tables and popups; also reduced page header)
• fixes:
  • saving a tiddler from story when renaming to an existing one shouldn't result in 2 tiddlers (#146)
  • store.saveTiddler should rename tiddler when newTitle is provided
  • store.saveTiddler should allow falsy newTitle (meaning "don't update")
  • upgrading should start correctly (was broken in 2.9.3)
• infra:
  • fix: make build tools work when project path has spaces
  • more linter rules, including for tests and building scripts
  • clean up some duplicated/unused autotests
• docs:
  • added [[Filters]]
  • updated [[PeriodicTable]] showcase and [[Tables Formatting]] examples
  • updated PHP server recommendation for Android 10 and later
  • added DarkModePlugin
  • in build readme, added link to site GitHub Workflows
• codestyle, refactoring: finished the first wave of codestyle updating: added some eslint rules, npm run lint shows no errors, but linting rules themselves are not finished. Some code bits are now considerably more readable and easier to understand.

Here you can find changes that affect lingo (translations), backward compatibility (tiny details, presumably of no importance), and deprecations (String.prototype.right, String.prototype.unDash, String.prototype.getChunkRange, String.prototype.replaceChunk, String.prototype.getChunk; more to come).

see full changelog here: #284 (comment)

v2.9.3: better navigation, styles, fixes, new build tools and linter, SuggestChangesPlugin in docs and more

This release is created mainly to start releasing again and then accelerate the release cycle. Changes summary:

• behavior:
  • add href to prettyLinks to enable open in new tab and context menu (6a76b7b)
  • fix ctrl+tab inserting tabs instead of browser tabs switch when chkInsertTabs is enabled (8fa859a)
• appearence:
  • increase line height in editor (improve readability, 751d28d)
  • code blocks: remove border, margin-left, fix code font size (f86eb3f, b8c0503)
  • annotations: remove borders, adjust paddings, margins (7a9b4e1)
  • messageArea: remove border, add shadow, fix close message icon positioning for IE (c90334c, 47cba64)
  • tagged/tagging blocks on tiddler hover: hide borders (8669dab)
  • popups: improve paddings, remove border, add shadow (49e13fc, 9cdf984)
  • fix paddings in tags chooser when there are no tags to display (c7b1d36)
  • add sans-serif fallback to the main font (17c962c)
  • update "saved snapshot" error message with a more helpful link (97957e9)
  • make annotation of SystemSettings more helpful (89833e5)
• fixes:
  • fix version detection for the next release (bfec8c0)
  • revert of messageArea class and .messageArea selectors in CSS to restore backward compability (5526c1a, cadbde3)
• infrastructure:
  • introduce SuggestChangesPlugin, adapt docs for easier contributing to docs (3ad38b5)
  • introduce CD for quick and easy updating the site
  • introduce build tools (run with npm) and docs into the main repository (3f0bb63)
  • introduce commit prefixes (docs:, codestyle:, refactor:, fix:, infra:, feature:; the list should be added somewhere in docs and ideally some watcher ..like Husky? should prevent to commit otherwise)
  • introduce usage of the dev branch: all the current changes and PRs should go to it, master is for releases only (ideally, this should be facilitated too)
  • update recipes and their folder structure (moved main from root to recipes/ in e8b57af, old unused ones – to archive in 0540214)
  • fix tests: typo in test/js/Version.js; fix encoding conversion, paths in Windows in loading/saving (34cc197, b9c0d03)
  • introduce linter and first codestyle rules (f9da92c, 2815383, ..)
• many codestyle and refactoring updates
• multiple docs improvements (special thanks to Mark Kerrigan for multiple inputs and also congratulations to Reto Stauss for his first commits)

see full changelog here: #274 (comment)

v2.9.2: fixing encoding, upgrading, improving styles and more

This release's main goal was to fix the upgrading engine which entailed researching and refactoring the whole bunch of encoding convertion methods. The full list of changes:

• fixed upgrading TW in FireFox when using TiddlyFox + fixed various potential issues with encodings (refactored en/decoding)
• fixed download-saving of TWs with non-ASCII chars in Chrome, Chromium-based browsers and Safari
  • retested and closed #136
• fixed file loading of empty files
• fixed saving in IE 11 (but not browser detection for IE 11 yet)
• fixed upgrade fail when updated TW's URL contains hash and made upgrading preserve initial query and hash in URL
• updated URL to load the new core when upgrading (now points to classic.tiddlywiki.com/upgrade/), introduced txtUpgradeCoreURI option to upgrade from another source (like a locally downloaded TW)
  • to do: make it appear in the options panel when not set yet (or in the upgrade wizard directly)
• added escaping to ' and " in macro params: now
  param1:'let\'s use "single quote"' param2:"let's use \"double quote\"" will result in param values
  let's use "single quote" and let's use "double quote" while previously one could only get
  let\'s use "single quote" and let's use \"double quote\" in labels etc
• improved styles (see screenshots there), including:
  • removed excessive borders and improved paddings in backstage/wizards
  • substituted the "close" text on the button in message widget with a cross icon, added an automatical fallback to text for old FireFox (and some others)
  • shortened mainSaved message from "Main TiddlyWiki file saved" to "TiddlyWiki saved"
• internal: did some refactoring/codestyle improvements
  • started introducing BEM into html and CSS (without removing old ids to keep backward compability with old themes). messageArea block refactoring is finished (although .messageArea__text a selector can't be converted into BEM). Naming convention: blockName, blockName__elementName, blockName_modifierName, blockName_modifierName-modifierValue, the latter is not used yet
  • codestyle improvements are still rather spontaneous; to do: introduce Prettier and start adding linting rules

For discussion, use the thread in the Google group and don't forget to create issues if there's any.

v2.9.1

See details in the TiddlyWikiClassic group thread: https://groups.google.com/forum/#!topic/tiddlywikiclassic/4xiDlSbiY9c