kiwix/kiwix-js
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-js.git synced 2025-09-22 20:13:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #377 from kiwix/changelog-for-v2.3.0

Browse Source 
Update Changelog with the content of version 2.3.0
This commit is contained in:
Mossroy 2018-06-04 21:59:41 +02:00 committed by GitHub
commit 2dc9dde3e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CHANGELOG.md
View File

@ -4,11 +4,30 @@ Please note that this application has changed its name over time.
It was first called Evopedia (and was using the file format of Evopedia)
Then it was renamed Kiwix-html5 (and uses ZIM files), then was renamed Kiwix-JS.
## Kiwix-JS v2.3.0
## Kiwix-JS v2.4.0
Released on TODO
TODO
## Kiwix-JS v2.3.0
Released on 2018-06-04
Add a cache on CSS stylesheets to improve performance in jQuery mode
Change the technical way to display articles, so that all CSS styles can be loaded, and to avoid other technical issues
Make the content visible only when CSS styles are read, in order to avoir repaints that can be very slow
Fix redirections in ServiceWorker mode in ZIM files like StackExchange, and make the ServiceWorker handle all the articles (including the main one, and the first displayed after a search or random search)
Fix links with an anchor in the URL
In recent wikipedia and other wikimedia ZIM files, open all the sections when using a small screen (mobile stylesheet), so that the content remains readable (it only works in jQuery mode, this should be fixed in ServiceWorker mode in next version)
Fix CSS UTF-8 encoding
Detailed changelog : https://github.com/kiwix/kiwix-js/milestone/18?closed=1
## Kiwix-JS v2.2.0
Released on 2018-01-07
@ -142,4 +161,4 @@ Detailed changelog : https://github.com/kiwix/kiwix-js/milestone/1?closed=1
## Initial work
The idea of porting Evopedia in javascript emerged in November 2012.
Some work has started on this in December 2012
Some work has started on this in December 2012

5
README.md
View File

@ -20,8 +20,7 @@ It is unfortunately not technically possible to "remember" the selected ZIM file
## Some technical details
Technically, after reading an article from a ZIM file, there is a need to "inject" the dependencies (images, css etc). For compatibility reasons, there are several ways to do it :
- the "jQuery" mode parses the DOM to find the HTML tags of these dependencies, and modifies them to put the Base64 content in it. It is compatible with any browser, but is slow and can use a lot of memory. It works well on Mediawiki-based content, but can miss some dependencies on some contents
- the "ServiceWorker" mode uses a Service Worker to catch any HTTP request the page would send, and reply with content read from the ZIM file. It is a generic and much cleaner way than jQuery mode, but it does not work on all browsers. And ServiceWorkers are disabled by Mozilla in Firefox extensions
- maybe a "webRequest" mode will appear, which would use the webRequest API inside the Firefox extension (when the necessary APIs will be implemented by Mozilla)
- the "ServiceWorker" mode uses a Service Worker to catch any HTTP request the page would send, and reply with content read from the ZIM file. It is a generic and much cleaner way than jQuery mode, but it does not work on all browsers. And ServiceWorkers are currently disabled by Mozilla in Firefox extensions
## Compatibility
This is written in HTML/javascript so it should work on many recent browser engines.
@ -57,4 +56,4 @@ The first versions of this application were originally part of the Evopedia proj
These first versions were targeting Firefox OS (now discontinued too : we're not lucky ;-) ).
Some Phonegap/Cordova port was started but never finished (see in git history in versions<=2.0.0).
See the CHANGELOG.md file for the detail of previous versions.
See the CHANGELOG.md file for the detail of previous versions.