Releases: kiwix/kiwix-js
v3.3.1
FIX: Improve packaging for the Ubuntu Touch app
FIX: Provide a platform-compliant hook name for the Ubuntu Touch app (note that settings may be lost when upgrading to this version)
BUGFIX: Correct the handling of version numbers in GitHub publishing workflow
BUGFIX: Correct race condition preventing initialization of decompressors in some contexts (e.g. file:// protocol)
v3.3.0
- FEATURE: Provided a workaround to enable Service Worker mode in Firefox extensions (via a PWA)
- NEW: App now defaults to Service Worker mode if accessed directly as a PWA (does not apply to browser extensions)
- NEW: Provided methods for resetting the app and bypassing the appCache from the UI
- NEW: Support for non-http URLs in img and link tags (e.g. data: javascript:) in JQuery mode
- NEW: Added helpful tooltips to icons and settings in the app
- NEW: Provided Code of Conduct and procedure for reporting bugs, for contributors (repository)
- NEW: Provided contributing guidelines and information for future developers (repository)
- FIX: Added missing 'controls' property to media containers in jQuery mode
- FIX: Scrolling to anchor targets in JQuery mode
- FIX: Caching of ZIM assets now includes any required query string in SW mode
- FIX: Any favicon declared by the ZIM is now extracted and attached in JQuery mode
- BUGFIX: Corrected the theme selection box height
- BUGFIX: Aligned the search bar with the search button
- BUGFIX: Disabled dragging of some UI elements
- BUGFIX: Incorrect processing of titles with question marks or hashes prevented display of some articles
v3.2.0
- NEW: Support latest format of ZIM archives (with no namespace)
- NEW: Optimization of title search by eliminating redundancies
- NEW: Support new format of title listings (v1) in no-namespace ZIM archives
- NEW: 'Home' key can now be used to focus the search field
- NEW: Use native Promises (or modern polyfill where required) instead of Q, improving performance in modern browsers and IE11
- NEW: Use fast binary WASM decoders with fallback to ASM if necessary
- UPDATE: Clearer and more extensive documentation for end users in About
- UPDATE: Unit testing updated to latest QUnit, and use Karma instead of Nightwatch
- UPDATE: Replace Travis by GitHub Actions for continuous integration
- UPDATE: Added helper scripts and instructions for recompiling decompressors with Docker
- BUGFIX: Issue with calculation for selection of random articles
- BUGFIX: Incorrect syntax in usage of classList method that caused an exception in older browsers with rare ZIM types
v3.1.0
- NEW: Low-level block cache significantly improves binary search speed, and can speed up resource loading in most browsers
- NEW: Archives with WebP-encoded images are now decoded in legacy browsers via a polyfill
- UPDATE: Images are now extracted sequentially in jQuery mode from the top of the DOM
- BUGFIX: Running binary searches are now cancelled completely if user enters new search term or navigates away
- BUGFIX: Active content warning was erroneously showing on some ZSTD WikiMedia landing pages in jQuery mode
v3.0.0
v2.8.0
- NEW: Intelligently select the best Storage API for storing settings between sessions (
cookie
orlocalStorage
) - NEW: Display title search results progressively instead of waiting for search to complete before displaying them
- NEW: User can change depth of title search from Configuration
- UPDATE: Better handling of case in title search, returning more accurate search results
- UPDATE: Use
const
to declare constants, enabling better app memory management - UPDATE: Use
SameSite=Strict
for any residual cookie usage to conform to new security standards - BUGFIX: Major blocking bug causing high memory usage and slow load times when reading MIME type table of recent ZIM archives
v2.7.0
- NEW: Selectable dark mode for app UI and for articles (does not work on IE11)
- NEW: Optional transition between app pages
- NEW: Native asset caching in Service Worker mode - considerably speeds up article load times in some contexts
- UPDATE: Privacy Policy
- UPDATE: Minor changes to Kiwix icon
- UPDATE: Bootstrap updated to v4
- UPDATE: Q Promise library updated to v1.5.1
- UPDATE: Various code simplifications and cleanup
- BUGFIX: Support details-summary tags to ensure all article subheadings are open in jQuery mode
- BUGFIX: Broken display when search results have special characters
- BUGFIX: Display of random article fragments when using back/forward buttons quickly
- BUGFIX: Several UI bugs (search results disappearing, redundant scroll bar)
v2.6.0
Support for imagemaps (area tags) in jQuery mode, like for maps in wikivoyage
Enable keyboard selection in search results
Drag and drop support of ZIM files (on desktop)
Support download of epub files (for Gutenberg ZIM files) and some other types of downloads
Generic handling of MIME Types, instead of the previously hard-coded ones
Add explanations and detect when there are CORS issues when running kiwix-js through file://
Fix for some cache issues with Chromium extension in ServiceWorker mode, that were mixing content from different ZIM files
Some fixes for filenames with question marks, hyperlinks with hashtags, articles with no title, and articles with special characters in their URL
Fix for articles with a slash in their title in ServiceWorker mode (at least for StackOverflow ZIM files). Note that some wikivoyage ZIM files (of 2019-06) had incorrect links in their homepage, and are not working with this fix. This has been fixed in 2019-07 ZIM files (see openzim/mwoffliner#726).
Upgrade the underlying Ubuntu Touch platform to Xenial
Improve the automated UI tests with a more complete scenario
Simplify the code by removing the base tag
v2.5.0
Support for javascript content inside the ZIM file, only in ServiceWorker mode. Handle noscript tags in jQuery mode, and display a warning when some unhandled javascript is detected
Preliminary support of video/audio content (including subtitles) : these content types are now supported. You can read them for example in TED/TEDx, dirtybiology, oer4schools etc. BUT the main page of these ZIM files needs javascript to work properly, which is only enabled in ServiceWorker mode. In jQuery mode, the user needs to reach the pages through a search
Some technical fixes : footnotes in wikimedia ZIM files (and, more generally, anchors in hyperlinks), incomplete searches in some specific ZIM files (PhET and TED), compatibility with URLs that contain an apostrophe, remove debug logs in ServiceWorker mode
In the UI, replace the spinner by a more modern one