*************
RELEASE NOTES
*************
v1.3.3.1 features the following:
* Offline images for Ukrainian Wikipedia 2014-03-05 and sister wikis
* New luaj implementation for Scribunto. See: [[Help:Options/Scribunto]]
See the CHANGE LOG below for a complete list of items specific to this release.
*******
CONTACT
*******
XOWA's website is at http://xowa.sourceforge.net/
If you encounter issues, please post to https://sourceforge.net/p/xowa/discussion/
*******
INSTALL
*******
FILES
=====
* There are two types of files:
* The xowa_app_*** files are for new users. They will have all the files necessary for xowa to run, including the main jars, XulRunner, languages, etc..
* The xowa_upgrade_*** files are for upgrade users. They will have the xowa jar and any other files specific to the release.
Note that upgrade users can also download the xowa_app_*** files and unzip it over their current version. The xowa_upgrade_*** files are provided as a convenience.
* The paths below are recommendations. Please feel free to choose any other.
* If you've received the readme.txt offline, all files are at https://sourceforge.net/projects/xowa/files/
REQUIREMENTS
============
* Java 1.7+
If you do not have Java 1.7 installed, then please install 1.7 from http://www.java.com/en/download/manual.jsp
On Ubuntu Linux, you can use OpenJDK by running 'sudo apt-get install openjdk-7-jre'.
* Compression/Decompression program ("unzip")
The XOWA files will be compressed. If your Operating System does not natively support decompressing, please install 7-Zip from http://7-zip.org.
* 512 MB RAM
XOWA can run on lower memory machines, but 256 MB is needed for importing the larger wikis (EX: en.wikipedia.org; commons.wikimedia.org)
Linux
-----
* Download 'xowa_app_linux_v*.*.*.*.zip'
* Unzip to '/home/your_user_name/xowa/'. When you are done you should have a file called '/home/your_user_name/xowa/xowa_linux.jar' as well as many others
* Open a terminal and run "sh /home/your_user_name/xowa/xowa_linux.sh"
* If "xowa_linux.sh" doesn't work, run "java -Xmx256m -jar /home/your_user_name/xowa/xowa_linux.jar"
Mac OS X 64-bit
---------------
* Download 'xowa_app_macosx_64_v*.*.*.*.zip'
* Unzip to '/Users/your_user_name/xowa/'. When you are done you should have a file called '/Users/your_user_name/xowa/xowa_macosx_64.jar' as well as many others
* Open a terminal by doing Finder -> Applications -> Utilities -> Terminal
* Run "sh /Users/your_user_name/xowa/xowa_macosx_64.sh"
If you get a "No Java runtime present" you will need to set up Java on your machine. There are two options:
* Update to the latest Java 6 by going to http://support.apple.com/kb/DL1572?viewlocale=en_US
This will be simpler. However, note that Java 6 is an older obsolete version.
* Download Java 7 by going to java.com
This will be the most up-to-date Java version. However it requires additional steps.
* Find your java runtime: Run "/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/bin/java -version" in the terminal to verify the path
* Assuming your java is at the above location, run XOWA by doing either of the following
(1) Run the following from the terminal:
/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/bin/java -Xmx256m -XstartOnFirstThread -Xdock:name=XOWA /Users/your_user_name/xowa/xowa_macosx_64.jar
(2) Change your official java to the plugin version and then run xowa_macosx_64.sh
sudo ln -fs /Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/bin/java /usr/bin/java
NOTE: if the XOWA menu bar is not clickable, alt-tab to the terminal and back to XOWA. The menu bar will then be usable
Mac OS X 32-bit
---------------
* Download 'xowa_app_macosx_v*.*.*.*.zip'
* Unzip to '/Users/your_user_name/xowa/'. When you are done you should have a file called '/Users/your_user_name/xowa/xowa_macosx.jar' as well as many others
* Open a terminal by doing Finder -> Applications -> Utilities -> Terminal
* Run "sh /Users/your_user_name/xowa/xowa_macosx.sh"
* If "xowa_macosx.sh" doesn't work, run "java -Xmx256m -d32 -XstartOnFirstThread -jar /Users/your_user_name/xowa/xowa_macosx.jar"
Windows 32-bit
--------------
* Download 'xowa_app_windows_v*.*.*.*.zip'
* Unzip to 'C:\xowa'. When you are done you should have a file called 'C:\xowa\xowa.exe' as well as many others
* Double-click 'xowa.exe'
* If 'xowa.exe' fails to launch, you can also try double-clicking 'xowa_windows.jar'
* If double-clicking doesn't work, you can also try the following:
** Start -> Run > "cmd"
** Enter "java -Xmx256m -jar C:\xowa\xowa_windows.jar"
* If XOWA still fails to launch, your Java installation may need to be reinstalled or upgraded. See Requirements above.
Windows 64-bit (using 64-bit JRE)
---------------------------------
* Download 'xowa_app_windows_64_v*.*.*.*.zip'
* Unzip to 'C:\xowa'. When you are done you should have a file called 'C:\xowa\xowa_64.exe' as well as many others
* Double-click 'xowa_64.exe'
* If 'xowa_64.exe' fails to launch, you can also try double-clicking 'xowa_windows_64.jar'
* If double-clicking doesn't work, you can also try the following:
** Start -> Run > "cmd"
** Enter "java -Xmx256m -jar C:\xowa\xowa_windows_64.jar"
* If XOWA still fails to launch, your Java installation may need to be reinstalled or upgraded to 1.7. See Requirements above. You can also try using a 32-bit JRE
Windows 64-bit (using 32-bit JRE)
---------------------------------
* Download 'xowa_app_windows_v*.*.*.*.zip'
* Unzip to 'C:\xowa'. When you are done you should have a file called 'C:\xowa\xowa.exe' as well as many others
* Visit http://www.oracle.com/technetwork/java/javase/downloads/index.html
* Click the "Download" button under "JRE"
** Choose the Windows x86 version
*** As of the time of this writing, "Windows x86 Offline" links to http://download.oracle.com/otn-pub/java/jdk/7u40-b43/jre-7u40-windows-i586.exe
** Choose an installation folder. For example, "C:\Program Files (x86)\Java\jre7_x86"
** After installing, run the following in cmd: "C:\Program Files (x86)\Java\jre7_x86\bin\java" -Xmx256m -jar C:\xowa\xowa_windows.jar
*****
USAGE
*****
Setting up Simple Wikipedia
===========================
* Once XOWA loads, you will see the Main Page
* Click the link for "Set up Simple Wikipedia". Wait about 3 minutes for the wiki to download and install. When it is finished, it will open Simple Wikipedia
* Browse Simple Wikipedia. When you are done, click on the Main Page link under XOWA in the left hand navigation bar.
Setting up images
=================
* Click the link for "Set up images (Windows)". Wait about 3 minutes for the image programs to install.
* Open the "Wikis" list in the sidebar and click on "simple.wikipedia.org"
* Images will now download for the Main Page. They will automatically download for any page you visit.
Here are some example pages to visit (you can copy and paste these into the address bar):
http://simple.wikipedia.org/wiki/Gothic_architecture
http://simple.wikipedia.org/wiki/Saturn_(planet)
http://simple.wikipedia.org/wiki/Chess
http://simple.wikipedia.org/wiki/World_History
Setting up other wikis
======================
* If you want to try any other wiki, click on "list of data dumps" on the XOWA Main Page. You can also navigate to "Help:Import/List"
Downloading offline thumbs
==========================
* If you want to download a complete set of images for your wiki, see the following links:
** For instructions, see: http://xowa.sourceforge.net/setup_simplewiki.html and http://xowa.sourceforge.net/setup_enwiki.html
** For a list of image databases see http://xowa.sourceforge.net/image_dbs.html or https://archive.org/search.php?query=xowa
**********
CHANGE LOG
**********
=== package ===
* Package: Release Ukrainian Wikipedia 2014-03-06 offline images.
* Package: Release Ukrainian Wikis (excluding Wikipedia).
* Package: Release English Wikipedia 2014-03-04 update.
=== major ===
* Scribunto: Add luaj as alternate lua engine. See: [[Help:Options/Scribunto]]
=== minor ===
* Wikisource.Page: Allow recursive #section calls. See: https://it.wikisource.org
* Parser.Pre: Ignore pre in gallery; EX:“\n\s<gallery>”. See: https://uk.wikipedia.org/wiki/ЕР2
* Parser.Pre: Ignore pre in center; EX:"\n\s<center>. See: https://uk.wikipedia.org/wiki/ЕР2
* Parser.Link: Parse "\n|" in link as link separator, not table cell; EX:[[File:A.png|150px\n|B]]. See: https://uk.wikipedia.org/wiki/Дніпро
* Parser.Xml: Do not render html entities literally within <source> tag; EX:<source><</source> -> &< not <. See: https://uk.wikibooks.org/wiki/HTML
* Parser.Xml: Ignore empty <pre>; EX:<pre></pre>. See: https://uk.wikibooks.org/wiki/HTML
* Parser.Tblw: Force |} to close link; EX:[[A\n|}. See: https://en.wikipedia.org/wiki/Wikipedia:Changing_attribution_for_an_edit
* Lang: Fix broken zh-hant; EX:/user/anonymous/lang/xowa/zh-hant.gfs. See: http://commons.wikimedia.org/wiki/Category:Mona_Lisa
* Gui: Change message box prompt from "yes" to "ok" {detected by Anselm}. See: [[Help:Import/Script]]
=== trivial ===
* MassMailing: Add basic implementation for #target function. See: https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Articles_for_creation/Participants/Message
=== dev ===
* Scribunto: Refactor Scribunto code.
****
MD5s
****
47bd56191ad6725e953cc00b5591d71e *xowa_app_linux_64_v1.3.3.1.zip
ae3214107a071cc05d19b398df6880b0 *xowa_app_linux_v1.3.3.1.zip
5b9568282707efb9ff6204379c30cc2e *xowa_app_macosx_64_v1.3.3.1.zip
8744e624b6126b163611300d5c7769b0 *xowa_app_macosx_v1.3.3.1.zip
a432347cba2ecc77a34e0de79f3756bd *xowa_app_windows_64_v1.3.3.1.zip
147dc423d3a0d0820ffe825073d23ba7 *xowa_app_windows_v1.3.3.1.zip
db4980e0ea211fff41eb42c2663ebe4e *xowa_source_v1.3.3.1.7z
7df249b270366db1d1dd42dc76750f70 *xowa_upgrade_linux_64_v1.3.3.1.zip
a2e98e75f8adbb5245869d55b20710a0 *xowa_upgrade_linux_v1.3.3.1.zip
eb287b989191e5d30d22b653e153d09f *xowa_upgrade_macosx_64_v1.3.3.1.zip
9eeb918409ad6452b2ec2e4eb4e8547f *xowa_upgrade_macosx_v1.3.3.1.zip
f8a036409347a64025d875a717efe53e *xowa_upgrade_windows_64_v1.3.3.1.exe
47d5fc3cae2c666764175111c583e5e0 *xowa_upgrade_windows_v1.3.3.1.exe
