diff --git a/wiki/home/page/App/Import/Download/Aria2.html b/wiki/home/page/App/Import/Download/Aria2.html new file mode 100644 index 000000000..929faa2a8 --- /dev/null +++ b/wiki/home/page/App/Import/Download/Aria2.html @@ -0,0 +1,124 @@ + + + + + App/Import/Download/Aria2 - XOWA + + + + + +
+
+
+

App/Import/Download/Aria2

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ aria2 is an open-source application to simplify downloading files. +

+

+ Usage +

+
    +
  • + Place all files in a text file. For example: xowa_image_download_https.txt +
  • +
+
+
+ Note that line endings don't matter. Text files with Windows CRLF will also work on Linux systems like Ubuntu +
+
+
    +
  • + Use the following command-line to start: +
  • +
+
+
+ aria2c --save-session=xowa_image_download_https.txt --input-file=xowa_image_download_https.txt +
+
+
    +
  • + Stop it with Ctrl-C, and resume at a later time. Note that resume information is added to the text file (in this case xowa_image_download_https.txt) +
  • +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Download/Dump_servers.html b/wiki/home/page/App/Import/Download/Dump_servers.html new file mode 100644 index 000000000..4ea2e778b --- /dev/null +++ b/wiki/home/page/App/Import/Download/Dump_servers.html @@ -0,0 +1,125 @@ + + + + + App/Import/Download/Dump servers - XOWA + + + + + +
+
+
+

App/Import/Download/Dump servers

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ Dump servers +

+

+ The list of dump servers is from http://meta.wikimedia.org/wiki/Mirroring_Wikimedia_project_XML_dumps +

+ +

+ your.org +

+

+ your.org is the default dump server. This mirror happens to be significantly faster than the official Wikimedia dump server. There was also a recent post on xmldatadumps-l that requested mirror server usage over the official ones: http://lists.wikimedia.org/pipermail/xmldatadumps-l/2012-December/000644.html +

+

+ Changing the dump server +

+

+ Please see Options/Import +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/English_Wikipedia.html b/wiki/home/page/App/Import/English_Wikipedia.html new file mode 100644 index 000000000..bd4fde6ea --- /dev/null +++ b/wiki/home/page/App/Import/English_Wikipedia.html @@ -0,0 +1,304 @@ + + + + + App/Import/English Wikipedia - XOWA + + + + + +
+
+
+

App/Import/English Wikipedia

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ + +

+ Overview +

+

+ English Wikipedia has a lot of data. There are 16.0+ million pages with 22.0+ GB of text, as well as 4.25+ million thumbnails. +

+

+ Setting all this up on your computer will not be a quick process. As a general estimate, you will need about 30 GB and 5 hours processing time. If you want images as well, the numbers increase to 100 GB of disk space and 30+ hours of processing time. However, when you are done, you will have a complete, recent copy of English Wikipedia with images that can fit on a 128 GB SD card. +

+

+ Although the process itself is not hard, I strongly recommend that you try Simple Wikipedia first. Simple Wikipedia has 180,000 pages and 90,000 images. The text version uses 200 MB and sets up in 5 minutes. With images, this expands to 2 GB and 30 minutes of downloading time. Simple Wikipedia is a reasonably accurate simulation of English Wikipedia -- just much smaller. It'll also give you a pretty good idea of what XOWA can do. +

+

+ Part 1: Set up the wiki +

+

+ The first part is to set up the wiki. You have two approaches for this part: import the wiki with XOWA or download a copy from the internet. +

+

+ Option 1: Import the wiki with XOWA +

+

+ Overview +

+
    +
  • + XOWA will download the database dump from the Wikimedia backup servers +
  • +
  • + The database dump will be 10+ GB and take about 3 hours to download +
  • +
  • + XOWA will take about 2.5 hours to build the wiki. The final wiki will use about 20 GB of disk space.[1] +
  • +
+

+ Steps +

+
    +
  • + Launch XOWA +
  • +
  • + Use the menu bar and select Tools -> Import Online +
  • +
  • + Find en.wikipedia.org +
  • +
  • + Click on the "download" link to the left. +
  • +
+

+ That's it. The import process has now started. This part takes at least 5 hours so you may want to let it run for a while. When it's done, it will automatically load the Main Page. +

+

+ Option 2: Download the wiki from archive.org +

+

+ Overview +

+
    +
  • + The download will be approximately 20 GB. +
  • +
  • + When the download is completed, extract the files to C:\xowa\wiki\en.wikipedia.org +
  • +
+

+ Steps +

+
    +
  • + Download the file from here +
  • +
  • + After the download completes, unzip the archive file in C:\xowa\. When you are done you should have a file like C:\xowa\wiki\en.wikipedia.org\en.wikipedia.org-core.xowa +
  • +
  • + Launch XOWA +
  • +
  • + Enter "w:" in the address bar. The Main_Page should load. +
  • +
+

+ Part 2: Download the images +

+

+ This part takes much longer to complete. It will require at least 70 GB of disk space and 24+ hours of download time. You'll be downloading compressed files from archive.org. +

+

+ Steps +

+
    +
  • + Go to https://archive.org/details/Xowa_enwiki_latest +
  • +
  • + Download each of the listed links marked image +
  • +
  • + Extract the files to C:\xowa\. When you are done, you will have files from C:\xowa\wiki\en.wikipedia.org\en.wikipedia.org-file-ns.000-db.001.xowa to C:\xowa\wiki\en.wikipedia.org\en.wikipedia.org-file-ns.000-db.023.xowa as well as several others +
  • +
+

+ Updating English Wikipedia +

+

+ Wikipedia is constantly updating. New pages are added, and existing pages are changed to include different images. The above steps will give you a complete set of images for 2015-04-03. However, if you want to stay up to date with Wikipedia, then you may also want to download the monthly updates. +

+

+ Monthly updates will be posted at the same url: https://archive.org/details/Xowa_enwiki_latest There will be a new link with the name of the wiki dump: for example: 2015-05-02. They will have new images introduced in the Wikipedia dump for that month. Note that these updates should be downloaded and unzipped in order (i.e.: first 2015-05-02, then 2015-06-02, etc). There are some files that appear in multiple sets: the most recent copy of the file should always replace the earlier version. +

+

+ Note that if you update your wiki, you do not have to update the images. The two are independent of each other. In other words, you can use the 2017-01-01 English Wikipedia xml dump with the 2015-04-03 English Wikipedia images. Note that new images in the 2017-01-01 dump will not show up until you download the appropriate monthly updates. +

+

+ Disk space usage +

+

+ Some may wonder why XOWA needs so much disk space, especially when compared to other apps. The following is a brief list of reasons: +

