diff --git a/scripts/Kiwix_JS_Windows_E_Release_Body.md b/scripts/Kiwix_JS_Windows_E_Release_Body.md index 5c679fc4..ae1df8e0 100644 --- a/scripts/Kiwix_JS_Windows_E_Release_Body.md +++ b/scripts/Kiwix_JS_Windows_E_Release_Body.md @@ -1,14 +1,15 @@ ## Portable and installable builds of Kiwix JS for Windows XP/Vista/7/8/10 and Linux -This is **not** the UWP/Microsoft Store build. If you are using Windows 10, we strongly recommend [the Kiwix JS UWP release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html), which will keep itself up-to-date automatically. +This is **not** the UWP/Microsoft Store build. If you are using Windows 10, we strongly recommend [the Kiwix JS UWP release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html), which will keep itself up-to-date automatically. These portable and installable versions run on the included [Electron platform](https://www.electronjs.org/) version 10.4.0 and [NWJS](https://nwjs.io/) 0.53.0 (Win7/8/10) or 0.14.7 (XP/Vista). -These portable and installable versions runs on the included [Electron platform](https://www.electronjs.org/) version 10.4.0 and [NWJS](https://nwjs.io/) 0.53.0 (Win7/8/10) or 0.14.7 (XP/Vista). They are packaged with the <> sample ZIM of the top 100 Wikipedia articles in English, `<>`. The Windows builds run on any 32bit and 64bit i386/x64 machines (not ARM), while for Linux it is important to *choose the right build* (32bit or 64bit) for your machine (they have been tested on Ubuntu and Debian). +They are packaged with the <> sample ZIM of the top 100 Wikipedia articles in English, `<>`. These builds will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu and Debian). Choose the correct build: + * **Windows**: - **Portable** (just unzip, no install needed) - + Windows 7/8/10 - [Kiwix JS Windows <>.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/Kiwix.JS.Windows.<>.zip) (NWJS) - _recommended_ - + Windows XP/Vista - [Kiwix JS Windows <>.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/Kiwix.JS.Windows.<>.zip) (NWJS) + + Windows 7/8/10 - [kiwix-js-windows-<>-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/kiwix_js_windows-<>-win-ia32.zip) (NWJS) - _recommended_ + + Windows XP/Vista - [kiwix_js_windows-XP-<>-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/kiwix_js_windows-XP-<>-win-ia32.zip) (NWJS) - **Installable** (signed NSIS installer) + Windows 7/8/10 - [Kiwix JS Windows Setup <>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/Kiwix.JS.PWA.Setup.<>-E.exe) (Electron) * **Linux**: @@ -25,8 +26,8 @@ There is no installation required for the Portable versions. NONE of these build ### Instructions: -* For the Windows Portable build, unzip the contents of the [Kiwix JS Windows <>.zip archive](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/Kiwix.JS.Windows.<>.zip) to any folder, or to a flash drive / thumb drive, and double click on `Start Kiwix JS Windows` or `Start Kiwix JS Windows via batch file.bat`, or open the `kiwix-js-windows-win32-ia32` folder and double click on `nw.exe`; -* For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. When you want to update the app, uninstall it from "Add or Remove Programs". +* For the Windows Portable build, unzip the contents of the [kiwix_js_windows-<>-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/kiwix_js_windows-<>-win-ia32.zip) archive to any folder, or to a flash drive / thumb drive, and double click on `Start Kiwix JS Windows` or `Start Kiwix JS Windows via batch file.bat`, or open the `kiwix-js-windows-win32-ia32` folder and double click on `nw.exe`; +* For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. When you want to update the app, just install a new version over it (it will uninstall the old one for you). * For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn't work, open Terminal and run `chmod a+x Kiwix.JS.PWA*.AppImage` and then `./Kiwix.JS.PWA*.AppImage --no-sandbox`. You might be able to run without `--no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). * For the Linux installable builds, download the correct `.deb` package and double-click to see if your graphical package manager can install it. If not, open a terminal, `cd` to the directory containing the package, and type `sudo apt install ./kiwix-js-pwa*.deb`. Once installed, on Debian, you may have to run the app by opening terminal and typing `kiwix-js-pwa --no-sandbox`. On Ubuntu, you should be able to run it from its installed icon. * Windows: **Because the portable archive may not be commonly downloaded, you may face Windows SmartScreen issues** on first launch. Follow instructions to "Run anyway" if you trust this site. If you prefer, use the installable version [Kiwix JS Windows Setup <>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<>/Kiwix.JS.PWA.Setup.<>-E.exe) which is digitally signed. @@ -36,12 +37,14 @@ There is no installation required for the Portable versions. NONE of these build * This app is packaged with a sample atchive of the <> English-language top 100 Wikipedia articles (`<>`). The packaged archive is located in the `archives` folder (only accessible in the portable Windows version). See the readme in that folder if you wish to add a different archive as the packaged ZIM; * You can download many different archives in multiple languages from the Configuration page; * It supports dark mode, and opening different navigable windows by right-clicking or ctrl-clicking a link (see Configuration); -* You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print. +* You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print; +* You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link. ### Known Issues -* REGRESSION: Due to a change in format, headings are always open in jQuery mode regardless of the "Open all sections" option in Configuration (the setting is respected in Service Worker mode) -* INCONSISTENCY: When printing in jQuery mode, all sections are opened before printing (if the user had closed any), whereas in SW mode, closed sections are not opened before printing +* FIRST LAUNCH BUG: If you install over a previous build, you may get a message "Unable to locate picked archive" when you first launch. Simply relaunch the app and it should be able to find its updated packaged archive second time; +* REGRESSION: Due to a change in format, headings are always open in jQuery mode regardless of the "Open all sections" option in Configuration (the setting is respected in Service Worker mode); +* INCONSISTENCY: When printing in jQuery mode, all sections are opened before printing (if the user had closed any), whereas in SW mode, closed sections are not opened before printing; * On the XP build with some recent ZIMs (not the packaged one), __there is a CSS error in rendering the landing page of this ZIM__, due to the age of the Chromium build included in the runtime package. However, you can access all articles by __pressing a space in the search box__; * If you download an archive from within the app (from Configuration), you will be able to pick a download directory, and the download will start, but then there will be no further indication that a download is in progress. You will need to check the chosen download directory to see if the download has completed. * Please see https://github.com/kiwix/kiwix-js-windows/issues for further known issues. If you find a new issue, please open a new issue on that page.