Release v1.4.0

1.4.0 (2024-11-10)

• Added favourites, giving users ability to switch voices quickly (useful for those that read papers in multiple languages)
• Fixed inability to pause speech on linux machines

---

• chore: fix breakages after dep updates (13c0012)
• build(deps-dev): bump zotero-plugin-scaffold from 0.0.34 to 0.1.7 (d9a5c40)
• build(deps-dev): bump zotero-types from 2.1.1 to 3.0.1 (95b3b44)
• build(deps): bump zotero-plugin-toolkit from 3.0.0 to 4.0.7 (d53545f)
• chore: various small changes in WSA (f8e5786)
• fix: fix speaking on linux when queue new items behaviour is enabled (338436a)
• fix: fix cancelling on linux (ac391e8)
• feat: fully implement pausing on linux (6207c8b)
• wip: begin implementing pause fix on linux (6e19a6c)
• fix: improve WSA init stability (d1bee43)
• chore: import cleanup (79f6b59)
• feat: implement cycling shortcuts (59b71a2)
• feat: add shortcuts for cycling fav to prefs pane (d48cb49)
• fix: refresh faves list on first load (5417ad6)
• ui: prettify favourites list (793ff67)
• fix: fix remove favourite removing everything (d90dfa4)
• feat: implement removing favourites from prefs (c4e5705)
• refactor: refactor refreshing faves list into separate function (293690e)
• fix: change approach to refreshing faves list (f4410d6)
• feat: implement adding favourites from prefs (cfe699b)
• ui: add pref pane elements for favourites (1cd1eb4)
• feat: add cycle favourites to hooks (ce8985b)
• feat: add favourites to prefs.js (a8daa52)
• feat: add functionality to favourites.ts (0af434f)
• wip: add skeletons for favourites.ts functions (06c4b28)
• chore: comments and formatting (c207df6)
• chore: comments and formatting (f653a79)
• fix: remove repeated whitespace chars in preprocessing (c6324ec)
• docs: update bug_report.yml (fa7539f)
• docs: update CONTRIBUTING.md (bad9538)
• docs: update README.md (d5a6707)
• docs: update ROADMAP.md and CHANGELOG.md (92e5f0c)

Release v1.3.0

1.3.0 (2024-09-08)

• Added the ability to read the full text of a paper (done when no annotations and no text are selected)
• Added the ability to specify substitutions for the text to be spoken in the preferences (can be either a raw string or a regex pattern)
• Added status reporting, including better error reporting for WSA
• Added voice list sorting for readability (thanks to contributor @flightmansam !)

---

• chore: assorted clean up (1ca8c5b)
• chore: cleanup imports (3d0b459)
• chore: localisation file formatting (3d7a125)
• chore(publish): release v1.3.0 (37e4077)
• fix: allow subs to load prefs values before setting overall checkbox (7561976)
• fix: fix subs validation regex capturing quote mark (30fcfef)
• fix: locale should load all .ftl files (89d83ef)
• fix: slight regex optimisation (ebeabe4)
• feat: add hooks logic for built-in substitutions (2e0ee18)
• feat: add localisation for built-in substitutions (85c088b)
• feat: add localisation for status reporting (352dca5)
• feat: add prefs for built-in subs (922be75)
• feat: add substitutions hooks for prefs (ccf2041)
• feat: add substitutions section of localisation (9753e22)
• feat: add tts engine error reporting to popup (1db46fd)
• feat: add tts loading error reporting to localisation (41e8022)
• feat: add tts loading error reporting to WSA engine init (a281294)
• feat: add ZoTTS reporting ready status (81b4f5f)
• feat: implement built in subs into preprocessing (68c930a)
• feat: implement getFullText to retrieve ful text of a paper (4446065)
• feat: implement speaking full text of paper (e0c8b7a), closes #88
• feat: implement user defined substitutions in preprocessing (d149e59)
• feat: unicode normalise text within ZoTTS itself (f9859a2)
• refactor: add prefs hook type testing (0d3ad03)
• refactor: allow popups to push multiple lines of text in status reporting (d34c86d)
• refactor: move prefs load hooks to prefsWindow.ts (91dc530)
• refactor: move tts hooks to dedicated file (ac75314)
• refactor: refactor prefs hooks organisation (9068bf7)
• refactor: split checkAndReportStatus into two functions (874b0e8)
• ui: add prefs pane elements for built-in substitutions (361133c)
• ui: add some pref pane touch ups (bcc075c)
• ui: add substitutions section of prefs (8c24ce3)
• docs: update CHANGELOG.md with v1.2.1 (b9d3385)
• docs: update README.md (e65384b)
• Sort voice list (1dee683)
• wip: add skeleton for preprocessing changes (798ad16)

Release v1.2.1

1.2.1 (2024-08-24)