+
    +
  • + XOWA is complete. It includes all articles across all namespaces, including the Wikipedia namespace, the Portal namespace, the Help namespace, and several others. It also includes redirect stubs. Other apps will only provide articles in the Main namespace. +
  • +
  • + XOWA includes Categories as well. Other apps will skip Categories altogether. +
  • +
  • + XOWA shows all content on the page. Other apps will omit sections, such as Table of Contents or Navigation boxes at the bottom of the page. +
  • +
  • + XOWA includes all images for the Main namespace, the Portal namespace and the Wikipedia namespace. Other apps will only provide images for the Main namespace +
  • +
  • + XOWA shows the actual image from Wikimedia. Other apps will use a scaled down version of the image (72 dpi instead of 300 dpi) +
  • +
  • + XOWA provides an accurate sized thumbnail for an article. If an article shows an 800 pixel wide image, XOWA shows an 800 pixel wide image. Other apps will actually show a smaller 220 pixel wide image. +
  • +
  • + XOWA includes the latest content. Other apps may be many months (if not years) behind. +
  • +
+

+ Notes +

+
    +
  1. + ^ Note that when the import completes, it will move the 10 GB file to /xowa/wiki/#dump/done. This file can be deleted safely. Note that XOWA doesn't delete the file, as some users may want to keep the 10 GB file around for archival purposes, and redownoading 10 GB would be time-consuming. +
  2. +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Image_databases/Pruning.html b/wiki/home/page/App/Import/Image_databases/Pruning.html new file mode 100644 index 000000000..0a5d9902e --- /dev/null +++ b/wiki/home/page/App/Import/Image_databases/Pruning.html @@ -0,0 +1,167 @@ + + + + + App/Import/Image databases/Pruning - XOWA + + + + + +
+
+
+

App/Import/Image databases/Pruning

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ XOWA's image databases will accumulate old images and take up unnecessary disk space. This page outlines the process to prune these old images +

+

+ Background +

+

+ XOWA releases monthly updates of English Wikipedia images. However, every month, English Wikipedia removes many old images. Over time, the removed images will cause XOWA's image databases to grow larger than necessary. +

+

+ As of 2014-07-07, XOWA's image database for English Wikipedia was 92 GB. It should be 68 GB. +

+

+ If you want to reduce your image database size for English Wikipedia, you can try either of the two options below. +

+

+ Option 1: Download the updated set +

+

+ The simplest approach is to download the latest set. Note that this will require downloading approximately 62 GB of compressed data. Users who have bandwidth issues (caps / low connectivity) may want to look at the next option. +

+

+ Option 2: Prune the images manually +

+

+ Note the following: +

+
    +
  • + This is an advanced step that requires command-line usage +
  • +
  • + It will take anywhere between 2 and 10 hours depending on your machine's speed +
  • +
  • + It works by runing about 200 .sql files on over 90 GB of databases +
  • +
  • + It is the exact same process I used to generate the update set above. +
  • +
+

+ The following steps are required: +

+
    +
  • + Download the Xowa_enwiki_2014-07-07_prune.7z file at https://archive.org/details/Xowa_enwiki_latest Note that the .7z file is 3 MB. +
  • +
  • + Unzip them to your XOWA root directory. When you are done, you will have a file called /xowa/file/en.wikipedia.org/tmp_sql/en.wikipedia.org-000-atr.sql as well as many others +
  • +
  • + Create a xowa_prune.gfs file in your xowa root with the following text. Note that the file must have UNIX style new lines (Windows users should use a text editor like Notepad++) +
  • +
+
+app.bldr.pause_at_end_('n');
+app.scripts.run_file_by_type('xowa_cfg_app');
+app.bldr.cmds {
+  add     ('en.wikipedia.org' , 'file.diff_regy.exec');
+}
+app.bldr.run;
+
+
    +
  • + Open up the command line and run the following (change xowa_windows.jar as per your Operating System): +
  • +
+
+java -Xmx256m -jar xowa_windows.jar --cmd_file xowa_prune.gfs --app_mode cmd
+
+

+ If you run into problems, feel free to contact me as per Help/Feedback +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Manual.html b/wiki/home/page/App/Import/Manual.html new file mode 100644 index 000000000..c19a6c0c9 --- /dev/null +++ b/wiki/home/page/App/Import/Manual.html @@ -0,0 +1,174 @@ + + + + + App/Import/Manual - XOWA + + + + + +
+
+
+

App/Import/Manual

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ Reasons for manual import +

+

+ The list of data dumps allows you to download dumps for any wiki with one mouse click. However, there are times when you want to manually import a wiki: +

+
    +
  • + You want a dump from a specific time period (EX: 20121220) +
  • +
  • + You want the dump that has talk pages (EX: pages-meta-current) +
  • +
  • + You want a dump that doesn't happen to be on the list (EX: none known, but may happen) +
  • +
  • + You want to customize the process for multiple wikis +
  • +
  • + You encountered an error, and can not use the automated process. +
  • +
+

+ Manual import types +

+

+ There are currently two ways to do a manual import +

+
    +
  • + Manually import the wiki through xowa_build.gfs. +
  • +
+
+
+ This will offer you the greatest flexibility, but requires some familiarity with a command-line interface. You can read more at Dev/Command-line +
+
+
    +
  • + Manually import the wiki through altering the xowa_command +
  • +
+
+
+ This has less flexibility than the xowa_build.gfs. However, it only requires editing a wiki page, and then clicking the icon +
+
+

+ Manual import using the xowa_command +

+

+ To do a manual import using the xowa_command, do the following +

+
    +
  • + Click "Edit" in the top right-hand corner +
  • +
  • + Look at the last lines of this page +
  • +
  • + Substitute 'simple.wikipedia.org' with your wiki's name +
  • +
  • + Change the date from 'latest' to whatever date you're interested in (EX: '20121220') +
  • +
  • + Change 'pages-articles' to 'pages-meta-current' if you want talk pages (Note: they are generally twice the size of the regular wiki) +
  • +
  • + Save the page +
  • +
  • + Click "Setup Custom Wiki" +
  • +
+
+ Setup Custom Wiki ⊗ +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Offline.html b/wiki/home/page/App/Import/Offline.html new file mode 100644 index 000000000..5f6cd6fa3 --- /dev/null +++ b/wiki/home/page/App/Import/Offline.html @@ -0,0 +1,127 @@ + + + + + App/Import/Offline - XOWA + + + + + +
+
+
+

App/Import/Offline

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ If you've downloaded a dump already, you can import the .bz2 file into XOWA. +

+

+ Import through Dashboard/Import/Offline +

+ +

+ Import through Dashboard/Import/Online +

+
    +
  • + Place the dump file in the wiki's directory. For example, if you have a "simplewiki" dump, put it in /xowa/wiki/simple.wikipedia.org/ +
  • +
+
    +
  • + Rename the dump to "simplewiki-latest-pages-articles.xml.bz2". The final path should be "/xowa/wiki/simple.wikipedia.org/simplewiki-latest-pages-articles.xml.bz2" +
  • +
