Readalongs

What's Changed

v1.2.0 introduced a breaking change. This version allows both use-assets-folder and image-assets-folder to be used.

* fix: re-enable deprecated useAssetsFolder by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/253


**Full Changelog**: https://github.com/ReadAlongs/Web-Component/compare/v1.2.0...v1.2.1

What's Changed

BREAKING CHANGES

* use-assets-folder (Boolean) has been replaced by image-assets-folder (string). by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/243

New Features
* feat: auto-pause at the of each page. by deltork in https://github.com/ReadAlongs/Web-Component/pull/246
* feat: add web bundle as download option by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/241
* feat: increase the text file size limits by joanise in https://github.com/ReadAlongs/Web-Component/pull/233

Minor changes
* Changes by create-pull-request action by github-actions in https://github.com/ReadAlongs/Web-Component/pull/230
* build(deps): bump axios from 1.3.4 to 1.6.1 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/232
* build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.4 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/234
* docs: add citation by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/235
* build(deps-dev): bump ip from 2.0.0 to 2.0.1 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/236
* ci: bump actions to the supported node 20 versions by joanise in https://github.com/ReadAlongs/Web-Component/pull/237
* ci: bump production node version to 18 since 16 is eol by joanise in https://github.com/ReadAlongs/Web-Component/pull/238
* build(deps-dev): bump follow-redirects from 1.15.4 to 1.15.6 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/242
* build(deps-dev): bump webpack-dev-middleware from 5.3.3 to 5.3.4 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/245

**Full Changelog**: https://github.com/ReadAlongs/Web-Component/compare/v1.1.1...v1.2.0