• Fixes a bug where selected text with diacritics might not be spoken correctly
• Lots of documentation changes, should make knowing the state of development and reporting issues much easier.

---

• chore(publish): release v1.2.1 (01feb3e)
• fix: fix code that would alter selected text in reader (ee99054)
• fix: implement fixed getSelectedText in reader (b3607a7), closes #87
• refactor: move getSelectedAnnos to readerUtils.ts (9c2da6e)
• refactor: move getSelectedText to readerUtils.ts (53cd58c)
• refactor: rearrange onContextualSpeak for readability (4068b30)
• docs: add CHANGELOG.md (5ac1ccf)
• docs: add release dates to CHANGELOG.md (839b19d)
• docs: add ROADMAP.md (2cbb0ea)
• docs: fix feature_request.yml (921f89e)
• docs: fix feature_request.yml again (044cb97)
• docs: fix feature_request.yml again again (6eea52f)
• docs: update .github, add bug report template (ca47619)
• docs: update .GitHub, add feature request template (54dcb5c)
• docs: update bug_report.yml, actual and expected behaviour now required (8f369fa)
• Update README.md (d660a00)

Release v1.2.0

1.2.0 (2024-08-17)

This version should bring some much-needed stability to Linux and Mac users (sorry for the issues, and thanks to those who worked with me to investigate it!), as always, let me know if you run into any issues by opening an issue.

---

• chore: comment out logging test lines (dd61756)
• chore: linting (0aa5b9a)
• chore: remove old WSA init (4ca7d96)
• chore(publish): release v1.2.0 (dfb99be)
• feat: add checkAndReportStatus check throughout hooks.ts (6fcfaf4)
• feat: add initEngine to webSpeech.ts, call in src/modules/tts/index.ts (a6b9e1c)
• feat: add retryUntilAsync to wait.ts (61cb576)
• feat: add status field to engines and tts overall (9f3753d)
• feat: add TTS status reporting with popups (1e03397)
• feat: add ttsEngines.reloadTries to prefs, use in webSpeech.ts (ec16cc8)
• refactor: always initLocale and setDefaultPrefs, regardless of TTS init (a8f21da)
• refactor: begin Promise-ifying engine inits (d3d0c98)
• refactor: move around registering funcs in hooks.ts, condition on successful init (1713ee1)
• refactor: move initEngines to onStartup (c25b707)
• refactor: rearrange webSpeech.ts slightly (f468ab1)
• fix: make initEngines async (0da5de3)
• fix: return status good/bad for other usage (6c71d61)
• build(deps-dev): bump zotero-plugin-scaffold from 0.0.33 to 0.0.34 (290decf)
• build(deps-dev): bump zotero-types from 2.0.3 to 2.1.1 (539054f)
• build(deps): bump zotero-plugin-toolkit from 2.3.37 to 3.0.0 (1804fc7)
• docs: update README.md, add note about slow Mac/Linux loads (2ace45d)

Release v1.1.1

1.1.1 (2024-07-27)

• chore(publish): release v1.1.1 (5a65437)
• refactor: move WSA voice list populating to extras in webSpeech.ts (8b3e5f1)
• feat: add better voices loading in case of delay/error (c89e72f), related #74
• feat: add wait utils to handle async behaviour (228006a)
• fix: make WSA engine do empty speak on window load to ensure init (5f67fce), related #74

Release v1.1.0

1.1.0 (2024-07-24)

• chore: remove old files (939f3e7)
• chore(publish): release v1.1.0 (cde5c3a)
• docs: add right click items to feature list in README.md (9dd462e)
• docs: fix CONTRIBUTING.md pointing to wrong repo (3fa4afe)
• docs: update CONTRIBUTING.md about translations (db9eaf2)
• build: update package-lock.json (368702a)
• feat: add localisation to main window items (efecc70)
• feat: add localisation to preferences pane (2bca9f7)
• feat: update locale logic (ec9b819)
• refactor: move "test voice" sentence to localisation files (6b31db9)

Release v1.0.1

1.0.1 (2024-07-20)

• chore(publish): release v1.0.1 (db9fd8e)
• build(dev-deps): bump zotero-plugin-scaffold from 0.0.32 to 0.0.33 (834e899)

Release v1.0.0

1.0.0 (2024-07-20)