+ +
    +
  • + You will get a prompt about the file already existing. Answer "No" (do not delete the file). +
  • +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Other_wikis.html b/wiki/home/page/App/Import/Other_wikis.html new file mode 100644 index 000000000..778c7c74c --- /dev/null +++ b/wiki/home/page/App/Import/Other_wikis.html @@ -0,0 +1,209 @@ + + + + + App/Import/Other wikis - XOWA + + + + + +
+
+
+

App/Import/Other wikis

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ + +

+ Overview +

+

+ Other Wikipedias will follow the same process as setting up Simple Wikipedia or English Wikipedia. The steps are summarized below, but you should read both Help:Set up Simple Wikipedia and Help:Set up English Wikipedia +

+

+ Note that some Wikipedias will require a lot of disk space. For example, German Wikipeda requires at least 40 GB. Depending on your location it may take several hours to download that much data. Please prepare accordingly. +

+

+ Part 1: Set up the wiki +

+

+ The first part is to set up the wiki. The set-up process involves the following steps: +

+
    +
  • + XOWA will download the database dump from the Wikimedia backup servers +
  • +
  • + The database dump will be multiple GBs and take several hours to download +
  • +
  • + XOWA will take about an hour to build the wiki and produce a wiki 2 times the dump size. For example, German Wikipedia's dump is currently about 3 GB, so XOWA will generate a 6 GB wiki +
  • +
+

+ To begin the process, do the following +

+
    +
  • + Launch XOWA +
  • +
  • + Use the menu bar and select Tools -> Import From List. +
  • +
  • + Find your wiki's name in the list. +
  • +
  • + Click on the "download" link to the left. +
  • +
+

+ The import process will start. When it's done, it will automatically load the Main Page. +

+

+ Part 2: Download the images +

+

+ This part usually takes much longer to complete. It will require many GB of disk space and many hours of download time. For example, German Wikipedia takes up 32 GB and may take 16 hours to download. +

+

+ When you're ready to start, do the following: +

+
    +
  • + Go to the download page +
  • +
  • + Find your wiki in the list and click on the link +
  • +
  • + Download the files from archive.org. +
  • +
  • + Unzip the files in your xowa root directory. When you are done, you will have a file called C:\xowa\wiki\de.wikipedia.org\de.wikipedia.org-file-ns.000-db.001.xowa as well as many others. +
  • +
  • + Launch XOWA +
  • +
  • + Enter "home/wiki/Help:Options/Files" into the address bar. +
  • +
  • + Make sure "Retrieval enabled" is checked. +
  • +
  • + Visit any page. All the images for this page will load. +
  • +
+

+ Updating the wiki +

+

+ If you want to update your wiki, you won't have to repeat the whole process. +

+
    +
  • + If you update your wiki, you do not have to update the images. The two are independent of each other. Note that a later wiki dump may cite images not in the current XOWA image dump. These images won't show until you download the latest monthly update. +
  • +
  • + XOWA will update images every few months. If you would like an update earlier, please post at https://sourceforge.net/p/xowa/discussion/general/thread/67c4cdb5/ +
  • +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Overview.html b/wiki/home/page/App/Import/Overview.html new file mode 100644 index 000000000..fc72d141c --- /dev/null +++ b/wiki/home/page/App/Import/Overview.html @@ -0,0 +1,135 @@ + + + + + App/Import/Overview - XOWA + + + + + +
+
+
+

App/Import/Overview

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ XOWA provides several options to import a wiki. +

+

+ Import online by click +

+

+ The Dashboard/Import/Online page lists 800+ wikis that can be imported by clicking on a link. +

+
    +
  • + Simple: Find a wiki, click on it, and it will be imported. +
  • +
  • + Online: Intended for users who have internet access. +
  • +
+

+ Import offline by script +

+

+ The Dashboard/Import/Offline page can generate a script that will import a wiki. +

+ +

+ Import by command-line +

+

+ The Dev/Command-line page offers instructions on importing through the command-line. +

+
    +
  • + Full control: Offers full control of the XOWA import process +
  • +
  • + Complicated: Requires command-line usage. Intended for advanced users. +
  • +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Removal.html b/wiki/home/page/App/Import/Removal.html new file mode 100644 index 000000000..f1d62acd8 --- /dev/null +++ b/wiki/home/page/App/Import/Removal.html @@ -0,0 +1,119 @@ + + + + + App/Import/Removal - XOWA + + + + + +
+
+
+

App/Import/Removal

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ Removing wikis +

+

+ Wikis can be removed by deleting specific folders on the file system. +

+

+ For example, to remove Simple Wikipedia. +

+
    +
  • + Delete the wiki directory under C:\xowa\wiki\simple.wikipedia.org +
  • +
  • + Delete the css directory under C:\xowa\user\anonymous\wiki\simple.wikipedia.org +
  • +
  • + Delete the files directory under C:\xowa\file\simple.wikipedia.org +
  • +
+

+ Note that there may also be images in your commons directory which can only be removed by deleting the entire directory: C:\xowa\file\commons.wikimedia.org +

+

+ For example, if you have viewed the Earth article in Simple Wikipedia you will have downloaded the The Earth seen from Apollo 17.jpg to C:\xowa\file\commons.wikimedia.org not to C:\xowa\file\simple.wikipedia.org. Note that commons is the destination because the actual online url for the image is https://commons.wikimedia.org/wiki/File:The Earth seen from Apollo 17.jpg. +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Shrinking.html b/wiki/home/page/App/Import/Shrinking.html new file mode 100644 index 000000000..b0dec3d43 --- /dev/null +++ b/wiki/home/page/App/Import/Shrinking.html @@ -0,0 +1,117 @@ + + + + + App/Import/Shrinking - XOWA + + + + + +
+
+
+

App/Import/Shrinking

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ This article explains how to reduce disk space for a wiki. It will focus on English Wikipedia, but the same steps apply to any other wiki. +

+

+ BZ2 file +

+

+ The main BZ2 file takes 9 GB. This BZ2 file is located wherever you downloaded it. +

+

+ This file is not used by XOWA, and can be removed from the system. +

+

+ If you are using the automated set up from Dashboard/Import/Online, the BZ2 file is moved to /xowa/wiki/#done. XOWA does not delete this file in case the user wants to re-import the wiki, and avoid redownloading the entire file. +

+

+ Namespace removal +

+

+ You can prune entire namespaces. For example, some users may not be interested in the Wikipedia namespace as it contains mostly meta-information about Wikipedia. The namespace itself is about 3.0 GB. +

+

+ To remove this namespace, you can delete the entire namespace db. The file would be en.wikipedia.org-text-ns.004.xowa +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Import/Simple_Wikipedia.html b/wiki/home/page/App/Import/Simple_Wikipedia.html new file mode 100644 index 000000000..0fffbf75b --- /dev/null +++ b/wiki/home/page/App/Import/Simple_Wikipedia.html @@ -0,0 +1,159 @@ + + + + + App/Import/Simple Wikipedia - XOWA + + + + + +
+
+
+

