xowa Files

*************
RELEASE NOTES
*************
v2.6.3.1 features the following:

* Fix for images sometimes not being shown for v1 users.
* Mac OS X now defaults to WebKit instead of XULRunner.
* Fixes for highlight-all-words
* Support for Wikidata import by entities. See: [[Help:Import/Command-line/Wikidata]]
* More improvemens for XOWA droid. See: [[Help:Android/Alpha]]

See the CHANGE LOG below for a complete list of items specific to this release.

For more details about the release, see http://xowa.sourceforge.net/blog.html

*******
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.
    * xowa_upgrade_*** files can be applied to any release within the past month. For example, the xowa_upgrade_linux_v1.8.3.1 file can be used to upgrade from v1.7.3, v1.7.4, v1.8.1 or v1.8.2.
* 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
-------
If XOWA fails to launch after the steps below, please check the following:

* Administrator privileges: If you're on Windows Vista, 7, or 8, try running the program with administrator privileges. You can do so by right-clicking on the exe and choosing "Run as administrator"

* XULRunner: Try double-clicking the xulrunner.exe.
**    Go to C:\xowa\bin\windows_64\xulrunner (or on 32-bit machines, C:\xowa\bin\windows\xulrunner)
**    Double-click xulrunner.exe
**    You should get a message box that starts off with "Mozilla XUL Runner 10.0.10"
**    If it fails with "Can't start because MSVCR100.dll is missing...try reinstalling to fix...", then you will need to install the Visual C++ redistributable. See https://sourceforge.net/p/xowa/discussion/general/thread/cc7d867d/

* Arabic characters: XOWA cannot run in a folder with Arabic characters due to a limitation in one of its sub-components (SWT). For example, C:\موسوعات\XOWA will not work. On the other hand, C:\encyclopedia\XOWA will work. For more info, see https://bugs.eclipse.org/bugs/show_bug.cgi?id=443044.

* Java installation: Check that your Java installation is installed correctly
**    Open a command window by clicking on the Start button, selecting Run and typing in "cmd" (no quotes)
**    Type the following in the terminal window: "java -version" (no quotes)
**    It should report "java version "1.6****" or higher

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"

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"

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
**********
== major ==
* Gui: Default to WebKit if OS is Mac OS X (affects: Mac OS X installations and flaky XUL runner behavior (page sometimes going blank; hover not working)) {detected by anonymous4}.

== fix ==
* File: Fix images not working for v1 users after importing new wiki {detected by anonymous}.

== add ==
* Javascript.Find: Highlight all words after wrapping find {detected by gnosygnu.gui}.
* Javascript.Find: Highlight all words in the same element {detected by gnosygnu.gui}.
* Wikidata: Add command-line import for json dumps; EX:add     ('www.wikidata.org' , 'wbase.json_dump');. See: [[Help:Import/Command-line/Wikidata]] http://dumps.wikimedia.org/wikidatawiki/entities/

== change ==
* Parser.Xml: Add <q> to list of known xml elements (affects: many en.w pages with <q> instead of quotes) {detected by gnosygnu.gui}. See: https://en.wikipedia.org/wiki/Engine
* Scribunto.Regex: Convert "%w" to "\w" not "[\pL\pM\p{Nd}\p{Nl}\p{Pc}[\p{InEnclosedAlphanumerics}&&\p{So}]]" (requires JRE 1.7) (affects: many pages replacing correct category with [[Category:]]); EX:"Abc", "[^%w%p%s]", "" -> "Abc" x> "" {detected by gnosygnu.gui}. See: https://en.wikipedia.org/wiki/A♯_(musical_note) http://stackoverflow.com/questions/4304928/unicode-equivalents-for-w-and-b-in-java-regular-expressions

== significant ==
* Wikidata: Resolve property labels for statements (affects: qid names showing instead of pid); EX:398 -> "child astronomical body" (P398) x> "Bahrain" (Q398). See: https://www.wikidata.org/wiki/Property:P397
* Gui.Browser: Remove "about:blank" from location if webkit (affects: anchor links not working when using webkit); EX:#A x> "about:blank#A" {detected by anonymous4}.

== minor ==
* Html_dump: Detect content moved by tidy (affects: several en.w pages with broken links); EX:<font color='green'>[[A]]</font> -> <a href='/wiki/A'><font color='green'>A</font></a> {detected by gnosygnu.gui}. See: https://en.wikibooks.org/wiki/Abyssal_plain
* Doc: Update Inkscape link from 0.48.4 to 0.48.5 {detected by Anselm}.

== trivial ==
* Wikidata: Add "newiki" to list of known wikis {detected by gnosygnu.build.warning}. See: /bin/any/xowa/cfg/wiki/wmf_data.sqlite3
* Wikidata: Handle keyval of "datatype" (affects: warnings in log file) {detected by gnosygnu.gui.warning}. See: https://www.wikidata.org/wiki/Property:P397

== dev ==
* Database: Add tbl_exists method.


****
MD5s
****
92e2a01e22d1e913442e5c9267e37143 *xowa_app_linux_64_v2.6.3.1.zip
49c0b3021181ae6452f23d7acf62df10 *xowa_app_linux_v2.6.3.1.zip
140a394b558d4b3db87506753d3b0c55 *xowa_app_macosx_64_v2.6.3.1.zip
633a90fe59dec96daae1f320ff93761e *xowa_app_macosx_v2.6.3.1.zip
37dbecc3fb4bef8c816480657756002f *xowa_app_windows_64_v2.6.3.1.zip
97cd07afe6bc9b91aa668fd177f167b4 *xowa_app_windows_v2.6.3.1.zip
b317ef97506e37a1943995b772c38148 *xowa_source_v2.6.3.1.7z
649a32ea965196768802346c90951ead *xowa_upgrade_linux_64_v2.6.3.1.zip
00ec32c34d5d0581e23de635d80e91af *xowa_upgrade_linux_v2.6.3.1.zip
1228a85a14a84f99efbf5b07d51fce1d *xowa_upgrade_macosx_64_v2.6.3.1.zip
ad800469207b888f57651ddd968a1780 *xowa_upgrade_macosx_v2.6.3.1.zip
16439dc1f00cffb874b89a6a92761081 *xowa_upgrade_windows_64_v2.6.3.1.exe
d482c43b146df8603b7862e24ebad6ff *xowa_upgrade_windows_v2.6.3.1.exe