From 206a8798befc0de2709217401f97409fbfe1406a Mon Sep 17 00:00:00 2001 From: Mossroy Date: Wed, 3 Jan 2018 17:24:06 +0100 Subject: [PATCH] Update README, About section and CHANGELOG. And some rewording. In order to prepare a v2.2 release. --- CHANGELOG.md | 22 +++++++++++++++++++++- README.md | 16 ++++++++-------- www/index.html | 18 +++++------------- www/js/lib/abstractFilesystemAccess.js | 2 +- www/js/lib/zimArchive.js | 10 +++++----- 5 files changed, 40 insertions(+), 28 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9e73cf2d..e3bc5db9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,27 @@ Then it was renamed Kiwix-html5 (and uses ZIM files), then was renamed Kiwix-JS. ## Kiwix-JS v2.2.0 Released on TODO -TODO +Rename the project to Kiwix-JS instead of Kiwix-html5. + +Compatibility with split English wikipedia ZIM files (which now have more than 26 files). + +Slightly improved memory handling of content decompression. + +Library updates (jQuery, Bootstrap, requireJS). + +Improved continuous integration (automated testing on several browsers). + +Avoid unnecessary 404 errors on images. + +Ubuntu Touch support. + +Minor UI enhancements and fixes. + +Support for StackExchange ZIM files (and maybe for some other ZIM files with a structure different than the Mediawiki-based ZIM files). + +Some code refactoring/cleaning on the way we handle the jQuery mode. + +Make geo: and tel: links work. Detailed changelog : https://github.com/kiwix/kiwix-js/milestone/6?closed=1 diff --git a/README.md b/README.md index 4c87f800..e8fabdcb 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # Kiwix JS -## Summary +## Summary Kiwix is an offline Wikipedia viewer. See the official site: http://www.kiwix.org/ This is a browser extension developed in HTML5/Javascript. You can search among the article titles, and read any of them without any Internet access. All the content of Wikipedia is inside your device (including the images). -It might also works with other content in the OpenZIM format: http://www.openzim.org/wiki/OpenZIM , but has been only tested on the Wikipedia ones. +It might also works with other content in the OpenZIM format: http://www.openzim.org/wiki/OpenZIM , but has been only tested on the Mediawiki-based (wikipedia, wikivoyage etc) and StackExchange ZIM files. If your Internet access is expensive/rare/slow/unreliable/watched/censored, you still can browse this amazing repository of knowledge and culture. @@ -19,7 +19,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 Wikimedia content, but can miss some dependencies on some contents +- 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) @@ -30,13 +30,13 @@ This is written in HTML/javascript so it should work on many recent browser engi - Mozilla Firefox >=45 (as an extension : https://addons.mozilla.org/fr/firefox/addon/kiwix-offline/) - Google Chrome (or Chromium) >=58 (as an extension : https://chrome.google.com/webstore/detail/kiwix/donaljnlmapmngakoipdmehbfcioahhk) - Firefox OS >=1.2 (needs to be installed manually on the device with WebIDE) - -Windows Mobile >=10 support is currently in development and is installable as a UWP application for testing via https://github.com/kiwix/kiwix-js-windows/ +- Microsoft Edge >=40 (needs to run a local copy of the source code) +- Windows Mobile >=10 (as a UWP application : see https://github.com/kiwix/kiwix-js-windows/) +- Ubuntu Touch (as an application : https://open.uappexplorer.com/app/kiwix) ### Platforms that are unofficially reported to work -These platforms are not officially supported, but it has recently been reported to work on : +These platforms are not officially supported, but are currently working. We'll try to keep compatibility as long as it's not too complicated : -- Microsoft Edge 40 - Microsoft Internet Explorer 11 ## License @@ -44,7 +44,7 @@ This application is released under the GPL v3 license. See http://www.gnu.org/li The source code can be found at https://github.com/kiwix/kiwix-js ## Unit tests -Unit tests can be run by opening tests.html file on Firefox (or Chromium/Chrome with some tweaks). +Unit tests can be run by opening tests.html file on Firefox or Edge (or Chromium/Chrome with some tweaks). ## Public releases and nightly builds The browser extensions are distributed through the stores of each vendor (see links above). But the packages are also saved in http://download.kiwix.org/bin/browsers/ if necessary. diff --git a/www/index.html b/www/index.html index c4b1062b..80a2604d 100644 --- a/www/index.html +++ b/www/index.html @@ -106,8 +106,8 @@

Usage

Step 1 : download some content

from http://download.kiwix.org/zim/, with a regular computer. - Currently only Wikimedia contents (ZIM files in wiki* subdirectories, for instance http://download.kiwix.org/zim/wikipedia/) have been tested. - There are known bugs when reading other contents; and audio/video/dynamic contents are not supported for now. + Currently only Mediawiki-based contents (ZIM files in wiki* subdirectories, for instance http://download.kiwix.org/zim/wikipedia/) and StackExchange (https://download.kiwix.org/zim/stack_exchange/) have been tested. + Audio/video/dynamic contents are not supported for now.
For a quick test, you can start with the "Ray Charles" ZIM file : it contains some wikipedia articles about Ray Charles.
After that, you can download materials in your language. Check the size before you download files as many of the files are large (several Gigabytes).
If the file is larger than 2 GB, it might not be supported by your device if your storage is formatted using a FAT filesystem. If so, it's possible to split the material into several 2GB files : see the Kiwix FAQ @@ -123,15 +123,7 @@ Anyway, if you think your Internet access can be watched and/or if you are paranoid, you should shut down your 3G and Wifi access before using the application.
This application only reads the archive files of your device : it does not read any other files.

Feedback / helping / contributing

- This application is still a work in progress. There are many bugs and improvements that need to be done. In particular : - + This application is still a work in progress. There are many bugs and improvements that need to be done. Suggestions and patches/pull requests are welcome : the source code is on github. The bugtracker is on github too. We use it as our roadmap.
Alternatively, you can send your feedback by email. @@ -155,7 +147,7 @@
  • All the developers of libraries and tools I used for releasing them as Free software (see License paragraph)

    • License information

    - Copyright 2013-2017 Mossroy, Peter-x and contributors + Copyright 2013-2018 Mossroy, Peter-x, Jaifroid, sharun-s and other contributors
    This application is licensed under the GPL v3 license :
    @@ -197,7 +189,7 @@