• chore: lots of little chores (a289fb3)
• chore: add future TODOs about changes needed when engine changes (7a06f63)
• chore: comment out custom toolkit code, add TODO (754c8e4)
• chore: comment out os command line tts engines (8d995a8)
• chore: experiments with zotero and toolkit (f0db25f)
• chore: lots of little bits of cleanup/formatting/etc (6e42506)
• chore: missing semi colon (69741f7)
• chore: remove old example code (e4267cb)
• chore: remove say.js mentions (df25324)
• chore: update .gitignore (47b74b0)
• chore: update package-lock.json (6c974fb)
• chore: use global zToolkit (95632bd)
• chore(publish): release v1.0.0 (4fb8673)
• docs: add contribution guide in CONTRIBUTING.md (dc32fb8)
• docs: add contribution guide in CONTRIBUTING.md (d68a970)
• docs: add git repo links to package.json (01168a9)
• docs: fix README.md (9cc73a9)
• docs: update README roadmap (60e4c12)
• docs: update README roadmap (0553a60)
• docs: update README roadmap (4288bb2)
• docs: update README.md (cacd9d9)
• docs: update README.md for release (90d7c8c)
• docs: update README.md roadmap (56d28dd)
• docs: update README.md roadmap (af0fd82)
• ui: add icons to library menu (7d0a915)
• ui: adjust icons just slightly (1862af4)
• ui: refresh prefs pane (80bd3a6)
• fix: add forgotten pause icon SVG for reader tab UI (1b1f73e)
• fix: add resume() and make pause() public in ttsBase.ts (c6a9077)
• fix: call onSpeakOrResume not onContextualSpeak when using shortcut speak (a1d5b09)
• fix: display modifiers text on keyboard shortcuts (4893ca5)
• fix: enforce lowercase consistency when shortcut checking (d6f3eca)
• fix: fix onContextualSpeak when called from UI elements (7f9cb9a)
• fix: fix several return types from null to void in Base (18bc186)
• fix: fix UI elements not being in a row (306eeba)
• fix: make swap shortcut prefs string based (05328bf)
• fix: multiply v/r/p prefs up by 100 (3a46405)
• fix: prefs.js, fix prefix and use actual setting names in prod mode (6a02a18)
• fix: standardise pref names between prefs.js and prefUtils.ts (9caa62f)
• fix: UI play should call onSpeakOrResume, onSpeakOrResume should call onContextualSpeak (1e72bc4)
• fix: use ctrl+shift+key instead of ctrl+key for shortcuts (5f5b80b)
• feat: add "read abstract" to menu list (a56dee2)
• feat: add "Speak Selection" to text selection popup in reader (932ffec)
• feat: add a nice little Test Voice button in case it's useful (a494d1e)
• feat: add ability to choose queue or cancel new items (bce5134)
• feat: add ability to modify speak shortcut behaviour with shift (92f57dc)
• feat: add cancel button on reader tabs (0661564)
• feat: add cancel, pause, resume to WSA engine (6ec99ee)
• feat: add check for pause and resume when instantiate tts (6a97bf7)
• feat: add default prefs and checking code (f4364a9)
• feat: add engine name for readability (dbb973f)
• feat: add funcs for adding/removing notifiers (280d409)
• feat: add onMainWindowLoad hook (afa621d)
• feat: add onSpeakOrResume hook (7c4e1f1)
• feat: add other hooks using new functional style (6490a4c)
• feat: add pause and cancel shortcuts (44de893)
• feat: add pause button on reader tabs (4ca9a13)
• feat: add play button on reader tabs (49b4666)
• feat: add prefs loading functions (db443ca)
• feat: add skeleton files for major parts of project (c5efd82)
• feat: add state tracking for WSA (5b612ed)
• feat: add ttsSay.ts for speech synth through command line (9dca09e)
• feat: add ttsWebSpeech.ts for speech synth through WebSpeech API (e4b10b5)
• feat: add ui elements array for later visual updates (759ec21)
• feat: add voice selection for WSA (67e689e)
• feat: add volume, rate and pitch prefs pane for WSA (14840ef)
• feat: add waiting helpers (8fefe93)
• feat: add webspeech field to addon (28572e0)
• feat: allow tts engines to expose extras (bc64f3a)
• feat: began adding html elements (941a692)
• feat: began implementing ZoTTS class (9f61de8)
• feat: begin move towards having one class manage tts engines (7c372dd)
• feat: bring webspeech in line with revised engine base (06ff528)
• feat: finish implementing contextual speak for library tab (9384b9f)
• feat: finish implementing contextual speak for reader tab (ac9e046)
• feat: implement annotation speaking UI (308fa25)
• feat: implement TTS base class (330df70)
• feat: overhaul tts engine typing and organisation (f58cdf8)
• feat: partial add speak title from items list (5c59e97)
• feat: switch to non-placeholder icons, use svg rather than png (8fe7945)
• feat: update l10n code to better version from newer template (207b87d)
• feat: update WSA speak to use settings in prefs (e2ec163)
• wip: begin adding contextual speak hook for ui elements/shortcuts ([8b50cbd](https://github.com/ImperialSq...

Release Manifest

This release is used to host update.json, please do not delete or modify it!
Updated in UTC 2024-11-10T18:40:06.824Z for version 1.4.0