# Kiwix JS for Windows
Offline Wikipedia reader

## Welcome to Kiwix JS for Windows

#### Version 0.9 Beta

### Changes in 0.9 (beta)

- Optimization of decompression process
- Workaround to prevent periodic hang in Service Worker mode
- Fixed crash in regex engine caused by malformed backreferences in some articles

Full changelog...

### Please read this important information!

This application is packaged with only a basic ZIM archive (about a Jazz musician) so that you can get a feel for how offline Wikipedia browsing works.

You will need to downloaded an offline ZIM archive and store it on your device. You can do this from the Configuration page , or else see the About page for more information.

For the full experience you must download a ZIM archive and store it on your device! Alternatively, if you only want Wikivoyage or WikiMed in English, look for "Wikivoyage by Kiwix" or "WikiMed" in the Store and install those apps instead.

Kiwix JS is free and open source. If you like it, please leave a positive review. Constructive feedback and help with improving the app are very welcome: see About section.

### Features in Version 0.9 Beta

- Compatible with Continuum!
- Printing the article contents is supported on mobile and desktop
- Wikivoyage pages (English and German) display map location markers: tap to open Maps app
- Last-visited page remembered between sessions (optional)
- In-page search / highlighting (search button/Ctrl-F/Alt-F)
- Dark-theme for UI and content
- Equations typeset with MathJax if original TeX string is available
- Transform layout: Wikipedia mobile or desktop styles
- Optionally disable images if device is slow

### Please choose print options

Print the desktop (not mobile) style (default: yes) Print navigation boxes (default: no) Print endnotes (default: no) Print External Links (default: no) Print See Also (default: no) Print infoboxes (default: yes) Print images (default: yes) Resize document for printing: Current value: 75%

#### Information

## Kiwix JS Windows

### Offline Wikipedia Viewer (Version )

Packaged ZIM archive:

- Changelog and Features
- Privacy Policy
- Feedback and Support
- Credits and Licence
- Official site : http://www.kiwix.org/

If your Internet access is expensive / slow / unreliable / watched / censored, you can still gain offline access to a huge repository of knowledge and culture.

To use this app, you will need to download one or more archives (called ZIM archives) from the Kiwix website. You will then have offline access to Wikipedia, Wiktionary, Wikivoyage and many other sources even if you are undertaking a long plane journey, hiking, and travelling or living in areas with weak Internet access.

You can search through article titles and read any of these articles completely offline.

You can have the entire content of Wiktionary or Wikipedia in your language (including the images) in your pocket.

Offline archives use the OpenZIM format, but note that this app has been only tested extensively on Wikipedia-related archives (e.g., Wikipedia, Wikivoyage, Wikimed, Wiktionary).

On some Wikivoyage (English and German) pages you will see a map location marker: . Tap this icon to open the Maps app at the selected location. This will work offline if you have downloaded the map for the relevant country in the Windows Settings for Offline Maps.

### Usage

#### Step 1: download some content

You can browse the Kiwix repository on the Configuration page, and it will provide instructions according to the type of file you download. Alternatively, visit http://download.kiwix.org/zim/ using a regular computer. Currently only Wikimedia contents (ZIM files in wiki* subdirectories) have been tested fully. There are known bugs when reading other content, and audio/video/dynamic content is not currently supported.

Note that some of these ZIM archives are very large indeed (several gigabytes), especially if you want the archives with pictures. Archives without pictures (look out for "nopic" in the filename) are generally much smaller. Important: if the file is larger than 4 GB, it might not be supported by your device if your storage (e.g. microSD card) is formatted using a FAT filesystem. If so, it's possible to split the material into several 2GB files, or to download pre-split files: see the Kiwix FAQ.

#### Step 2: copy the content onto your device

If you have enough space, you can put several archives on your device storage. If you download the content directly in the app, note the location of the saved file when you get the notification that it has completed. If you downloaded via a PC, you will generally need to use a USB cable to copy the ZIM archive(s) to an accessible location on your device, such as the SD card or the main storage area if there is enough space there.

#### Step 3: open this app, go to the "Configure" menu and select your ZIM file

On the Configuration page, tap the "Select storage" button. If you have downloaded more than one archive, or you have a split ZIM archive consisting of several 2GB files, then you will need to pick the folder that contains these files. If you have just one unsplit ZIM archive, you can instead pick the file direclty, using the respective buttons on the Configuration page (note that these buttons only appear after you tap "Select Storage").

#### Step 4: enjoy your content offline!

### Changes in 0.9

### Privacy policy

#### Short answer:

Kiwix JS Windows works entirely offline unless you specifically request otherwise on the Configuration page. We do not collect any of your personal data and don't even know what you are doing with this application.

#### Longer answer:

Kiwix JS Windows will only access the Kiwix download server if you specifically request it to find and display download links for ZIM archives on the Configuration page. You can disable even this Internet access with an option on the same page. If you nevertheless believe your Internet access can be watched and/or if you are extremely cautious, you should shut down your 3G and WiFi access before using the application.

This application only reads the archive files of your device: it is not capable of reading any other files.

By default, this application will remember your last-visited page between sessions using a local cookie that is accessible only by this app on this device. If you are accessing sensitive information that you do not wish to be displayed next time you open this app, we recommend that you turn this option off in the Configuration options.