App/Import/Simple Wikipedia

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ + +

+ Overview +

+

+ Simple Wikipedia is a smaller wiki with 180,000+ pages and 90,000+ images. The text version can be setup in less than 5 minutes, using only 200 MB of disk space. The images version is a little larger: it needs 30 minutes of download time and 2 GB of space. +

+

+ Part 1: Import the wiki +

+
    +
  • + Launch XOWA +
  • +
  • + Find the link for "Set up Simple Wikipedia" near the middle of the Main Page. +
  • +
  • + Click on it. The import process will start and should complete within 5 minutes. +
  • +
  • + Visit different pages in Simple Wikipedia. Note that XOWA shows images for the pages by dynamically downloading the images online. +
  • +
+

+ Part 2: Download all the images for offline viewing +

+
    +
  • + Download the file zip from archive.org: https://archive.org/details/Xowa_simplewiki_latest +
  • +
  • + Unzip the files in your xowa root directory. When you are done, you will have a file called C:\xowa\simple.wikipedia.org\simple.wikipedia.org-file.xowa as well as many others.[1] +
  • +
  • + Visit any page in Simple Wikipedia. All images will now be loading from the offline databas. +
  • +
+

+ Notes +

+
    +
  1. + ^ This bundle also has Simple Wiktionary, Simple Wikiquote and Simple Wikibooks +
  2. +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/Flash_card.html b/wiki/home/page/App/Setup/Flash_card.html new file mode 100644 index 000000000..bbd5bb4d7 --- /dev/null +++ b/wiki/home/page/App/Setup/Flash_card.html @@ -0,0 +1,181 @@ + + + + + App/Setup/Flash card - XOWA + + + + + +
+
+
+

App/Setup/Flash card

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ XOWA is designed to be portable. It can be stored on a flash memory card, and run from other machines. In theory you can take the same flash memory card and run it from Windows, Linux, and Mac OS X. +

+

+ XOWA can be installed to a flash memory card simply by copying the entire root directory to it. For example, if you've set up XOWA on C:\xowa and your flash memory card is on X: then just copy C:\xowa to X:\xowa +

+
+
+

+ Contents +

+
+ +
+

+ Standalone JRE +

+

+ XOWA can use a standalone JRE for Windows machines. This allows zero-install launches of XOWA from an flash-memory card on any Windows machine - regardless of whether or not Java is installed. +

+

+ Setup +

+

+ The standalone JRE can be set up in the following way: +

+
    +
  • + Find the Java JRE. For example, on Windows, C:\Program Files\Java\ +
  • +
  • + Copy the folder to XOWA's bin directory for your OS. For example, if you're on Windows 64-bit and your XOWA is set up on an external drive at X:\xowa, copy it to X:\xowa\bin\windows_64\java\jre. When you're done you should have a file called X:\xowa\bin\windows_64\java\jre\bin\java.exe as well as many others +
  • +
  • + Plug the external drive into a Windows machine without Java installed +
  • +
  • + Double-click xowa_64.exe. XOWA will launch using the copied JRE +
  • +
+

+ If you want the same flash-drive to work on Windows 32-bit machine, then you need to do the following +

+
    +
  • + Download a 32-bit JRE +
  • +
  • + Copy the folder to XOWA's bin directory: X:\xowa\bin\windows\java\jre +
  • +
+

+ Limitations +

+
    +
  • + There currently is no similar process for Linux distributions. Note that various Linux distributions would have different binaries, and setting up distro-specific JREs does not seem useful (Debian JRE; Redhat JRE; openSUSE JRE, etc). +
  • +
  • + There also is no similar process for Mac OS X. I'm working on a standalone .dmg file for OS X, and when it is done, I will include standalone JRE support. +
  • +
+

+ Developer notes +

+
    +
  • + The embedded JRE uses functionality within the exe which in turn was built by launch4j. There is no specific code in XOWA to handle this function. Any issues with standalone JRE functionality will probably be resolvable at the launch4j level. +
  • +
+

+
+

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/Installation.html b/wiki/home/page/App/Setup/Installation.html new file mode 100644 index 000000000..8e4f375a2 --- /dev/null +++ b/wiki/home/page/App/Setup/Installation.html @@ -0,0 +1,206 @@ + + + + + App/Setup/Installation - XOWA + + + + + +
+
+
+

App/Setup/Installation

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +
+
+

+ Contents +

+
+ +
+

+ Download and unzip XOWA +

+
    +
  • + Download a package for your operating system from https://github.com/gnosygnu/xowa/releases/ For example, if you're using Windows, you would download xowa_app_windows_v3.1.1.1.zip. +
  • +
  • + Unzip to a folder. See the XOWA Folder section below for possible choices. +
  • +
  • + When finished, you will have a file called readme.txt as well as many other files and directories. +
  • +
+

+ Run XOWA +

+
    +
  • + On Windows, double-click C:\xowa\xowa.exe +
  • +
  • + On Linux, open a terminal and run sh /home/Your_Name/xowa/xowa_linux.sh +
  • +
+
+
+ Note that the shell script is a wrapper for java -Xmx256m -jar /home/Your_Name/xowa/xowa_linux.jar +
+
+
    +
  • + On OS X, open a terminal and run sh /Users/Your_Name/xowa/xowa_macosx.sh +
  • +
+
+
+ Note that the shell script is a wrapper for java -Xmx256m -d32 -XstartOnFirstThread -jar /Users/Your_Name/xowa/xowa_macosx.jar +
+
+

+ XOWA folder +

+

+ XOWA works from one folder. For the purpose of the instructions throughout this wiki, this folder will be referred to as /xowa/. +

+

+ The table below lists recommended locations by operating system. Note that these are just recommendations: you can use any other folder on your hard drive (or on a flash memory card). +

+ + + + + + + + + + + + + + + + + + + + + +
+ operating system + + folder + + path of xowa jar +
+ Windows + + C:\xowa\ + + C:\xowa\xowa_windows.jar +
+ Linux + + /home/Your_Name/xowa/ + + /home/Your_Name/xowa/xowa_linux.jar +
+ OS X + + /Users/Your_Name/xowa/ + + /Users/Your_Name/xowa/xowa_macosx.jar +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/Installation/Notes.html b/wiki/home/page/App/Setup/Installation/Notes.html new file mode 100644 index 000000000..bf0d1c83c --- /dev/null +++ b/wiki/home/page/App/Setup/Installation/Notes.html @@ -0,0 +1,159 @@ + + + + + App/Setup/Installation/Notes - XOWA + + + + + +
+
+
+

App/Setup/Installation/Notes

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ Operating System dependent files +

+

+ The following two files are operating-system dependent files: +

