kiwix/kiwix-js
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-js.git synced 2025-09-23 12:36:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #327 from kiwix/update-changelog-for-v2.2

Browse Source 
Update README, About section and CHANGELOG.
This commit is contained in:
Mossroy 2018-01-05 11:43:17 +01:00 committed by GitHub
commit 2a4de89693
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 40 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CHANGELOG.md
View File

@ -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

16
README.md
View File

@ -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.

18
www/index.html
View File

@ -106,8 +106,8 @@
<h3>Usage</h3>
<h4>Step 1 : download some content</h4>
from <a href="http://download.kiwix.org/zim" target="_blank">http://download.kiwix.org/zim/</a>, with a regular computer.
<strong>Currently only Wikimedia contents (ZIM files in wiki* subdirectories, for instance <a href="http://download.kiwix.org/zim/wikipedia/" target="_blank">http://download.kiwix.org/zim/wikipedia/</a>) have been tested</strong>.
There are known bugs when reading other contents; and audio/video/dynamic contents are not supported for now.
<strong>Currently only Mediawiki-based contents (ZIM files in wiki* subdirectories, for instance <a href="http://download.kiwix.org/zim/wikipedia/" target="_blank">http://download.kiwix.org/zim/wikipedia/</a>) and StackExchange (<a href="https://download.kiwix.org/zim/stack_exchange/" target="_blank">https://download.kiwix.org/zim/stack_exchange/</a>) have been tested</strong>.
Audio/video/dynamic contents are not supported for now.
<br />For a quick test, you can start with the <a href="http://download.kiwix.org/zim/wikipedia/wikipedia_en_ray_charles_2015-06.zim" target="_blank">"Ray Charles" ZIM file</a> : it contains some wikipedia articles about Ray Charles.
<br />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).
<br />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 <a href="http://www.kiwix.org/wiki/FAQ">the Kiwix FAQ</a>
@ -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.
<br />This application only reads the archive files of your device : it does not read any other files.
<h3>Feedback / helping / contributing</h3>
This application is still a work in progress. There are many bugs and improvements that need to be done. In particular :
<ul>
<li><a href="https://github.com/kiwix/kiwix-js/issues/114" target="_blank">Issue #114</a> : Add a way to easily download ZIM files directly to the device</li>
<li><a href="https://github.com/kiwix/kiwix-js/issues/13" target="_blank">Issue #13</a> : All the user interface is in English : I plan to translate it at least in French. If you feel able to translate it in your language, please contact me</li>
<li><a href="https://github.com/kiwix/kiwix-js/issues/172" target="_blank">Issue #172</a> and <a href="https://github.com/kiwix/kiwix-js/issues/152" target="_blank">#152</a> : Handle video and javascript content</li>
<li><a href="https://github.com/kiwix/kiwix-js/issues/126" target="_blank">Issue #126</a> : Load the welcome page at first startup</li>
<li><a href="https://github.com/kiwix/kiwix-js/issues/117" target="_blank">Issue #117</a> : Better handle upper/lowercase and accents/diacritics in title search</li>
<li>Performance improvements etc.</li>
</ul>
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 <a href="https://github.com/kiwix/kiwix-js" target="_blank">github</a>.
The <a href="https://github.com/kiwix/kiwix-js/issues" target="_blank">bugtracker</a> is on github too. We use it as our roadmap.
<br />Alternatively, you can send your feedback <a href="mailto:mossroy@mossroy.fr?subject=%5BKiwix%5D%20Feedback%20about%20Kiwix%20JS">by email</a>.
@ -155,7 +147,7 @@
<li>All the developers of libraries and tools I used for releasing them as Free software (see License paragraph)</li>
</ul>
<h3>License information</h3>
Copyright 2013-2017 Mossroy, Peter-x and contributors
Copyright 2013-2018 Mossroy, Peter-x, Jaifroid, sharun-s and other contributors
<br />This application is licensed under the GPL v3 license :
<br />
<i>
@ -197,7 +189,7 @@
<div id="openLocalFiles" style="display: none;">
Please select the .zim file (or all the .zimaa, .zimab etc in case of a split ZIM file)<br />
<input type="file" id="archiveFiles" multiple class="btn" accept=".zim,.dat,.idx,.txt,.zimaa,.zimab,.zimac,.zimad,.zimae,.zimaf,.zimag,.zimah,.zimai,.zimaj,.zimak,.zimal,.zimam,.ziman,.zimao,.zimap,.zimaq,.zimar,.zimas,.zimat,.zimau,.zimav,.zimaw,.zimax,.zimay,.zimaz,.zimba,.zimbb,.zimbc,.zimbd,.zimbe,.zimbf,.zimbg,.zimbh,.zimbi,.zimbj,.zimbk,.zimbl,.zimbm,.zimbn,.zimbo,.zimbp,.zimbq,.zimbr,.zimbs,.zimbt,.zimbu,.zimbv,.zimbw,.zimbx,.zimby,.zimbz" /><br />
<strong>Only Wikimedia contents (wiki*.zim* files) have been tested</strong> for now. There are known bugs on other contents, and audio/video/dynamic contents are not supported for now.<br />
<strong>Only Mediawiki-based (wiki*.zim* files, like wikipedia) and StackExchange contents have been tested</strong> for now. Audio/video/dynamic contents are not supported for now.<br />
</div>
<div id="scanningForArchives" style="display: none;">
<br /> Scanning for archives... Please wait <img src="img/spinner.gif" alt="Please wait..." />

2
www/js/lib/abstractFilesystemAccess.js
View File

@ -58,7 +58,7 @@ define(['q', 'jquery'], function(q, jQuery) {
};
// We try to match both a standalone ZIM file (.zim) or
// the first file of a splitted ZIM files collection (.zimaa)
// the first file of a split ZIM files collection (.zimaa)
var regexpZIMFileName = /\.zim(aa)?$/i;
/**

10
www/js/lib/zimArchive.js
View File

@ -28,7 +28,7 @@ define(['zimfile', 'zimDirEntry', 'util', 'utf8'],
*
*
* @typedef ZIMArchive
* @property {ZIMFile} _file The ZIM file (instance of ZIMFile, that might physically be splitted into several actual files)
* @property {ZIMFile} _file The ZIM file (instance of ZIMFile, that might physically be split into several actual files)
* @property {String} _language Language of the content
*/
@ -65,11 +65,11 @@ define(['zimfile', 'zimDirEntry', 'util', 'utf8'],
}
else {
if (/.*zim..$/.test(path)) {
// splitted archive
// split archive
that._searchArchiveParts(storage, path.slice(0, -2)).then(function(fileArray) {
createZimfile(fileArray);
}, function(error) {
alert("Error reading files in splitted archive " + path + ": " + error);
alert("Error reading files in split archive " + path + ": " + error);
});
}
else {
@ -83,9 +83,9 @@ define(['zimfile', 'zimDirEntry', 'util', 'utf8'],
};
/**
* Searches the directory for all parts of a splitted archive.
* Searches the directory for all parts of a split archive.
* @param {Storage} storage storage interface
* @param {String} prefixPath path to the splitted files, missing the "aa" / "ab" / ... suffix.
* @param {String} prefixPath path to the split files, missing the "aa" / "ab" / ... suffix.
* @returns {Promise} that resolves to the array of file objects found.
*/
ZIMArchive.prototype._searchArchiveParts = function(storage, prefixPath) {