### Feedback / helping / contributing

This application is still a work in progress. There are many bugs that need fixing and improvements that need to be implemented. In particular:

- Issue #13: All the user interface is in English : we plan to translate it at least into French and Spanish. If you feel able to translate it in your language, please contact us
- Issue #172 and #152: Handle video and javascript content
- Issue #117 : Better handle upper/lowercase and accents/diacritics in title search
- Performance improvements etc.

Suggestions and patches/pull requests are welcome: the source code is on github. The Kiwix JS Windows issue tracker is on GitHub too, though also check the tracker for Kiwix JS as a lot of the development is done for both apps.

Alternatively, you can send your feedback by email.

In all cases, please give as much detail as you can: which device you are using, which version of Kiwix, which archive, which articles etc.

If you like the Kiwix project and use it, please consider giving donations:

- to the Wikimedia foundation, to help maintaining their servers and article contents. See the donation page
- to Kiwix, to help maintaining the ZIM files and applications. There is a donation button in the home page of kiwix.org

You can also help by:

- Adding articles or improving the existing ones, by editing online Wikipedia articles
- Participating in the Kiwix project

### Credits

Thanks are due to:

- Kelson and all the Kiwix community for welcoming peter-x, mossroy, jaifroid and sharun-s onto this project
- Wikipedia teams and contributors for helping to spread knowledge to everybody
- All the developers of libraries and tools we use for releasing them as Free software (see Licence paragraph)

### Licence information

Copyright 2013-2018 Mossroy, Peter-x, Jaifroid, sharun-s and other contributors
Jaifroid for adaptation and development of the app on the Universal Windows Platform
This application is licensed under the GPL v3 licence:
Kiwix is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public Licence as published by
the Free Software Foundation, either version 3 of the Licence, or
(at your option) any later version.
Kiwix is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public Licence for more details.
You should have received a copy of the GNU General Public Licence
along with Kiwix (file LICENSE-GPLv3.txt). If not, see http://www.gnu.org/licenses/

Main libraries and resources used:

- jQuery 2, released under the MIT licence
- Bootstrap 3, released under the Apache licence 2.0, which includes icons from Glyphicons
- RequireJS 2, released under the MIT licence or new BSD licence
- QUnit 2, released under the MIT licence
- Kiwix logo from kiwix.org, released under the Creative Commons Attribution Share Alike
- OpenZIM specifications from www.openzim.org, released under the Creative Commons Attribution Share Alike
- Emscripten to generate a XZ decompressor in javascript : https://github.com/kripken/emscripten, released under the MIT licence
- XZ Embedded (the XZ library converted to Javascript with Emscripten), in public domain
- MathJax for typesetting mathematical and chemical equations, released under the Apache 2.0 licence
- Hilitor for finding and hilighting text inside an article, released under this licence

### Other platforms/versions

Other Kiwix clients exist on various platforms. See the official site : http://www.kiwix.org/.

## Configuration

This application needs a ZIM archive to work. You can get one from the download links panel.

Scanning for archives... Please wait

Archives found on this device (tap "Select storage" to rescan):

There were no ZIM file(s) found in the selected location! Please choose a different folder.

For a single unsplit archive

For multiple or split archives

Please choose the location of your ZIM archive.
For a split archive (.zimaa, .zimab, etc.) you must select all the split parts.

Only Wikimedia contents (wiki*.zim* files) have been tested well with this app.

| Tap to select app's local storage or to select a file or folder

### Download links

Files can be very large, do not attempt to download using mobile data!

| Opens library of archives for download: Warning: this will use data

Allow Internet access?

### Display settings

Dark mode:
Use dark mode for User Interface Use dark theme for articles (experimental: may only work with Wikipedia) Use simple inversion for dark theme (should work with all archive types)
Display style:
Select style automatically (recommended: matches the ZIM style) Use Wikimedia desktop style (and transform if necessary) Use Wikimedia mobile style (and transform if necessary) Remove max page width restriction: (useful for recent Wikipedia archives)
Display options:
Hide top toolbar while scrolling (tap once to reveal) Change font size for the User Interface: Current value: 100%
(to change article font size, tap and ) Use locally cached display styles (recommended for Wikipedia ZIM) Display images if any (if hidden, tap the blue area to display one-by-one)

### Privacy settings

Persistence of data:
Reopen last-visited page on next app launch

### Expert settings

Display hidden ZIM archive selectors:
Display selectors for files and folders : only use this for downloading Wikivoyage in other languages. If you wish to open different ZIM files, you should instead download Kiwix JS from the Store, as this app is optimized for its packaged contents
Mathematical and chemical equations and symbols:
Typeset TeX equations with MathJax (recommended: very fast, but not all symbols supported in all languages; will use SVG fallbacks if TeX string not available) Use SVG fallback images (very slow and memory hungry, but will dislplay all symbols)
Content injection mode: do not touch unless you know what you're doing!
JQuery (slow and memory hungry, but safer) ServiceWorker (faster but unstable, and not supported by all platforms)
You can search the content of your ZIM archive by typing in the above search field.
It will suggest articles starting with the letters you type.