+
    +
  • + On Windows, C:\xowa\xowa_windows.jar and C:\xowa\bin\windows\swt\swt.jar +
  • +
  • + On Linux, /xowa/xowa_linux.jar and /xowa/bin/linux/swt/swt.jar +
  • +
  • + On OS X, /xowa/xowa_macosx.jar and /xowa/bin/macosx/swt/swt.jar +
  • +
+

+ XUL Runner +

+

+ XUL Runner is included in the xowa_app_packages. However, if you need to download it separately, please do the following: +

+
    +
  • + Navigate to the http://ftp.mozilla.org/pub/mozilla.org/xulrunner/releases/10.0.4esr/runtimes/ +
  • +
  • + Download the proper operating system package +
      +
    • + On Windows, download xulrunner-10.0.4esr.en-US.win32.zip and unzip the files to C:\xowa\bin\windows\xulrunner +
    • +
    • + On Linux, download xulrunner-10.0.4esr.en-US.linux-i686.tar.bz2 and unzip the files to /home/your_user_name/xowa/bin/linux/xulrunner +
    • +
    • + On OS X, download xulrunner-10.0.4esr.en-US.mac-pkg.dmg +
    • +
    +
  • +
+
+
+
+
+
+
+ Unzip the .dmg file. There will be a lot of nested packages. You will be looking for a folder called 10.0.4 +
+
+ For reference's sake, I used 7-zip on a Windows machine. This was the final path: C:\xulrunner-10.0.4esr.en-US.mac-pkg\XULRunner\xulrunner-10.0.4esr.en-US.mac.pkg\Contents\Archive.pax\Archive\XUL.framework\Versions\10.0.4 +
+
+
+
+ Take the 10.0.4 folder and move it to /Users/your_user_name/xowa/bin/macosx/xulrunner +
+
+
+
+
+
+

+
+

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/Installation/Overview.html b/wiki/home/page/App/Setup/Installation/Overview.html new file mode 100644 index 000000000..2aab444cc --- /dev/null +++ b/wiki/home/page/App/Setup/Installation/Overview.html @@ -0,0 +1,206 @@ + + + + + App/Setup/Installation/Overview - XOWA + + + + + +
+
+
+

App/Setup/Installation/Overview

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +
+
+

+ Contents +

+
+ +
+

+ Download and unzip XOWA +

+
    +
  • + Download a package for your operating system from https://github.com/gnosygnu/xowa/releases/ For example, if you're using Windows, you would download xowa_app_windows_v3.1.1.1.zip. +
  • +
  • + Unzip to a folder. See the XOWA Folder section below for possible choices. +
  • +
  • + When finished, you will have a file called readme.txt as well as many other files and directories. +
  • +
+

+ Run XOWA +

+
    +
  • + On Windows, double-click C:\xowa\xowa.exe +
  • +
  • + On Linux, open a terminal and run sh /home/Your_Name/xowa/xowa_linux.sh +
  • +
+
+
+ Note that the shell script is a wrapper for java -Xmx256m -jar /home/Your_Name/xowa/xowa_linux.jar +
+
+
    +
  • + On OS X, open a terminal and run sh /Users/Your_Name/xowa/xowa_macosx.sh +
  • +
+
+
+ Note that the shell script is a wrapper for java -Xmx256m -d32 -XstartOnFirstThread -jar /Users/Your_Name/xowa/xowa_macosx.jar +
+
+

+ XOWA folder +

+

+ XOWA works from one folder. For the purpose of the instructions throughout this wiki, this folder will be referred to as /xowa/. +

+

+ The table below lists recommended locations by operating system. Note that these are just recommendations: you can use any other folder on your hard drive (or on a flash memory card). +

+ + + + + + + + + + + + + + + + + + + + + +
+ operating system + + folder + + path of xowa jar +
+ Windows + + C:\xowa\ + + C:\xowa\xowa_windows.jar +
+ Linux + + /home/Your_Name/xowa/ + + /home/Your_Name/xowa/xowa_linux.jar +
+ OS X + + /Users/Your_Name/xowa/ + + /Users/Your_Name/xowa/xowa_macosx.jar +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/Installation/Self_extracting_exe.html b/wiki/home/page/App/Setup/Installation/Self_extracting_exe.html new file mode 100644 index 000000000..7f9f9eecf --- /dev/null +++ b/wiki/home/page/App/Setup/Installation/Self_extracting_exe.html @@ -0,0 +1,125 @@ + + + + + App/Setup/Installation/Self extracting exe - XOWA + + + + + +
+
+
+

App/Setup/Installation/Self extracting exe

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ XOWA currently uses a self-extracting exe for its windows upgrade package. This page documents the steps to generate the package. +

+ +
+;!@Install@!UTF-8!
+Title="XOWA"
+InstallPath="."
+OverwriteMode="0"
+;!@InstallEnd@!
+
+
    +
  • + Run the following command to merge the two files into an exe: +
  • +
+

+ copy /b 7zsd.sfx + config.txt + xowa_upgrade.7z xowa_upgrade.exe +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/System_requirements.html b/wiki/home/page/App/Setup/System_requirements.html new file mode 100644 index 000000000..affb84ffb --- /dev/null +++ b/wiki/home/page/App/Setup/System_requirements.html @@ -0,0 +1,174 @@ + + + + + App/Setup/System requirements - XOWA + + + + + +
+
+
+

App/Setup/System requirements

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +
+
+

+ Contents +

+
+ +
+

+ Hardware +

+
    +
  • + CPU: 1.0 GHz minimum; 2.0 GHz recommended +
  • +
  • + Memory: 512 MB minimum; 2 GB recommended +
  • +
  • + Storage: varies per wiki. As a rough guideline, multiply the dump file by 2. +
      +
    • + For example, for English Wikipedia, the dump size is 12 GB. +
        +
      • + The XOWA wiki will be about 25 GB +
      • +
      • + The import process will need about 2 GB in temp files. +
      • +
      • + You should have at least 30 GB available for the text only version. The image version will require at least another 70 GB. +
      • +
      +
    • +
    +
  • +
+

+ Software +

+
    +
  • + Operating System +
      +
    • + Windows 32 bit / 64 bit +
    • +
    • + Linux 32 bit / 64 bit +
    • +
    • + Mac OS X 32 bit / 64 bit +
    • +
    • + Raspberry PI (ARM) +
    • +
    • + Android +
    • +
    +
  • +
  • + Java 1.7+ + +
  • +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/App/Setup/Upgrading.html b/wiki/home/page/App/Setup/Upgrading.html new file mode 100644 index 000000000..e369c9df3 --- /dev/null +++ b/wiki/home/page/App/Setup/Upgrading.html @@ -0,0 +1,297 @@ + + + + + App/Setup/Upgrading - XOWA + + + + + +
+
+
+

App/Setup/Upgrading

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ This article describes the process in upgrading your XOWA program from one release to another. +

+ +

+ Background +

+

+ XOWA has an aggressive release schedule, with a new version coming out every week. For more details, see Help/Release_schedule. +

+

+ XOWA releases frequently for a few reasons: +