[1.1.1](https://github.com/ReadAlongs/Web-Component/compare/v1.1.0...v1.1.1) (2023-10-23)


Documentation

* update the npm publish instructions to refer to release.yml ([2c30289](https://github.com/ReadAlongs/Web-Component/commit/2c3028950194ff238a83764c803e3baed84880af))


Build Systems

* **deps-dev:** bump babel/traverse from 7.21.3 to 7.23.2 ([226](https://github.com/ReadAlongs/Web-Component/issues/226)) ([25557fa](https://github.com/ReadAlongs/Web-Component/commit/25557fae38317795e1ca42e5def598dc0579217d))

What's Changed
* feat(es): add spanish thanks to Jorge Rosés Labrada by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/192
* ci: bump gh pages action to use node 16 by joanise in https://github.com/ReadAlongs/Web-Component/pull/194
* Fix release workflow by joanise in https://github.com/ReadAlongs/Web-Component/pull/195
* Web-Component read strings from i18n/messages.*.json by joanise in https://github.com/ReadAlongs/Web-Component/pull/196
* feat(fonts): use bc sans by default by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/197
* misc small improvements by joanise in https://github.com/ReadAlongs/Web-Component/pull/198
* build(deps-dev): bump webpack from 5.75.0 to 5.76.0 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/199
* fix(deps): bump angular to 15.2.4 and update all dependencies possible by joanise in https://github.com/ReadAlongs/Web-Component/pull/202
* build(deps): bump engine.io from 6.4.1 to 6.4.2 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/204
* fix: handle g2p errors with the updated g2p handling in web_api by joanise in https://github.com/ReadAlongs/Web-Component/pull/205
* build(deps): bump socket.io-parser from 4.2.2 to 4.2.3 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/206
* feat: add aligner fallback settings for difficult alignments by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/207
* clean up package.json and project.json for studio-web by joanise in https://github.com/ReadAlongs/Web-Component/pull/208
* docs: it is better to use "npx nx" than "npm install -g nx" by joanise in https://github.com/ReadAlongs/Web-Component/pull/210
* feat: simplify language selection by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/209
* Dev.fix by roedoejet in https://github.com/ReadAlongs/Web-Component/pull/212
* Close the microphone stream when done recording (fixes 213) by dhdaines in https://github.com/ReadAlongs/Web-Component/pull/214
* Limit height of image to page height by dhdaines in https://github.com/ReadAlongs/Web-Component/pull/217
* fix: use relative URLs for all assets by joanise in https://github.com/ReadAlongs/Web-Component/pull/219
* Three small changes: play/pause tooltip, mat icon typo, aria recommendation by joanise in https://github.com/ReadAlongs/Web-Component/pull/220
* build(deps-dev): bump word-wrap from 1.2.3 to 1.2.4 by dependabot in https://github.com/ReadAlongs/Web-Component/pull/221
* fix: upgrade cypress to fix several CVEs by joanise in https://github.com/ReadAlongs/Web-Component/pull/222
* feat: allow embedded ReadAlong in <read-along> element by dhdaines in https://github.com/ReadAlongs/Web-Component/pull/203
* chore: bump ngx version though not strictly necessary by dhdaines in https://github.com/ReadAlongs/Web-Component/pull/223


**Full Changelog**: https://github.com/ReadAlongs/Web-Component/compare/v1.0.2...v1.1.0

[1.0.20230228](https://github.com/ReadAlongs/Studio/compare/v1.0.20230224...v1.0.20230228) (2023-02-28)


Features

* report empty g2p for a word as a warning ([b89de62](https://github.com/ReadAlongs/Studio/commit/b89de62622468178b0d51d2dad5cf73cb5a796ac))


Bug Fixes

* make capture_logs work correctly with Python >= 3.9 ([aa1ffca](https://github.com/ReadAlongs/Studio/commit/aa1ffcaca0a7d88f10335bc789af4e3313f0c0aa)), closes [#162](https://github.com/ReadAlongs/Studio/issues/162)
* where there are no words to align, return 422, not 500 ([61d45e0](https://github.com/ReadAlongs/Studio/commit/61d45e0dcde7d025a4cec33f81408852c2ef0fc8))
* **dtd:** effective-g2p-lang missing from w def ([dc944ad](https://github.com/ReadAlongs/Studio/commit/dc944ad8c6c40811fafd1ded7ca8387d8f62472e))
* by default, output each g2p error at most twice ([a1f3c5d](https://github.com/ReadAlongs/Studio/commit/a1f3c5d962785ba86b89217ee7cc411d4995d2f3))
* clarify the settings and run the API by default ([d5ca78e](https://github.com/ReadAlongs/Studio/commit/d5ca78e2135e2325a5cdc6b52934854233b07ae2))
* do not fail when the lang code is invalid ([3b2a433](https://github.com/ReadAlongs/Studio/commit/3b2a433d2b8f5e3e043f1b8ad1eafc16aa041802))


Reverts

* Revert "chore: specify python 3.8 runtime" ([8012258](https://github.com/ReadAlongs/Studio/commit/8012258afc882437ed831e596a27f8ea81c5510d))


Code Refactoring

* we no longer need to support g2p<=0.5.20211029 imports ([04eb40e](https://github.com/ReadAlongs/Studio/commit/04eb40ee20fb1ac654f0fbbe270c9ddf50d842cf))


Build Systems

* maximally fix the dockerfile ([e4ad7b4](https://github.com/ReadAlongs/Studio/commit/e4ad7b4e1fe4ff447bd190815666fe84e069e001))
* minimally fix dockerfile ([f51e841](https://github.com/ReadAlongs/Studio/commit/f51e841c60b22047b19b04895e5e132be9e23ac8))


Continuous Integration

* exclude Python 3.11 on Windows from matrix testing, due to dependency error ([d80d8ad](https://github.com/ReadAlongs/Studio/commit/d80d8ad82418ae15b005e4e2ea527f3b530d9658))
* run full matrix testing, but only on push to main and release ([ea72d5f](https://github.com/ReadAlongs/Studio/commit/ea72d5f8361ae827b0814bba53a0415ef0a830a0))

[1.0.20230224](https://github.com/ReadAlongs/Studio/compare/v0.2.20221114...v1.0.20230224) (2023-02-25)


⚠ BREAKING CHANGES

* smil-ectomy
* avoid using dict for things that are lists
* new web API version
* use .ras not .xml
* no more smil
* update to .ras file extension in output

Features

* a simple DTD for standalone readalongs ([f94174b](https://github.com/ReadAlongs/Studio/commit/f94174bdcad14721d4012976217461381d735cf2))
* add time and dur attributes to w ([5e92b91](https://github.com/ReadAlongs/Studio/commit/5e92b913a9f591f4e32bac01d2d8b84d6a0756ad))
* avoid using dict for things that are lists ([20fc1a5](https://github.com/ReadAlongs/Studio/commit/20fc1a5f2d0c398b02fcf3e0fdbf0a41fe64d259))
* basically s/tei/readalong/gi ([5465d22](https://github.com/ReadAlongs/Studio/commit/5465d22e7d72de6e09beb60e0e4244b8a0b29a11))
* capture the logs from /assemble endpoint ([5713abc](https://github.com/ReadAlongs/Studio/commit/5713abcb77b9dc34716971aa5d646ca352f46b80))
* introduce better CORS environment variables ([1eb5d74](https://github.com/ReadAlongs/Studio/commit/1eb5d74c3031c9885f2ef529ce4ff95be3be632e)), closes [#146](https://github.com/ReadAlongs/Studio/issues/146)
* introduce better CORS environment variables ([d8ab4cf](https://github.com/ReadAlongs/Studio/commit/d8ab4cfb1da0b4af165819ef235abb62641675de)), closes [#146](https://github.com/ReadAlongs/Studio/issues/146)
* log message to say we are in development mode ([a1f53bc](https://github.com/ReadAlongs/Studio/commit/a1f53bc0ad1662842a4f3c47c59638e0eacff467))
* new web API version ([bec85ee](https://github.com/ReadAlongs/Studio/commit/bec85ee51c0c5959f6a1f3fb7f2b7cdee90f0f43))
* no more smil ([eb9d25b](https://github.com/ReadAlongs/Studio/commit/eb9d25be7ae8753958f1d02a3847681abb9429a9))
* output to .ras ([8d4f76b](https://github.com/ReadAlongs/Studio/commit/8d4f76b56163bcddd85d1cf8c168856611ed514e))
* refine the DTD somewhat ([b7285f5](https://github.com/ReadAlongs/Studio/commit/b7285f5de5ef7b1a379c37af92b6ec922e120e85))
* set our .readalong format to version 1.0 for publication ([2f0da60](https://github.com/ReadAlongs/Studio/commit/2f0da602671912914381502b170387cedf8e400b))
* smil-ectomy ([24dabbd](https://github.com/ReadAlongs/Studio/commit/24dabbd63fc6ed1e685a2db8e2652c93493e7bd3))
* update .ras to .readalong ([525facf](https://github.com/ReadAlongs/Studio/commit/525facf5fc3e84e65616ce138acdd18aaf0a0544))
* update to .ras file extension in output ([163de15](https://github.com/ReadAlongs/Studio/commit/163de15dfc5339fac5a8dedb906d3400e80f934e))
* update to href= in readalong component ([79b8a64](https://github.com/ReadAlongs/Studio/commit/79b8a64ffd50fa4aa7b4b6aa9c9a8064f32f4955))
* use .ras not .xml ([09b34d6](https://github.com/ReadAlongs/Studio/commit/09b34d6941ad54c0a9cdacf29d160c4cbdd6d263))


Bug Fixes

* accept <silence> and use dur not duration ([b65a5dd](https://github.com/ReadAlongs/Studio/commit/b65a5dd7edeee197b458677709fdc9f5dff5b3a8))
* add `class` to DTD and update version ([903ddd5](https://github.com/ReadAlongs/Studio/commit/903ddd5b0cdc0b7f098922d5bc65a67308e82d8c))
* add xml:lang and anchors everywhere ([7192fa6](https://github.com/ReadAlongs/Studio/commit/7192fa6a5f1416d5f66076b7cab5c9a6e6c16d1a))
* address XML external entity expansion vulnerabilities ([d0c57f3](https://github.com/ReadAlongs/Studio/commit/d0c57f3b771305e9ff181192a7019ba9a1ae07c2))
* correct __main__ guard in test_package_urls.py ([fbda869](https://github.com/ReadAlongs/Studio/commit/fbda8691306848f926ce4373b910232ea65fe044))
* don't create blank pages ([54d23d5](https://github.com/ReadAlongs/Studio/commit/54d23d557df71307272da1de78c89fe3ab274b73)), closes [#136](https://github.com/ReadAlongs/Studio/issues/136)
* filter ASCII langs from the Studio-Web via web_api ([e63406f](https://github.com/ReadAlongs/Studio/commit/e63406f4fc0080102fae927f0890c3b173efd8cb))
* frantic and unsuccessful attempts to make CORS work ([52b9a39](https://github.com/ReadAlongs/Studio/commit/52b9a39354c39db358081a1d9b9abfd7500824b4))
* handle requests.get() timeouts correctly ([464a3cc](https://github.com/ReadAlongs/Studio/commit/464a3cc62e3aed59f8fa14da4ddd40fc35a9e9b7))
* make test case valid ([fdd8cb0](https://github.com/ReadAlongs/Studio/commit/fdd8cb07ff3f30bb04aecbc4d7549a7f06314a23))
* only wait 10 seconds for JS_ and FONT_BUNDLE_URLs ([a67e360](https://github.com/ReadAlongs/Studio/commit/a67e3604c24bb8ab7d604a36574ce0d61f861e54))
* tell the user why their config.json is not valid ([4deb32e](https://github.com/ReadAlongs/Studio/commit/4deb32e5afa4e0550e915ecfcba395624de2367e))
* test and fix load_xml_zip ([10718dc](https://github.com/ReadAlongs/Studio/commit/10718dc36a52a3b6bda1a26536eb9374018c5aa3))
* try validating a different way to see if the CodeQL warning goes away ([6e62789](https://github.com/ReadAlongs/Studio/commit/6e627891b6348befb68c986abc4a6551ac3af93b))
* update bundle.css and bundle.js to readalongs/web-component0.2.1 ([a462688](https://github.com/ReadAlongs/Studio/commit/a462688ea6693a18041bfba4c7913a5ec3a018b9))
* update package URLs ([4eebbb3](https://github.com/ReadAlongs/Studio/commit/4eebbb3058cbe5e4477fcc9ca562b0a1e3c4cb94))
* use .xml not .ras to avoid breaking MIME guessing ([19fc2f1](https://github.com/ReadAlongs/Studio/commit/19fc2f1b674c3934026d3b6a7a95111827754498))
* validate path request by /file endpoint in views.py ([5ba27ad](https://github.com/ReadAlongs/Studio/commit/5ba27ad7378848127584e87ad69ada628a894d39))
* when g2p fails completely, send the log with the exception ([f772eec](https://github.com/ReadAlongs/Studio/commit/f772eec2e50364938566e8e8533106dbc4ca380e))
* woohps tyop ([367e539](https://github.com/ReadAlongs/Studio/commit/367e539a77613bb139ad3a670ffe831bf09f7a1e))
* words may not be aligned (e.g. do-not-align) ([586154d](https://github.com/ReadAlongs/Studio/commit/586154d78a2bd04b61f2e4bc34f41e0fcf4c2499))
* **docs:** fix formatting of /langs endpoint sample output ([7059978](https://github.com/ReadAlongs/Studio/commit/70599789d7c78c9409c607a52d3faf05db1896fb))
* write out a version number in the .readalong format ([2e28d86](https://github.com/ReadAlongs/Studio/commit/2e28d86c7737ab3bc7e5ea0122e03193ff592e68))


Tests

* add a couple more tests ([c68f06e](https://github.com/ReadAlongs/Studio/commit/c68f06e376e0d47694afd422c7f368b6c14c1eca))
* add bogus alignments ([959bda4](https://github.com/ReadAlongs/Studio/commit/959bda43d527d38452cd36c148e46d1d3953e2a7))
* add test of RAS XML validation ([7dd3072](https://github.com/ReadAlongs/Studio/commit/7dd3072bb00d819c90ef25f0f308e889f87a36d2))
* appease the codecov beast ([5dac6f3](https://github.com/ReadAlongs/Studio/commit/5dac6f30e16639e4533e4ee1f89fce075100d072))
* basically s/tei/readalong/gi ([4c1ed5a](https://github.com/ReadAlongs/Studio/commit/4c1ed5a8a7c78be6ceb44ca9b25959f14ebe3837))
* not sure why "lang" not "xml:lang" ([96ae876](https://github.com/ReadAlongs/Studio/commit/96ae876e1194dd3cd795d0d8b5c071e668cd93f4))
* test new web API ([adb6d3e](https://github.com/ReadAlongs/Studio/commit/adb6d3ecccbb7aac74e3a1bd3020bade343aea37))
* there is no text + alingment ther eis only readalong ([5e623b7](https://github.com/ReadAlongs/Studio/commit/5e623b7b27cf33fc88fcc339a041f36aa86e99ad))
* tolerate unpkg timeouts as non-failures ([dbd3942](https://github.com/ReadAlongs/Studio/commit/dbd394259e2aca5d0524c4b72995e162146610a1))
* update .ras to .readalong ([300a622](https://github.com/ReadAlongs/Studio/commit/300a6225f06da1331937eaaa75cffb35f966579f))
* update for new component and file format ([1d2ca59](https://github.com/ReadAlongs/Studio/commit/1d2ca5988ca13222e217b74f8856be0d0e2d222a))


Code Refactoring

* capture logs with a context manager ([87716bd](https://github.com/ReadAlongs/Studio/commit/87716bd30e690c21335a88ca422d57f3ee4ee4d7))
* change master branch name to main ([3b64837](https://github.com/ReadAlongs/Studio/commit/3b648375731587234baf2c67369c56f20830b0e3))
* move all etree.parse calls to a single well-tested function ([c2996b8](https://github.com/ReadAlongs/Studio/commit/c2996b8fedb9c28991c1c072d61e0d78a1d28fff))
* reformat ([1874e96](https://github.com/ReadAlongs/Studio/commit/1874e96a97b2838f9b4a8d97dc9c45e40cecbef0))
* **webapi:** change back to v1 ([c80224a](https://github.com/ReadAlongs/Studio/commit/c80224ab7f170bcf62c3d5c6a705dbbaf9dd09d3))
* remove deprecated studio ([692d630](https://github.com/ReadAlongs/Studio/commit/692d6304d8776f305f230dcc55ab6c4aff1264b0))
* switch to .readalong extension ([c4c6c89](https://github.com/ReadAlongs/Studio/commit/c4c6c897d62c3633a5ad60c56f8975f9eef9bf1a))


Continuous Integration

* activate CodeQL code analysis ([7f8761b](https://github.com/ReadAlongs/Studio/commit/7f8761b0313f16680c459cf6e91d2fbcd3dee8e5))
* combine debug and non-debug web_api tests ([214b081](https://github.com/ReadAlongs/Studio/commit/214b0810d878efba1b5d3d9191fd658d923b7831))
* only run CodeQL on cron and push to master and release ([6d44875](https://github.com/ReadAlongs/Studio/commit/6d44875ffe7ba568df8ab1199416c2c5fb67679b))
* submit PR instead of pushing version bump ([6f181a7](https://github.com/ReadAlongs/Studio/commit/6f181a72276811b0d4b99400d5e051fc66f65398)), closes [#83](https://github.com/ReadAlongs/Studio/issues/83)
* test web server in development mode too ([e7d892c](https://github.com/ReadAlongs/Studio/commit/e7d892c2f2a77ff1132e2ae83466c9886b6cd8b3))


Documentation

* **setup:** improve pypi ([ec00b4f](https://github.com/ReadAlongs/Studio/commit/ec00b4fb868f6308361ebd4cd7e55ab3c64f3adf))
* better document how to install and run the Web API ([996a96a](https://github.com/ReadAlongs/Studio/commit/996a96a5f0e4dbd6577b835aeebc8c244275f863))
* clean up /langs doc ([43dd309](https://github.com/ReadAlongs/Studio/commit/43dd309791f7a9ab3cc9790797587e7e78251413))
* document new environment variables ([34b4435](https://github.com/ReadAlongs/Studio/commit/34b4435ad764ed47a831244e21c739efc153b03b))
* remove smil and add ras ([7be9d7e](https://github.com/ReadAlongs/Studio/commit/7be9d7ea57d28e793a658462f05eefa3fb813d6b))
* update .ras to .readalong ([b9bf023](https://github.com/ReadAlongs/Studio/commit/b9bf02390ecb1a3454961644191e8aa89515a77f))