NOTES
=====
* 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/
RELEASE NOTES: v0.5.2
=====================
v0.5.2 features the following:
* (add) Search syntax supports AND, OR, quotes; EX:http://en.wikipedia.org/wiki/Special:Search/Earth_AND_History?fulltext=y&search=Earth+AND+History {requested by Schnark}. See: [[Help:Special/Search]]
* (add) Version 2 category upgrade can be done through UI. See: [[Help:Core/Category/V2/Setup]]
* (add) Wiki import can read directly from bz2; no need to unzip to xml {requested by Schnark, Miles}. See: [[Help:Import/Data_dump_format]]
See the CHANGE LOG below for other changes specific to this release
REQUIREMENTS
============
* Java 1.6+
If you do not have Java 1.6 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)
INSTALL
=======
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
========
* 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 and 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
=======
* 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 to 1.7. See Requirements above.
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): "simple.wikipedia.org/wiki/World History", "simple.wikipedia.org/wiki/Chess", "simple.wikipedia.org/wiki/Gothic architecture", "simple.wikipedia.org/wiki/Saturn (planet)"
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:List of data dumps"
CHANGE LOG
==========
* (add) Option pages now supports checkboxes.
* (fix) nowiki should not apply to apostrophes; EX:http://en.wikipedia.org/wiki/Wiki; <nowiki>''a''</nowiki>.
* (fix) Table of contents would render bad html if first header is h3 or greater; EX:http://de.wikipedia.org/wiki/Zeichensatztabelle {detected by Schnark}.
* (fix) #property tag should return empty string if property is not found; EX:{{#property:p123456789|q=2}} {detected by Schnark}.
* (add) Command line arg for "--wiki_dir".
MD5s
====
8bf76b04d7a2dce63049bbe65e2389ad *xowa_app_linux_64_v0.5.2.0.zip
516fff00ce590da0bb91c5c617bb1e83 *xowa_app_linux_v0.5.2.0.zip
74690306e6964cf9cea3eb6a63dbea48 *xowa_app_macosx_v0.5.2.0.zip
e7e89e19aa38dc198a141af4bbaf60bc *xowa_app_windows_v0.5.2.0.zip
11c81e667a34faeedfb31b256742f9d1 *xowa_source_v0.5.2.0.7z
4a85e8ef41905d09521712f1f7cf7911 *xowa_upgrade_linux_64_v0.5.2.0.zip
3d349c171d3991ed48eac69343c93c31 *xowa_upgrade_linux_v0.5.2.0.zip
f966f658ecc15d6e65f75f38c8c2677a *xowa_upgrade_macosx_v0.5.2.0.zip
8812c2f7e567db1354bfa0ac3b6eb1f0 *xowa_upgrade_windows_v0.5.2.0.zip
Source: readme.txt, updated 2013-05-20