+
    +
  • + MediaWiki updates frequently: English Wikipedia and all the other Wikimedia wikis use a continuous integration model. These releases tend to come out very quickly with releases as often as every week. See https://www.mediawiki.org/wiki/News for an example of the release schedule +
  • +
  • + XOWA is still young: XOWA was only released in 2012-12-31. Although a lot of features have been added since then, there are still a lot of features to be added. +
  • +
  • + Frequent release philosophy: I personally prefer having frequent releases as opposed to larger infrequent releases. The former is more manageable, and keeps overall development nimble. +
  • +
+

+ Upgrade by an xowa_upgrade package +

+

+ xowa_upgrade packages are produced with every release. +

+

+ Upgrade process +

+

+ To upgrade, do the following: +

+

+ Windows +

+
    +
  • + Download the "xowa_upgrade" exe for your operating system. For example, if you're on Windows with a 64-bit JVM and upgrading to v2.8.2, you would download xowa_upgrade_windows_64_v2.8.2.1.exe +
  • +
  • + Place the .exe in your xowa root directory. For example, if you're running XOWA by using C:\xowa\xowa_64.exe, then place xowa_upgrade_windows_64_v2.8.2.1.exe in C:\xowa so that the file name is C:\xowa\xowa_upgrade_windows_64_v2.8.2.1.exe +
  • +
  • + Double-click the "xowa_upgrade.exe". The upgrade is a self-extracting 7-zip exe and will unzip all files and place them in the correct locations. Among other things, you'll have a new xowa.jar file. For example, C:\xowa\xowa_windows_64.jar should show a recent date. +
  • +
+

+ Linux / Mac OS X +

+
    +
  • + Download the "xowa_upgrade" zip for your operating system +
  • +
  • + Place the .zip in your xowa root directory. For example, if you're running Mac OS X by using /Users/your_user_name/xowa/xowa_macosx_64.sh, then place xowa_upgrade_macosx_64_v2.8.2.1.zip in /Users/your_user_name/xowa/ so that the file name is /Users/your_user_name/xowa/xowa_upgrade_macosx_64_v2.8.2.1.zip +
  • +
  • + Extract the files. Note that depending on your unzip program, the file may be placed in a new sub-directory. For example, on Mac OS X, the files will be unzipped to a new folder called /Users/your_user_name/xowa/xowa_upgrade_macosx_64_v2.8.2.1/ +
  • +
  • + Move the files from the extracted folder to the XOWA root folder. Overwrite any files in the process. For example, on Mac OS X, there will be a new file called /Users/your_user_name/xowa/xowa_upgrade_macosx_64_v2.8.2.1/xowa_macosx_64.jar. This should be moved to /Users/your_user_name/xowa/xowa_macosx_64.jar and overwrite the existing version. +
  • +
+

+ Upgrade shelf-life of 4 weeks +

+

+ A given upgrade will only work if your release is within the past 4 weeks. For example: +

+
    +
  • + You start off with the v2.1.3 application. +
  • +
  • + v2.1.4 is released. You can use the v2.1.4 upgrade since your v2.1.3 release is 1 week old +
  • +
  • + v2.2.1 is released and you haven't upgraded anything. You can use the v2.2.1 upgrade since your v2.1.3 release is 2 weeks old. +
  • +
  • + v2.2.2 is released and you haven't upgraded anything. You can use the v2.2.2 upgrade since your v2.1.3 release is 3 weeks old. +
  • +
  • + v2.2.3 is released and you haven't upgraded anything. You can use the v2.2.3 upgrade since your v2.1.3 release is 4 weeks old. +
  • +
  • + v2.2.4 is released and you haven't upgraded anything. You can not use the v2.2.4 upgrade since your v2.1.3 release is 5 weeks old. You must get a new application package +
  • +
+

+ Once you upgrade, the 4-week window resets. You can perpetually upgrade XOWA in this fashion. For example: +

+
    +
  • + You start off with the v2.1.3 application. +
  • +
  • + You upgrade when v2.2.3 is released. Your release will now be v2.2.3 +
  • +
  • + You upgrade again when v2.3.3 is released. Your release will now be v2.3.3 +
  • +
  • + You upgrade again when v2.4.1 is released. Your release will now be v2.4.1 +
  • +
  • + And so on... +
  • +
+

+ Upgrade issues should fallback to xowa_app packages +

+

+ If you have problems after using an xowa_upgrade package, try upgrading using an xowa_app package. I personally test xowa_app packages on both Windows and Linux for every release and these will always work. In addition, due to the nature of the build script, the application package is always guaranteed to have the latest changes. +

+

+ Upgrade by an xowa_app package +

+

+ You can also upgrade by downloading an xowa_app package and unzipping everything in the xowa root directory. For example: +

+
    +
  • + Download the "xowa_app" zip for your operating system +
  • +
  • + Place the .zip in your xowa root directory. For example, if you're running on Windows 64-bit by using C:\xowa\windows_64.exe, then place xowa_app_windows_64_v2.8.2.1.zip in C:\xowa\windows_64\ so that the file name is C:\xowa\windows_64\xowa_app_windows_64_v2.8.2.1.zip +
  • +
  • + Extract the files. Note that depending on your unzip program, the file may be placed in a new sub-directory. For example, on Windows 64-bit, the files will be unzipped to a new folder called C:\xowa\windows_64\xowa_app_windows_64_v2.8.2.1\ +
  • +
  • + Move the files from the extracted folder to the XOWA root folder. Overwrite any files in the process. For example, on Windows 64-bit, there will be a new file called C:\xowa\windows_64\xowa_app_windows_64_v2.8.2.1\xowa_windows_64.jar. This should be moved to C:\xowa\windows_64\xowa_windows_64.jar and overwrite the existing version. +
  • +
+

+ Note that you can always just upgrade using the xowa_app package. The xowa_upgrade packages are provided because they are generally 5 to 10 times smaller than the application packages. +

+

+ Upgrade by an xowa_app package and regenerating the XOWA root directory +

+

+ You can also do an upgrade by renaming your existing XOWA root directory and unzipping a new app package in the same directory. For example, assuming a Windows system with XOWA in C:\xowa +

+
    +
  • + Rename the C:\xowa folder to C:\xowa-old +
  • +
  • + Download an app package and unzip it to C:\xowa +
  • +
  • + Move the following directories from C:\xowa-old to C:\xowa +
      +
    • + C:\xowa-old\wiki to C:\xowa\wiki +
    • +
    • + C:\xowa-old\file to C:\xowa\file +
    • +
    • + C:\xowa-old\user to C:\xowa\user +
    • +
    +
  • +
+

+ This approach is more manual, but is meant as an alternate approach. It's also useful for moving XOWA from one drive to another. +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/Change_log.html b/wiki/home/page/Change_log.html index b5a9af88c..640b20f19 100644 --- a/wiki/home/page/Change_log.html +++ b/wiki/home/page/Change_log.html @@ -966,12 +966,12 @@
@@ -980,12 +980,12 @@

