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

Merge pull request #601 from ashiscs/master

Browse Source 
minor fix in README.md
This commit is contained in:
Mossroy 2020-03-22 10:51:23 +01:00 committed by GitHub
commit 2b72b58cd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -6,7 +6,7 @@ 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. 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). All the content of Wikipedia is inside your device (including the images).
It might also works with other content in the OpenZIM format: https://wiki.openzim.org/wiki/OpenZIM , but has been only tested on the Mediawiki-based (wikipedia, wikivoyage etc) and StackExchange ZIM files. It might also work with other content in the OpenZIM format: https://wiki.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. If your Internet access is expensive/rare/slow/unreliable/watched/censored, you still can browse this amazing repository of knowledge and culture.
@ -23,9 +23,9 @@ You have to download them separately, store them in your filesystem, and manuall
It is unfortunately not technically possible to "remember" the selected ZIM file and open it automatically (the browsers refuse that for security reasons). It is unfortunately not technically possible to "remember" the selected ZIM file and open it automatically (the browsers refuse that for security reasons).
## Some technical details ## 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 : 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. It works well on Mediawiki-based 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. 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 currently disabled by Mozilla in Firefox extensions - 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 ## Compatibility
This is written in HTML/javascript so it should work on many recent browser engines. This is written in HTML/javascript so it should work on many recent browser engines.
@ -39,7 +39,7 @@ This is written in HTML/javascript so it should work on many recent browser engi
- Ubuntu Touch (as an application : https://open.uappexplorer.com/app/kiwix) - Ubuntu Touch (as an application : https://open.uappexplorer.com/app/kiwix)
### Platforms that are unofficially reported to work ### Platforms that are unofficially reported to work
These platforms are not officially supported, but are currently working. We'll try to keep compatibility as long as it's not too complicated : 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 Internet Explorer 11 - Microsoft Internet Explorer 11
@ -53,12 +53,12 @@ Unit tests can be run by opening tests.html file on Firefox or Edge (or Chromium
## Public releases and nightly builds ## 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 https://download.kiwix.org/release/browsers/ if necessary. The browser extensions are distributed through the stores of each vendor (see links above). But the packages are also saved in https://download.kiwix.org/release/browsers/ if necessary.
Some nightly builds are generated, and should only be used for testing purpose : https://download.kiwix.org/nightly/ Some nightly builds are generated, and should only be used for testing purpose: https://download.kiwix.org/nightly/
## Previous versions ## Previous versions
The first versions of this application were originally part of the Evopedia project: http://www.evopedia.info (now discontinued). There was a "articles nearby" feature, that was able to find articles around your location. It has been deleted from the source code with everything related to Evopedia (but still in git history in versions<=2.0.0) The first versions of this application were originally part of the Evopedia project: http://www.evopedia.info (now discontinued). There was a "articles nearby" feature, that was able to find articles around your location. It has been deleted from the source code with everything related to Evopedia (but still in git history in versions<=2.0.0)
These first versions were targeting Firefox OS (now discontinued too : we're not lucky ;-) ). 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). Some Phonegap/Cordova port was started but never finished (see in git history in versions<=2.0.0).
See [CHANGELOG.md](CHANGELOG.md) for the detail of previous versions. See [CHANGELOG.md](CHANGELOG.md) for the detail of previous versions.