Help

diff --git a/wiki/home/page/Help/About.html b/wiki/home/page/Help/About.html new file mode 100644 index 000000000..a25cdaf7a --- /dev/null +++ b/wiki/home/page/Help/About.html @@ -0,0 +1,855 @@ + + + + + Help/About - XOWA + + + + + +
+
+
+

Help/About

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ Information +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name: + + XOWA +
+ version: + + 3.4.2.1 (view changes) +
+ build_date: + + 2016-04-09 00:16 +
+ license: + + AGPLv3 +
+ website: + + https://gnosygnu.github.io +
+ developer: + + gnosygnu +
+ email: + + gnosygnu@gmail.com +
+ identity passphrases: + + 8d06d35872ca9e477c3295c3b2ccfb02214626660ae0f292ab93e1dfedcadac4
+ d17f529216e011db77e22365de09335a459d78584fb1c29066e79fe422b904f2
+
+

+ Contributors +

+ + + + + +
+ + + + + + + + + +
+ name + + contribution +
+ Schnark + +
    +
  • + MathJax integration +
  • +
  • + Sortable/Collapsible tables +
  • +
  • + Reference tooltips +
  • +
  • + Timeline +
  • +
  • + Wikidata html formatter +
  • +
  • + Search suggestions +
  • +
  • + Redlink identification +
  • +
  • + Edit toolbar +
  • +
  • + German localization +
  • +
  • + 250+ defect detection +
  • +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ name + + contribution +
+ treck + +
    +
  • + Firefox Add-on +
  • +
  • + Polish localization +
  • +
+
+ hidp123 + +
    +
  • + multiple defect detection +
  • +
+
+ Miles + +
    +
  • + multiple defect detection +
  • +
+
+ Anselm + +
    +
  • + import bz2 by stdout proposal +
  • +
  • + multiple defect detection +
  • +
+
+ Mattze96 + +
    +
  • + HTTP Web Server +
  • +
+
+ zjzengdongyang + +
    +
  • + Chinese localization +
  • +
  • + multiple defect detection +
  • +
+
+
+

+ Components and Tools +

+

+ XOWA is free software. It was built using free software and was made possible by free culture. +

+

+ Support free software and free culture today! +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Name + + Description + + License +
+ Primary application components +
+ Wikimedia Foundation + + Wiki data dumps and images + + CC-BY-SA 3.0 +
+ XUL Runner + + Mozilla Firefox web browser runtime environment + + MPL +
+ Java + + Programming language + + GPLv2 +
+ SWT + + Web browser interoperability + + CPL +
+ Java libraries +
+ Xerial SQLite JDBC + + JDBC library for Sqlite + + Apache v2.0 +
+ Luaj + + Embedded scripting library + + BSD +
+ JTidy + + HTML markup cleaner + + BSD +
+ Apache Commons Compress + + BZ2 compression / decompression library + + Apache v2.0 +
+ Javascript libraries +
+ MathJax + + LaTEX library + + Apache v2.0 +
+ JQuery + + General library (used for table sorting/collapsing) + + MIT +
+ JQuery UI + + UI library (used for draggable) + + MIT +
+ NotifyJS + + Notification library + + MIT +
+ Other application components +
+ sqlite + + SQL database library + + Public Domain +
+ Lua + + Embedded scripting library + + MIT +
+ tidy + + HTML markup cleaner + + MIT +
+ 7-Zip + + Compression / decompression program (Windows) + + LGPL +
+ Lilypond + + Music score generator + + GPLv3 +
+ ImageMagick + + Image converter + + Apache v2.0 +
+ Inkscape + + SVG converter + + GPL +
+ MiKTEX + + TEX converter (Windows) + + MikTex Open Source +
+ TiMidity++ + + Midi to ogg converter + + GPLv2 +
+ Websites +
+ archive.org + + Image database host + +
+ Sourceforge.net + + Project hosting website + +
+ Gerrit + + Software code review + +
+ Wikimedia dump servers + + Wiki backup host + +
+ Development tools and utilities +
+ Ubuntu + + Operating system + + GPL derived +
+ Eclipse + + Java IDE + + CPL +
+ jEdit + + Text editor + + GPLv2 +
+ Notepad++ + + Text editor (Windows) + + GPL +
+ Firebug + + HTML inspection + + BSD +
+ LibreOffice + + Spreadsheet application + + LGPLv3, MPL +
+ SQuirreL SQL + + SQL editor + + LGPL +
+ JSmooth + + Java exe wrapper (Windows) + + GPLv2 +
+ Launch4J + + Java exe wrapper (Windows 64-bit) + + BSD, MIT +
+ qBittorrent + + Torrent generator + + GPLv2 +
+ GIMP + + Image manipulation + + GPLv3 +
+ VLC + + Media player + + GPLv2 +
+ DjVuLibre + + DjVu viewer + + GPLv2 +
+ Evince + + PDF viewer + + GPLv2 +
+ Resources +
+ MediaWiki + + Wiki server software + + GPLv2 +
+ PHP + + Server-side scripting language + + PHP v3.01 +
+ Tango icon library + + Icons + + Public Domain +
+ Oxygen + + Icons + + LGPL +
+ Special mention +
+ GNU + + Free software philosophy + +
+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/Help/Feedback.html b/wiki/home/page/Help/Feedback.html new file mode 100644 index 000000000..e16ba23d1 --- /dev/null +++ b/wiki/home/page/Help/Feedback.html @@ -0,0 +1,107 @@ + + + + + Help/Feedback - XOWA + + + + + +
+
+
+

Help/Feedback

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ Want to leave a comment? Report a defect? Try one of the following: +

+ + +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/Help/Privacy/Android.html b/wiki/home/page/Help/Privacy/Android.html new file mode 100644 index 000000000..1c5f85944 --- /dev/null +++ b/wiki/home/page/Help/Privacy/Android.html @@ -0,0 +1,235 @@ + + + + + Help/Privacy/Android - XOWA + + + + + +
+
+
+

Help/Privacy/Android

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ + +

+ Overview +

+

+ XOWA is commited to user privacy. Throughout the app, it pursues these four principles: +

+
    +
  • + Request minimal permissions. +
  • +
  • + Store minimal user data. +
  • +
  • + Never upload user data. +
  • +
  • + Provide ways to remove user data. +
  • +
+

+ What permissions does XOWA require? +

+

+ XOWA requires 2 permissions: +

+

+ Read External Storage +

+
    +
  • + This permission is needed to read XOWA databases on the external SD card. +
  • +
  • + No other directory is read aside from the chosen XOWA directory. In other words, XOWA does not use this permission to read through all your folders on the SD card. +
  • +
+

+ Internet +

+
    +
  • + This permission is used to retrieve full-scale images from the Wikipedia website. +
  • +
  • + This permission is never used to upload data to the internet +
  • +
+

+ What information is stored in XOWA? +

+

+ XOWA only collects user data related to application usage. For example: +

+
    +
  • + Opening pages will generate entries in the History screen. +
  • +
  • + Searching for pages will generate entries in the Search screen. +
  • +
  • + Saving pages will generate entries in the Saved pages screen. +
  • +
  • + Pages with images will save temporary files to the applications cache. +
  • +
+

+ XOWA collects no other data in the background. This includes application logging data. Logs will be added in a future release. When that happens, this section will then updated to reflect new details on that function. +

+

+ When does XOWA share this information? +

+

+ XOWA never shares user data. XOWA never uploads data. All data remains on your device unless you choose to do something with it. The only thing you will see is a button that allows you to send crash reports to the developer. +

+

+ How does XOWA store this information? +

+
    +
  • + Data for the History and Search and Saved pages screen are saved with application data. +
      +
    • + This data can be cleared on its respective screen. For example, the History button has a trash can icon to clear all entries. +
    • +
    +
  • +
  • + XOWA saves all images to temporary cache. To clear this cache, please do the following: +
      +
    • + Go to Settings -> Apps -> XOWA -> Storage +
    • +
    • + Press "Clear Cache" +
    • +
    +
  • +
+

+ Contact +

+

+ For any questions or clarifications, please contact gnosygnu at gmail dot com. +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/Help/Privacy/Desktop.html b/wiki/home/page/Help/Privacy/Desktop.html new file mode 100644 index 000000000..61e41ea6b --- /dev/null +++ b/wiki/home/page/Help/Privacy/Desktop.html @@ -0,0 +1,256 @@ + + + + + Help/Privacy/Desktop - XOWA + + + + + +
+
+
+

Help/Privacy/Desktop

+
+
From XOWA: the free, open-source, offline wiki application
+
+
+ +

+ XOWA is commited to user privacy. As a user of the XOWA desktop app, you can be assured of the following: +

+
    +
  • + User data is never uploaded: No data is ever uploaded. All data remains on your machine unless you choose to do something with it. The most you will ever see is a button that allows you to send log files to the developer. +
  • +
  • + User data is collected for application usage only: +
      +
    • + Features like "Page History" and "Bookmarks" depend on user data. As a result, these features are enabled by default. They can be disabled at the user's discretion. +
    • +
    • + XOWA also has a log that records actions and errors. +
        +
      • + This data is for diagnosing defects whenever you want to report them. +
      • +
      • + It can be reviewed under Help -> System Data -> System Log +
      • +
      • + It can be deleted under /xowa/user/anonymous/app/tmp. XOWA only keeps the last 8 sessions around. +
      • +
      +
    • +
    +
  • +
  • + User data collection can be disabled or cleared: Individual features can either be cleared or disabled. The rest of the page details the process for each feature. +
  • +
+

+
+

+ +

+ Mozilla browser data +

+

+ The embedded Mozilla browser generates its own history data and stores them in sqlite files in a user's profile directory. This includes names of clicked links (so the browser can highlight them). +

+
+
+ On Linux, the folder would be /home/your_user_name/.mozilla/eclipse +
+
+ On Windows XP, the folder would be C:\Documents and Settings\your_user_name\Application Data\Mozilla\eclipse +
+
+ On Windows 7, the folder would be C:\Users\your_user_name\Application Data\Mozilla\eclipse +
+
+

+ Note that this functionality is not directly controllable, so there is no way to circumvent it. However, if you want to, you can try either of the following: +

+
    +
  • + Mark the .sqlite files in the directory read-only. This will slow down each page-load by 1/2 a second (presumably b/c Mozilla fails when trying to update) but will not save your history data +
  • +
  • + Delete the .sqlite files after XOWA is done. This is not a perfect solution as it still writes the data first to disk. +
  • +
+

+ Application logs +

+

+ Application logs are enabled by default. They are saved to files in the following directory: /xowa/user/anonymous/app/tmp. +

+

+ Application logs can be disabled at Options/Security +

+

+ Page history +

+

+ Page history is enabled by default. The data is saved to the following file: /xowa/user/anonymous/app/data/history/page_history.csv. +

+

+ Page history can be disabled at Options/Security +

+

+ Temporary HTML files +

+

+ All HTML for pages will be saved to and loaded from a temp directory on disk. The files are saved to the following directory: /xowa/user/anonymous/app/tmp/html. This is done for performance reasons related to SWT / XULRunner. See Options/Security +

+

+ HTML can be changed to load directly from memory at Options/Security +

+

+ Bookmarks +

+

+ Bookmarks are enabled by default. Note that no data is ever written automatically to the Bookmarks page, so one can simply not use the add feature. +

+

+ If you wish to disable the feature completely (to prevent accidental clicks), then you can disable it at Options/Security +

+

+ File download +

+

+ File download is disabled by default. All files are downloaded to the following directory: /xowa/file. +

+

+ If you've enabled it, you can disable it at Options/Files +

+

+ Math images (LaTEX only) +

+

+ Math images use MathJax by default, which does not generate temporary files. +

+

+ If you choose to use LaTEX then temporary files will be generated. All files are created in the following directory: /xowa/file/name_of_wiki/math. +

+

+ You can always disable LaTEX again at Options/Math +

+

+ Content applications +

+

+ Content applications are enabled by default. These applications may or may not generate their own temp files. +

+

+ These third-party viewer applications can be disabled at Options/Apps by setting all values to blank. +

+ +
+
+
+ + +
+
+
+

Namespaces

+ +
+
+
+ +
+ +
+

XOWA

+ +
+ +
+

Help

+ +
+ + + +
+

Donate

+
+ +
+
+
+ + \ No newline at end of file diff --git a/wiki/home/page/Main_Page.html b/wiki/home/page/Main_Page.html index 21da2cad9..bf545c059 100644 --- a/wiki/home/page/Main_Page.html +++ b/wiki/home/page/Main_Page.html @@ -78,9 +78,6 @@

Please note that this program is beta software. Although it is my best hope that you find this program functional and useful, I make no assurances regarding stability or fitness of purpose. For more details, see Help/License/Code.

-

-
-

Release notes

@@ -110,9 +107,6 @@

For more details about the release schedule, please see the release schedule.

-

-
-

New users

@@ -187,9 +181,6 @@ Import from a dump file: See import offline. -

-
-

Upgrade users

@@ -239,9 +230,6 @@ v2.4.1 has introduced major database layout changes. For more info, see Database -

-
-

Tips

@@ -301,9 +289,6 @@ Right-click: Right click on an image and click save as file -

-
-

Notes

@@ -312,9 +297,6 @@ Wikidata: If you're seeing {{#property}} in your wikis you should also set up Wikidata. See App/Wiki_types/Wikidata -

-
-

Links

@@ -426,12 +408,12 @@
@@ -440,12 +422,12 @@

Help