Archives/gnosygnu_xowa
1
0
Fork 0
mirror of https://github.com/gnosygnu/xowa.git synced 2026-03-02 03:49:30 +00:00
Code Issues Projects Releases Wiki Activity

'v3.4.2.6'

Browse Source
This commit is contained in:
gnosygnu
2016-04-15 16:19:00 -04:00
parent 574451bd93
commit cc5b49c7c4
225 changed files with 111023 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

528
App/Xtn/Android.html Normal file
View File

@@ -0,0 +1,528 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Android - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
<style>
.console {font-family: monospace; color: #EEEEEE ; background-color: black ; border: medium solid black;}
.code
,.path
,.url {font-family: monospace; color: black ; background-color: #f9f9f9 ; border: medium solid #f9f9f9;}
.bold {font-weight: 900;}
</style>
<style>
.console {font-family: monospace; color: #EEEEEE ; background-color: black ; border: medium solid black;}
.code
,.path
,.url {font-family: monospace; color: black ; background-color: #f9f9f9 ; border: medium solid #f9f9f9;}
.bold {font-weight: 900;}
</style>
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Android</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
XOWA is also available as an Android application.
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Overview"><span class="tocnumber">1</span> <span class="toctext">Overview</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Requirements"><span class="tocnumber">2</span> <span class="toctext">Requirements</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#Installation"><span class="tocnumber">3</span> <span class="toctext">Installation</span></a>
<ul>
<li class="toclevel-2 tocsection-4">
<a href="#Set_up_Simple_Wikipedia_on_your_microSD_card"><span class="tocnumber">3.1</span> <span class="toctext">Set up Simple Wikipedia on your microSD card</span></a>
</li>
<li class="toclevel-2 tocsection-5">
<a href="#Install_XOWA.apk"><span class="tocnumber">3.2</span> <span class="toctext">Install XOWA.apk</span></a>
</li>
<li class="toclevel-2 tocsection-6">
<a href="#Import_Simple_Wikipedia"><span class="tocnumber">3.3</span> <span class="toctext">Import Simple Wikipedia</span></a>
</li>
<li class="toclevel-2 tocsection-7">
<a href="#Set_up_English_Wikipedia_on_your_microSD_card"><span class="tocnumber">3.4</span> <span class="toctext">Set up English Wikipedia on your microSD card</span></a>
</li>
<li class="toclevel-2 tocsection-8">
<a href="#Requested_feedback"><span class="tocnumber">3.5</span> <span class="toctext">Requested feedback</span></a>
</li>
</ul>
</li>
<li class="toclevel-1 tocsection-9">
<a href="#Features"><span class="tocnumber">4</span> <span class="toctext">Features</span></a>
</li>
<li class="toclevel-1 tocsection-10">
<a href="#To-do_list"><span class="tocnumber">5</span> <span class="toctext">To-do list</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Overview">Overview</span>
</h2>
<p>
The XOWA Android application is in an alpha state. Please note the following details:
</p>
<ul>
<li>
The apk works on the following devices: <sup id="cite_ref-anselm_android_testing_0-0" class="reference"><a href="#cite_note-anselm_android_testing-0">[1]</a></sup>
<ul>
<li>
Samsung Galaxy S (Froyo)
</li>
<li>
Samsung Galaxy Note 2 (KitKat)
</li>
<li>
Samsung Galaxy Tab 4 (KitKat)
</li>
<li>
Samsung Galaxy S4 Mini (GT-I9195) dual core (v4.2.2 Jelly Bean) (by Anselm)
</li>
<li>
Andy - (Android Version 4.2.2; GT-P5200) ** (by Anselm on emulator)
</li>
<li>
blue stack - (Android Version 4.4.2; Model GT-N7100) ** (by Anselm on emulator)
</li>
<li>
Genymotion - Google Nexus 10 - 5.1.0 - API 22 - 2560x1600 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Google Nexus 4 - 4.1.1 - API 16 - 768x1280 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Google Nexus 4 - 4.4.4 - API 19 - 768x1280 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Google Nexus 7 2013 - 4.4.4 - API 19 - 1200x1920 ** (by Anselm on emulator)
</li>
<li>
Genymotion - HTC Evo - 4.3 - API 18 - 720x1280 ** (by Anselm on emulator)
</li>
<li>
Genymotion - HTC One XL - 4.1.1 - API 16 - 720x1280 ** (by Anselm on emulator)
</li>
<li>
Genymotion - LG Optimus L3 II - 4.1.1 - API 16 - 240x320 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Motorola Droid Razr - 4.1.1 - API 16 - 540x960 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Motorola Moto X - 4.2.2 - API 17 - 720x1280 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Samsung Galaxy Note 2 - 4.3 - API 18 - 720x1280 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Samsung Galaxy Note 3 - 4.4.4 - API 19 - 1080x1920 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Samsung Galaxy S4 - 4.4.4 - API 19 - 1080x1920 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Sony Xperia Tablet Z - 4.1.1 - API 16 - 1920x1200 ** (by Anselm on emulator)
</li>
<li>
Genymotion - Sony Xperia Z - 4.3 - API 18 - 1080x1920 ** (by Anselm on emulator)
</li>
</ul>
</li>
<li>
The apk works after shutting down and starting the virtual device
<ul>
<li>
Genymotion - Google Nexus 9 - 5.1.0 - API 22 - 2048x1536 (by Anselm on emulator)
</li>
</ul>
</li>
<li>
The apk hangs on these devices
<ul>
<li>
Genymotion - Google Nexus 4 - 5.0.0 - API 21 - 768x1280 (by Anselm on emulator)
</li>
<li>
Genymotion - Google Nexus 5 - 5.1.0 - API 22 - 1080x1920 (by Anselm on emulator)
</li>
<li>
Genymotion - Google Nexus 7 - 5.1.0 - API 22 - 800x1280 (by Anselm on emulator)
</li>
<li>
Genymotion - HTC Evo - 4.1.1 - API 16 - 720x1280 (by Anselm on emulator)
</li>
<li>
Genymotion - HTC Evo - 4.2.2 - API 17 - 720x1280 (by Anselm on emulator)
</li>
<li>
Genymotion - Motorola Moto X - 4.4.4 - API 19 - 720x1280 (by Anselm on emulator)
</li>
</ul>
</li>
<li>
The apk does not work on these devices:
<ul>
<li>
Genymotion - Motorola Moto X - 4.3 - API 18 - 720x1280 (by Anselm on emulator)
</li>
</ul>
</li>
<li>
Currently, only the following wikis are available:
<ul>
<li>
Simple Wikipedia (text and images)
</li>
<li>
English Wikipedia (text)
</li>
</ul>
</li>
<li>
Functionality is limited to browsing pages in the Main namespace only
</li>
</ul>
<h2>
<span class="mw-headline" id="Requirements">Requirements</span>
</h2>
<ul>
<li>
Android 2.2 (Froyo) and up
</li>
<li>
External microSD card
<ul>
<li>
Simple Wikipedia (text and images): 3 GB of space
</li>
<li>
English Wikipedia (text): 28 GB
</li>
</ul>
</li>
</ul>
<h2>
<span class="mw-headline" id="Installation">Installation</span>
</h2>
<h3>
<span class="mw-headline" id="Set_up_Simple_Wikipedia_on_your_microSD_card">Set up Simple Wikipedia on your microSD card</span>
</h3>
<ul>
<li>
Create a folder on your microsSD card called <code>Z:\xowa\wiki\simple.wikipedia.org</code>. Substitute "Z:" with whatever letter your microSD card is.
</li>
<li>
Download the simple wikibundle from <a href="https://archive.org/details/Xowa_simplewiki_latest" rel="nofollow" class="external free">https://archive.org/details/Xowa_simplewiki_latest</a>
</li>
<li>
Copy simple.wikipedia.org-file.xowa to the simple.wikipedia.org folder on your card.
</li>
<li>
Download and copy the following files from <a href="http://sourceforge.net/projects/xowa/files/support/alphas/" rel="nofollow" class="external free">http://sourceforge.net/projects/xowa/files/support/alphas/</a>
<ul>
<li>
simple.wikipedia.org-text.xowa
</li>
<li>
simple.wikipedia.org-html.xowa
</li>
</ul>
</li>
</ul>
<h3>
<span class="mw-headline" id="Install_XOWA.apk">Install XOWA.apk</span>
</h3>
<ul>
<li>
Download the apk from <a href="https://github.com/gnosygnu/xowa/releases/download/v0.1/xowa_v0.1.apk" rel="nofollow" class="external free">https://github.com/gnosygnu/xowa/releases/download/v0.1/xowa_v0.1.apk</a>
</li>
<li>
Copy it on your microSD card. For example, place it at <code>Z:\xowa_v0.apk</code>
</li>
<li>
Navigate to it using the "My Files" application, or any similar "File explorer" application
</li>
<li>
Select it and install it
<ul>
<li>
Note that it requests two permissions
<ul>
<li>
Read to External Storage (android.permission.READ_EXTERNAL_STORAGE)
</li>
<li>
Write to External Storage (android.permission.WRITE_EXTERNAL_STORAGE)
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3>
<span class="mw-headline" id="Import_Simple_Wikipedia">Import Simple Wikipedia</span>
</h3>
<ul>
<li>
XOWA opens up to its own file browser
</li>
<li>
Navigate to the folder for simple.wikipedia.org
</li>
<li>
Check the box for simple.wikipedia.org-text.xowa
</li>
<li>
Click the "import" link in the upper-right hand corner. You may have to scroll to the right to find the link.
</li>
<li>
Click the "simple.wikipedia.org" link. It will take you to the Earth page.
</li>
</ul>
<h3>
<span class="mw-headline" id="Set_up_English_Wikipedia_on_your_microSD_card">Set up English Wikipedia on your microSD card</span>
</h3>
<ul>
<li>
Create a folder on your microsSD card called <code>Z:\xowa\wiki\en.wikipedia.org</code>. Substitute "Z:" with whatever letter your microSD card is.
</li>
<li>
Download the English Wikipedia HTML databases from <a href="https://archive.org/details/Xowa_enwiki_latest" rel="nofollow" class="external free">https://archive.org/details/Xowa_enwiki_latest</a> . You'll need 30 GB of space
<ul>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_core.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_core.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_html_ns-000_part-1.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_html_ns-000_part-1.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_html_ns-000_part-2.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_html_ns-000_part-2.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_html_ns-000_part-3.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_wiki_html_ns-000_part-3.7z</a>
</li>
</ul>
</li>
<li>
Download the English Wikipedia files from <a href="https://archive.org/details/Xowa_enwiki_latest" rel="nofollow" class="external free">https://archive.org/details/Xowa_enwiki_latest</a> . You'll need another 70 GB of space.
<ul>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_core.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_core.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-1.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-1.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-2.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-2.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-3.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-3.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-4.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-4.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-5.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-5.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-6.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-6.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-7.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-7.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-8.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-000_part-8.7z</a>
</li>
<li>
<a href="https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-100.7z" rel="nofollow" class="external free">https://archive.org/download/Xowa_enwiki_latest/Xowa_enwiki_2015-06-02_file_v2b_ns-100.7z</a>
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<h3>
<span class="mw-headline" id="Requested_feedback">Requested feedback</span>
</h3>
<p>
If you want to help out, please post any of the following to <a href="https://github.com/gnosygnu/xowa/wiki/Android" rel="nofollow" class="external free">https://github.com/gnosygnu/xowa/wiki/Android</a>
</p>
<ul>
<li>
What device are you using?
</li>
<li>
How much space is on your SD card?
</li>
<li>
How fast / slow is navigation between pages?
</li>
<li>
Do images load?
</li>
<li>
What essential features do you think are missing?
</li>
</ul>
<h2>
<span class="mw-headline" id="Features">Features</span>
</h2>
<ul>
<li>
Shows all mainspace articles with HTML.
</li>
<li>
Displays images from the XOWA database.
</li>
<li>
Renders Math formulas through MathJax.
</li>
<li>
Shows missing links as regular text (black color, not red color)
</li>
<li>
Uses a CSS similar to the Mobile Wikipedia version
</li>
</ul>
<h2>
<span class="mw-headline" id="To-do_list">To-do list</span>
</h2>
<ul>
<li>
HTML databases for English Wikipedia and other wikis
</li>
<li>
Page history
</li>
<li>
Bookmarks
</li>
<li>
Multiple wiki support
</li>
<li>
Find word
</li>
<li>
Search
</li>
<li>
Switch to desktop CSS
</li>
</ul>
<ol class="references">
<li id="cite_note-anselm_android_testing-0">
<span class="mw-cite-backlink"><a href="#cite_ref-anselm_android_testing_0-0">^</a></span> <span class="reference-text">See: <a href="https://sourceforge.net/p/xowa/discussion/general/thread/cd3d55ee/" rel="nofollow" class="external free">https://sourceforge.net/p/xowa/discussion/general/thread/cd3d55ee/</a></span>
</li>
</ol>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

167
App/Xtn/Browser/HTTP_Server.html Normal file
View File

@@ -0,0 +1,167 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Browser/HTTP Server - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Browser/HTTP Server</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<h2>
<span class="mw-headline" id="Credits">Credits</span>
</h2>
<p>
Considerable thanks goes to Mattze96 for proposing and developing the HTTP server.
</p>
<h2>
<span class="mw-headline" id="Overview">Overview</span>
</h2>
<p>
As of v0.12.1, XOWA now includes an HTTP server in addition to a TCP server. The TCP server is used by the Firefox Add-On (See <a href="http://xowa.org/wiki/home/page/App/Xtn/Browser/XOWA_viewer.html" id="xolnki_2" title="App/Xtn/Browser/XOWA viewer" class="xowa-visited">App/Xtn/Browser/XOWA_viewer</a>).
</p>
<p>
If you are using Firefox, the Firefox Add-On is the recommended solution for using XOWA within a browser. However, if you want to use XOWA from another browser (for example, Google Chrome) or across the network, you will want to use the HTTP server instead.
</p>
<p>
Note that the HTTP server is currently in an alpha stage, but should improve with coming releases. If you have any comments or feedback, please see <a href="https://sourceforge.net/p/xowa/discussion/general/thread/fa4baf84/" rel="nofollow" class="external free">https://sourceforge.net/p/xowa/discussion/general/thread/fa4baf84/</a>
</p>
<h2>
<span class="mw-headline" id="Usage">Usage</span>
</h2>
<h3>
<span class="mw-headline" id="Other_browsers">Other browsers</span>
</h3>
<p>
To use the XOWA HTTP server in another browser, do the following:
</p>
<ul>
<li>
Launch XOWA with the following command line: <code>java -jar /xowa/xowa_linux.jar --app_mode http_server --http_server_port 8080</code><sup id="cite_ref-port_80_0-0" class="reference"><a href="#cite_note-port_80-0">[1]</a></sup>
</li>
<li>
Launch your browser and navigate to <code>localhost:8080</code>
</li>
</ul>
<h3>
<span class="mw-headline" id="Across_the_network">Across the network</span>
</h3>
<p>
To use the XOWA HTTP server in a server setting, do the following:
</p>
<ul>
<li>
Launch XOWA on the <b>server</b> machine with the command line <code>java -jar /xowa/xowa_linux.jar --app_mode http_server</code>
</li>
<li>
Launch your browser on a <b>client</b> machine and navigate to the IP Address of the server machine. <code>192.168.0.100:8080</code>
</li>
</ul>
<h2>
<span class="mw-headline" id="Notes">Notes</span>
</h2>
<ol class="references">
<li id="cite_note-port_80-0">
<span class="mw-cite-backlink"><a href="#cite_ref-port_80_0-0">^</a></span> <span class="reference-text">Note that you will need to run XOWA as root if you choose to pass port 80 for http_server_port.</span>
</li>
</ol>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

284
App/Xtn/Browser/TCP_Server.html Normal file
View File

@@ -0,0 +1,284 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Browser/TCP Server - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Browser/TCP Server</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
XOWA can function as a basic TCP server. The primary purpose of the server is to support a Firefox addon. However, the functionality may be expanded in future releases.
</p>
<p>
Note that XOWA uses two ports for communications: an inbound port (defaults to 55000) and an outbound port (defaults to 55001). This may change in later implementations.
</p>
<h2>
<span class="mw-headline" id="Test_setup">Test setup</span>
</h2>
<ul>
<li>
Run xowa in server mode
</li>
</ul>
<dl>
<dd>
<code>java -jar /xowa/xowa_linux.jar --root_dir /xowa/ --app_mode server --server_port_recv 55000 --server_port_send 55001</code>
</dd>
</dl>
<ul>
<li>
Run xowa_tcp_console located in /xowa/bin/any/java/xowa/tcp_console/
</li>
</ul>
<dl>
<dd>
<code>java -jar /xowa/bin/any/java/xowa/tcp_console/xowa_tcp_console.jar 55000 55001 simple.wikipedia.org 1000</code>
</dd>
</dl>
<ul>
<li>
Enter "Earth". The 1st 1000 characters of the wikitext for Earth will display on the console.
</li>
</ul>
<h2>
<span class="mw-headline" id="Server_notes">Server notes</span>
</h2>
<p>
There are three arguments related to server mode
</p>
<ul>
<li>
<code>--app_mode server</code>
</li>
</ul>
<dl>
<dd>
This will launch XOWA in server mode. It will continue to run until either
<dl>
<dd>
Control-C is pressed
</dd>
<dd>
It receives a command of "app.server.stop;"
</dd>
</dl>
</dd>
</dl>
<ul>
<li>
<code>--server_port_recv 55000</code>
</li>
</ul>
<dl>
<dd>
This specifies port 55000 as the port where XOWA will listen for messages. Clients will send messages to this port
</dd>
</dl>
<ul>
<li>
<code>--server_port_send 55001</code>
</li>
</ul>
<dl>
<dd>
This specifies port 55001 as the port where XOWA will send messages. Clients will listen for responses on this port
</dd>
</dl>
<h2>
<span class="mw-headline" id="Console_notes">Console notes</span>
</h2>
<p>
There are four arguments related to the console app
</p>
<ul>
<li>
<code>55000</code>
</li>
</ul>
<dl>
<dd>
This specifies port 55000 as the port where the client will send its messages
</dd>
</dl>
<ul>
<li>
<code>55001</code>
</li>
</ul>
<dl>
<dd>
This specifies port 55001 as the port where the client will listen for responses
</dd>
</dl>
<ul>
<li>
<code>simple.wikipedia.org</code>
</li>
</ul>
<dl>
<dd>
This specifies the wiki that will be used for page lookup
</dd>
</dl>
<ul>
<li>
<code>1000</code>
</li>
</ul>
<dl>
<dd>
This specifies the maximum number of characters to be returned
</dd>
</dl>
<p>
After starting, the console takes 4 possible inputs:
</p>
<ul>
<li>
&lt;any page name&gt;
</li>
</ul>
<dl>
<dd>
<dl>
<dd>
the page name is sent to the XOWA server
</dd>
<dd>
the XOWA server will return the wikitext for that page
</dd>
</dl>
</dd>
</dl>
<ul>
<li>
<code>|server_exit</code>
</li>
</ul>
<dl>
<dd>
stops the server
</dd>
</dl>
<ul>
<li>
<code>|exit</code>
</li>
</ul>
<dl>
<dd>
stops the console
</dd>
</dl>
<ul>
<li>
Ctrl+C
</li>
</ul>
<dl>
<dd>
stops the console
</dd>
</dl>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

330
App/Xtn/Browser/XOWA_viewer.html Normal file
View File

@@ -0,0 +1,330 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Browser/XOWA viewer - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Browser/XOWA viewer</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
The XOWA viewer is an add-on for the Firefox browser. It allows Firefox to show XOWA pages by using an "xowa:" protocol (instead of "http:"). For example, navigating to <code>xowa:simple.wikipedia.org/wiki/Earth</code> will retrieve the HTML from XOWA but show it in Firefox.
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Credits"><span class="tocnumber">1</span> <span class="toctext">Credits</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Installation"><span class="tocnumber">2</span> <span class="toctext">Installation</span></a>
<ul>
<li class="toclevel-2 tocsection-3">
<a href="#Pale_Moon"><span class="tocnumber">2.1</span> <span class="toctext">Pale Moon</span></a>
</li>
<li class="toclevel-2 tocsection-4">
<a href="#Firefox"><span class="tocnumber">2.2</span> <span class="toctext">Firefox</span></a>
</li>
</ul>
</li>
<li class="toclevel-1 tocsection-5">
<a href="#Toolbar"><span class="tocnumber">3</span> <span class="toctext">Toolbar</span></a>
</li>
<li class="toclevel-1 tocsection-6">
<a href="#Features_and_Limitations"><span class="tocnumber">4</span> <span class="toctext">Features and Limitations</span></a>
</li>
<li class="toclevel-1 tocsection-7">
<a href="#Config"><span class="tocnumber">5</span> <span class="toctext">Config</span></a>
</li>
<li class="toclevel-1 tocsection-8">
<a href="#Developer:_Source_code"><span class="tocnumber">6</span> <span class="toctext">Developer: Source code</span></a>
</li>
<li class="toclevel-1 tocsection-9">
<a href="#Developer:_Install"><span class="tocnumber">7</span> <span class="toctext">Developer: Install</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Credits">Credits</span>
</h2>
<p>
Considerable thanks goes to treck for proposing and developing the XOWA viewer addon.
</p>
<h2>
<span class="mw-headline" id="Installation">Installation</span>
</h2>
<h3>
<span class="mw-headline" id="Pale_Moon">Pale Moon</span>
</h3>
<p>
As of Firefox version 43, unsigned addons are no longer supported. See <a href="https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox" rel="nofollow" class="external free">https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox</a> The XOWA Firefox Addon should be signed in the future, but in the meantime, you can use the open-source alternative Pale Moon as a substitute:
</p>
<ul>
<li>
Download Pale Moon from here: <a href="http://www.fosshub.com/Pale-Moon.html" rel="nofollow" class="external free">http://www.fosshub.com/Pale-Moon.html</a>
</li>
<li>
Using File -&gt; Open File, open the XPI from /xowa/bin/any/firefox/xowa_viewer/default/xowa_viewer.xpi
</li>
<li>
Set the jar location for "extensions.xowa_viewer.xowa_app" in about:config. See <a href="#Config" id="xolnki_2">Config</a> below
</li>
</ul>
<h3>
<span class="mw-headline" id="Firefox">Firefox</span>
</h3>
<p>
Note that you will need a version earlier than 43, or a developer / nightly build
</p>
<ul>
<li>
Using File -&gt; Open File, open the XPI from /xowa/bin/any/firefox/xowa_viewer/default/xowa_viewer.xpi
</li>
<li>
Set the jar location for "extensions.xowa_viewer.xowa_app" in about:config. See <a href="#Config" id="xolnki_3">Config</a> below
</li>
</ul>
<h2>
<span class="mw-headline" id="Toolbar">Toolbar</span>
</h2>
<p>
The Add-on installs an XOWA toolbar button called "XOWA Home". Users can enable it by doing the following:
</p>
<ul>
<li>
Right-click on any toolbar in Firefox
</li>
<li>
Choose "Customize"
</li>
<li>
Find the "XOWA Home" button and drag it to the toolbar
</li>
</ul>
<h2>
<span class="mw-headline" id="Features_and_Limitations">Features and Limitations</span>
</h2>
<p>
The XOWA viewer is a work in progress. XOWA needs to make changes to communicate with Firefox over TCP (right now it communicates directly with the embedded browser)
</p>
<p>
The following is a high-level list of supported features:
</p>
<ul>
<li>
On the Firefox Menu Bar, Tools -&gt; XOWA home will navigate to home/wiki/Main_Page
</li>
<li>
Navigate to a url by typing in the url with an xowa protocol. For example, <code>xowa:simple.wikipedia.org/wiki/Earth</code>
</li>
<li>
Click on any link, and it will open the page in Firefox
</li>
<li>
The following javascript libraries will work:
<ul>
<li>
MathJax
</li>
<li>
Reference tooltips
</li>
<li>
Sortable / collapsible
</li>
<li>
Timeline
</li>
<li>
Search-suggest
</li>
<li>
Wikidata JSON formatter
</li>
</ul>
</li>
<li>
Close the browser and the XOWA server will shut down.
</li>
</ul>
<p>
The following is a high-level list of current limitations (Note that these will be addressed in future builds):
</p>
<ul>
<li>
xowa-cmd links will not work. This includes links to Read, Edit, View HTML, Exit, and Bookmark this page. This requires support for the "xowa-cmd:" protocol
</li>
<li>
The following javascript related items will not work. They require support for calling Javascript in Firefox from XOWA.
<ul>
<li>
Options pages
</li>
<li>
Wiki import
</li>
</ul>
</li>
</ul>
<h2>
<span class="mw-headline" id="Config">Config</span>
</h2>
<p>
The addon has several options that can be configured.
</p>
<ul>
<li>
Navigate to about:config
</li>
<li>
Search for "extensions.xowa"
</li>
<li>
The most important item is "extensions.xowa_viewer.xowa_app". This needs to point to your local xowa.jar.
<ul>
<li>
On Windows, it may be C:\xowa\xowa_windows.jar
</li>
<li>
On Linux, it may be /home/user/your_user_name/xowa/xowa_linux.jar
</li>
<li>
On Mac OS X, it may be /Users/your_user_name/xowa/xowa_macosx.jar
</li>
</ul>
</li>
</ul>
<h2>
<span class="mw-headline" id="Developer:_Source_code">Developer: Source code</span>
</h2>
<p>
The source code is available under the Mozilla Public License at <a href="https://github.com/piotrex/XOWA-Addon" rel="nofollow" class="external text">gitub</a>.
</p>
<p>
It is also contained in the Addon itself. You can unzip the .xpi and examine any of the underlying files. The code is in javascript and there are no binary dependencies.
</p>
<h2>
<span class="mw-headline" id="Developer:_Install">Developer: Install</span>
</h2>
<ul>
<li>
Go to <a href="https://github.com/piotrex/XOWA-Addon" rel="nofollow" class="external free">https://github.com/piotrex/XOWA-Addon</a> and choose Download Zip
</li>
<li>
Extract the zip file
</li>
<li>
Navigate to the extension directory and add all its files / directories (chrome, content, install.rdf, etc.) to a new zip file called "xowa_viewer.zip". (You can use 7-zip or your favorite compression program)
</li>
<li>
Rename xowa_viewer.zip file to xowa_viewer.xpi
</li>
<li>
Open the xowa_viewer.xpi in Firefox
</li>
</ul>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

313
App/Xtn/Html/Popups.html Normal file
View File

@@ -0,0 +1,313 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Html/Popups - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Html/Popups</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
<b>XOWA Popups</b> appear when hovering over a link. They will show the first part of the page for the hovered link.
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Purpose"><span class="tocnumber">1</span> <span class="toctext">Purpose</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Usage"><span class="tocnumber">2</span> <span class="toctext">Usage</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#Background"><span class="tocnumber">3</span> <span class="toctext">Background</span></a>
</li>
<li class="toclevel-1 tocsection-4">
<a href="#Design_principles"><span class="tocnumber">4</span> <span class="toctext">Design principles</span></a>
</li>
<li class="toclevel-1 tocsection-5">
<a href="#Future_changes"><span class="tocnumber">5</span> <span class="toctext">Future changes</span></a>
</li>
<li class="toclevel-1 tocsection-6">
<a href="#Technical_details"><span class="tocnumber">6</span> <span class="toctext">Technical details</span></a>
<ul>
<li class="toclevel-2 tocsection-7">
<a href="#Words"><span class="tocnumber">6.1</span> <span class="toctext">Words</span></a>
</li>
<li class="toclevel-2 tocsection-8">
<a href="#Parser"><span class="tocnumber">6.2</span> <span class="toctext">Parser</span></a>
</li>
</ul>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Purpose">Purpose</span>
</h2>
<p>
<b>XOWA Popups</b> shows a preview of an article when hovering over a link. It has the following benefits:
</p>
<ul>
<li>
<b>No click</b>: Articles can be retrieved by <i>hovering</i> over a link rather than <i>clicking</i> on it.
</li>
<li>
<b>Same view</b>: The preview shows up in the same visual space as the current article, where the current text is still available.
</li>
</ul>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="Usage">Usage</span>
</h2>
<ul>
<li>
Hover over a link to popup a preview
</li>
<li>
Links in popups are also previewable. Note that only 2 popups can be visible at any point in time.
</li>
<li>
Hovering over the 2nd popup will display a 3rd popup, but the 1st popup will disappear.
</li>
<li>
Each popup has a control panel with the following commands
<ul>
<li>
Open popup's page in current tab
</li>
<li>
Open popup's page in new tab and switch focus to the new tab
</li>
<li>
Open popup's page in new tab but stay on current tab
</li>
<li>
Bookmark popup's page
</li>
<li>
Show more text from the popup's page
</li>
<li>
Show all text from the popup's page
</li>
<li>
Go to the Popup option page.
</li>
</ul>
</li>
</ul>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="Background">Background</span>
</h2>
<p>
<b>XOWA Popups</b> is based on MediaWiki's <a href="https://www.mediawiki.org/wiki/Extension:Hovercards" rel="nofollow" class="external text">Hovercards</a> and <a href="https://en.wikipedia.org/wiki/Wikipedia:Tools/Navigation_popups" rel="nofollow" class="external text">Navigation popups</a>. It does not aim to be an exact reproduction of either, but picks the best features from each.
</p>
<p>
The javascript was modified from Reference tooltips, which was kindly provided by <a href="https://de.wikipedia.org/wiki/Benzuter:Schnark" rel="nofollow" class="external text">Schnark</a>.
</p>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="Design_principles">Design principles</span>
</h2>
<p>
The following is a list of intentional design differences from MediaWiki's Hovercards and Navigation Popups:
</p>
<ul>
<li>
Popups retrieve as much text as possible, including sections, not just text from the introductory paragraphs. This behavior is necessary because:
<ul>
<li>
Wikis like Wiktionary don't have a concept of an introductory paragraph.
</li>
<li>
Many articles have very short introductory sentences, which do not provide much info.
</li>
</ul>
</li>
<li>
Popups are word based, not sentence based. There are some defects with MediaWiki's Hovercards which stops at abbreviations. For example, "St." counts as a sentence.
</li>
<li>
Popup lengths are customizable, not fixed (unlike MediaWiki Hovercards's 2 sentences)
</li>
<li>
Popups show links, lists, advanced formatting, and math equations.
</li>
</ul>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="Future_changes">Future changes</span>
</h2>
<ul>
<li>
<b>Redlinks</b>: Popups do not indicate missing links in red. This should be added within the next few releases
</li>
<li>
<b>Single image</b>: XOWA will provide a single image preview, just like MediaWiki Hovercards. However, it may be several weeks before this is included.
</li>
<li>
<b>Popup window management</b>: Popups are automatically hidden / shown based on mouse movement. A future version may provide the ability to "move", "pin", "close", etc. I may need some help with the javascript to do so. See: /xowa/bin/any/xowa/html/modules/xowa.popups/xowa.popups.js
</li>
<li>
<b>Performance</b>: Most articles should preview in less than one second, but some articles may take as long as 5. This performance will be improved whenever HTML dumps are included in XOWA, though this may be several months.
</li>
</ul>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="Technical_details">Technical details</span>
</h2>
<h3>
<span class="mw-headline" id="Words">Words</span>
</h3>
<p>
<b>XOWA Popups</b> has the following rules for words:
</p>
<ul>
<li>
A word is one or more characters terminated by a space, tab, new line, wikitext token, or end of document. For example, "A B C" is three words: 2 terminated by a space, and one by the end of the document. Meanwhile, "A[[B]]C" is three words, as <code>[[</code> and <code>]]</code> are wikitext tokens.
</li>
<li>
Words inside a &lt;table&gt;, &lt;div&gt;, [[File:]], or [[Category:]] are not included.
</li>
<li>
Words counts are not exact. Currently, the following rules govern word counts, but may change in the future:
<ul>
<li>
A header counts as one word. For example, "== A B C ==" is one word, not three.
</li>
<li>
The entire caption of an external link counts as one word. For example, "[http://a.org b c d]" is one word, not three.
</li>
</ul>
</li>
</ul>
<h3>
<span class="mw-headline" id="Parser">Parser</span>
</h3>
<p>
<b>XOWA Popups</b> uses a modified version of the XOWA parser. The popup parser has the following attributes:
</p>
<ul>
<li>
<b>Faster incremental parsing</b>: An article is parsed incrementally, in smaller pieces, rather than all at once. This allows for speedier, sub-second article views, which is important for large articles (&gt; 40 KB).
</li>
<li>
<b>Textual data only</b>: In keeping with both MediaWiki approaches, only textual data is shown. Tables, boxes (infoboxes, navboxes), and images are removed from the preview.
</li>
</ul>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

146
App/Xtn/Html/Scripts.html Normal file
View File

@@ -0,0 +1,146 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Html/Scripts - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Html/Scripts</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<h2>
<span class="mw-headline" id="Credits">Credits</span>
</h2>
<p>
Considerable thanks goes to <b>Schnark</b> for integrating MediaWiki's script for sortable and collapsible tables.
</p>
<h2>
<span class="mw-headline" id="Setup_notes">Setup notes</span>
</h2>
<ul>
<li>
Download the latest version of jquery from <a href="https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/core.git;a=tree;f=resources/jquery;h=8a58f7c31a0132f8c16b18b62cf5cc5f4aea5336;hb=master" rel="nofollow" class="external free">https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/core.git;a=tree;f=resources/jquery;h=8a58f7c31a0132f8c16b18b62cf5cc5f4aea5336;hb=master</a>
</li>
<li>
Copy the following files to <b>/xowa/bin/any/javascript/xowa/table_scripts/</b>
<ul>
<li>
jquery.js
</li>
<li>
jquery.makeCollapsible.js
</li>
<li>
jquery.tablesorter.js
</li>
</ul>
</li>
<li>
Create a text file called <b>/xowa/bin/any/javascript/xowa/table_scripts/xowa.ready.js</b>
</li>
</ul>
<dl>
<dd>
Save the most current contents of XOWA's xowa.ready.js file
</dd>
</dl>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

366
App/Xtn/Import/Dansguardian.html Normal file
View File

@@ -0,0 +1,366 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Import/Dansguardian - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Import/Dansguardian</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
XOWA allows custom creation of wikis by either excluding words or including words. The system is based on the <a href="http://dansguardian.org/" rel="nofollow" class="external text">Dansguardian</a> format: an open-source (GPLv2) system for filtering web-pages.
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Options"><span class="tocnumber">1</span> <span class="toctext">Options</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Phraselists"><span class="tocnumber">2</span> <span class="toctext">Phraselists</span></a>
<ul>
<li class="toclevel-2 tocsection-3">
<a href="#Location"><span class="tocnumber">2.1</span> <span class="toctext">Location</span></a>
</li>
<li class="toclevel-2 tocsection-4">
<a href="#Format"><span class="tocnumber">2.2</span> <span class="toctext">Format</span></a>
</li>
</ul>
</li>
<li class="toclevel-1 tocsection-5">
<a href="#Import_process"><span class="tocnumber">3</span> <span class="toctext">Import process</span></a>
</li>
<li class="toclevel-1 tocsection-6">
<a href="#Scoring"><span class="tocnumber">4</span> <span class="toctext">Scoring</span></a>
<ul>
<li class="toclevel-2 tocsection-7">
<a href="#Basic"><span class="tocnumber">4.1</span> <span class="toctext">Basic</span></a>
</li>
<li class="toclevel-2 tocsection-8">
<a href="#Multiplicity"><span class="tocnumber">4.2</span> <span class="toctext">Multiplicity</span></a>
</li>
</ul>
</li>
<li class="toclevel-1 tocsection-9">
<a href="#Exclusion"><span class="tocnumber">5</span> <span class="toctext">Exclusion</span></a>
</li>
<li class="toclevel-1 tocsection-10">
<a href="#Inclusion"><span class="tocnumber">6</span> <span class="toctext">Inclusion</span></a>
</li>
<li class="toclevel-1 tocsection-11">
<a href="#Manual_inclusion_.2F_exclusion"><span class="tocnumber">7</span> <span class="toctext">Manual inclusion / exclusion</span></a>
</li>
<li class="toclevel-1 tocsection-12">
<a href="#Other_notes"><span class="tocnumber">8</span> <span class="toctext">Other notes</span></a>
<ul>
<li class="toclevel-2 tocsection-13">
<a href="#Performance"><span class="tocnumber">8.1</span> <span class="toctext">Performance</span></a>
</li>
</ul>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Options">Options</span>
</h2>
<p>
See <a href="http://xowa.org/wiki/home/page/Options/Import_Dansguardian.html" id="xolnki_2" title="Options/Import Dansguardian" class="xowa-visited">Options/Import_Dansguardian</a>
</p>
<h2>
<span class="mw-headline" id="Phraselists">Phraselists</span>
</h2>
<h3>
<span class="mw-headline" id="Location">Location</span>
</h3>
<ul>
<li>
Phraselist files are located at <code>/xowa/bin/any/xowa/cfg/bldr/filter/wiki_name/dansguardian</code>. For example, on a Windows system, a phraselist file for simple.wikipedia.org can be placed at <code>C:\xowa\bin\any\xowa\cfg\bldr\filter\simple.wikipedia.org\dansguardian\phraselist1.txt</code>
</li>
<li>
Phraselist files can be placed in sub-directories for grouping purposes. For example, files can be placed at C:\xowa\bin\any\xowa\cfg\bldr\filter\simple.wikipedia.org\dansguardian\group1\phraselist1.txt and C:\xowa\bin\any\xowa\cfg\bldr\filter\simple.wikipedia.org\dansguardian\group2\phraselist2.txt
</li>
</ul>
<h3>
<span class="mw-headline" id="Format">Format</span>
</h3>
<p>
Phraselist files are plain text files with the following format:
</p>
<ul>
<li>
Each line is either a rule or a comment
</li>
<li>
Comments start with the hash sign: # . For example <code># this is a comment</code>
</li>
<li>
Each rule has one or more words enclosed in angle brackets (&lt; &gt;) and separated by commas. For example, <code>&lt; earth &gt;,&lt; mars &gt;</code>
</li>
<li>
Each rule ends with a score also enclosed in angle brackets. For example, <code>&lt;70&gt;</code>
</li>
</ul>
<h2>
<span class="mw-headline" id="Import_process">Import process</span>
</h2>
<p>
Phraselists are applied during import. The following process occurs:
</p>
<ul>
<li>
The import starts for a wiki
</li>
<li>
All phraselists for the wiki are loaded into memory.
</li>
<li>
Each article's wikitext is analyzed by the phraselists and generates a score.
<ul>
<li>
The article's "title" is not analyzed. Article titles generally have only one or two words, and are not useful for phraselist matching
</li>
<li>
The html is not analyzed. Note that this would slow down the import process dramatically. For example, for English Wikipedia, wikitext would only slow down the process from 2 hours 40 minutes to 3 hours. HTML would slow it down to 70 hours.
</li>
</ul>
</li>
</ul>
<p>
The entire wikitext is scanned including:
</p>
<ul>
<li>
Html tags: &lt;img some attributes/&gt;
</li>
<li>
Urls: https://upload.wikimedia.org
</li>
<li>
Comments
</li>
</ul>
<h2>
<span class="mw-headline" id="Scoring">Scoring</span>
</h2>
<h3>
<span class="mw-headline" id="Basic">Basic</span>
</h3>
<p>
A rule is matched if any part of the wikitext contains the words in the ruletext.
</p>
<p>
For example, let's says we wanted to build up a phraselist that allowed us to build a wiki without any astronomy articles. We could use something like the following:
</p>
<pre>
&lt; planet &gt;&lt;50&gt;
&lt; earth &gt;,&lt; planet &gt;&lt;30&gt;
</pre>
<p>
Now consider these short sample articles:
</p>
<ul>
<li>
An article with just the word "planet" would have a score of 50
</li>
<li>
An article with the words "earth planet something" would have a score of 80; 50 for matching "planet" and 30 for matching "earth" and " planet "
</li>
<li>
An article with just the word "earth" would have a score of 0. It needs to have the word "planet" to get a score of 30
</li>
</ul>
<h3>
<span class="mw-headline" id="Multiplicity">Multiplicity</span>
</h3>
<p>
Rules scores are multiplied based on occurrences.
</p>
<ul>
<li>
For example, if an article has the text "planet planet planet" then its score would be 150, not 50, because it matches the "planet" rule 3 times
</li>
<li>
Similarly "earth planet something earth planet something earth planet something" would have a score of 240 because it matches "earth planet" 3 times (90) and "planet" 3 times (150)
</li>
<li>
However "earth planet something earth planet something earth" only has a score of 160 because it only matches the "earth planet" rule 2 times "60" and the planet rule 2 times (100)
</li>
</ul>
<h2>
<span class="mw-headline" id="Exclusion">Exclusion</span>
</h2>
<p>
By default, anything that matches a rule (has a score &gt; 0) will be excluded. Note that this exclude number can be raised from 0 to something higher like 100. See <a href="http://xowa.org/wiki/home/page/Options/Import_Dansguardian.html" id="xolnki_3" title="Options/Import Dansguardian" class="xowa-visited">Options/Import_Dansguardian</a>
</p>
<h2>
<span class="mw-headline" id="Inclusion">Inclusion</span>
</h2>
<p>
The import filter can also be used to build content-specific wikis. For example, let's say you wanted to build a wiki that only <b>includes</b> articles with the words "planet" and "earth planet". The following can be done:
</p>
<ul>
<li>
Use the same phraselists as above, but negate the numbers:
</li>
</ul>
<pre>
&lt; planet &gt;&lt;-50&gt;
&lt; earth &gt;,&lt; planet &gt;&lt;-30&gt;
</pre>
<ul>
<li>
Change the initial score from 0 to 50
</li>
<li>
Leave the exclude score at 0
</li>
</ul>
<p>
When running the import, the following will happen:
</p>
<ul>
<li>
An article that has the words "earth planet something" will have a score of -30: the initial score of 50 plus the rule score of -80. Because -30 is less than the exclude score of 0, it will not be excluded.
</li>
<li>
An article that has the words "a b c" will still have its initial score of 50. Because 50 is greater than the exclude score of 0, it will be excluded
</li>
</ul>
<h2>
<span class="mw-headline" id="Manual_inclusion_.2F_exclusion">Manual inclusion / exclusion</span>
</h2>
<p>
The filter process also provides a way to list articles that will always be included / excluded, regardless of rule score.
</p>
<p>
For example, to always include the articles Earth and Sun, create the following text file:
</p>
<pre>
Earth
Sun
</pre>
<p>
Save it to <code>/xowa/bin/any/xowa/cfg/bldr/filter/wiki_name/xowa.title.exclude.txt</code> XOWA will read this list and always exclude the article
</p>
<p>
Similarly, to manually include an article, save the file to /xowa/bin/any/xowa/cfg/bldr/filter/wiki_name/xowa.title.include.txt
</p>
<h2>
<span class="mw-headline" id="Other_notes">Other notes</span>
</h2>
<h3>
<span class="mw-headline" id="Performance">Performance</span>
</h3>
<ul>
<li>
Note that a phraselist file can have many rules. The number of rules does not significantly slow down the runtime of the import-filter. For example, let's say Simple Wikipedia imports in 3 minutes with 100 rules. If there are 10,000 rules, the import should still take 3 minutes
</li>
<li>
However, the number of rules will affect the amount of memory required by the computer. For example, 100 rules may take 1 MB. 10,000 rules may take 10 MB.
</li>
</ul>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

202
App/Xtn/Mediawiki/Math/Latex/Linux.html Normal file
View File

@@ -0,0 +1,202 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Math/Latex/Linux - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Math/Latex/Linux</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Programs"><span class="tocnumber">1</span> <span class="toctext">Programs</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Paths"><span class="tocnumber">2</span> <span class="toctext">Paths</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#Options"><span class="tocnumber">3</span> <span class="toctext">Options</span></a>
</li>
<li class="toclevel-1 tocsection-4">
<a href="#Test"><span class="tocnumber">4</span> <span class="toctext">Test</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Programs">Programs</span>
</h2>
<ul>
<li>
latex should already be in your <b>/usr/bin</b> directory.
</li>
</ul>
<dl>
<dd>
If not, please consult your distribution's docs for more info.
</dd>
</dl>
<ul>
<li>
dvipng should already be in your <b>/usr/bin</b> directory.
</li>
</ul>
<dl>
<dd>
If not, do <code>sudo apt-get install dvipng</code>
</dd>
</dl>
<h2>
<span class="mw-headline" id="Paths">Paths</span>
</h2>
<p>
Note that XOWA assumes that LaT<sub>E</sub>X and dvipng have the following paths:
</p>
<ul>
<li>
<b>/usr/bin/latex</b>
</li>
<li>
<b>/usr/bin/dvipng</b>
</li>
</ul>
<p>
If these paths are different on your system, you will need to update the config file. Instructions are provided below. You may want to visit <a href="http://xowa.org/wiki/home/page/Dev/Config_files.html" id="xolnki_2" title="Dev/Config files">Dev/Config_files</a> for more information about config files.
</p>
<ul>
<li>
Open <b>/xowa/xowa.gfs</b> in a text editor.
</li>
<li>
Search for <code>.cmd_('/usr/bin/latex')</code>
</li>
<li>
Update the path to whatever it is on you system.
</li>
<li>
Repeat for the other paths
</li>
<li>
Save the file and restart XOWA.
</li>
</ul>
<h2>
<span class="mw-headline" id="Options">Options</span>
</h2>
<p>
The math module uses MathJax by default. You can change it to LaT<sub>E</sub>X by navigating to <a href="http://xowa.org/wiki/home/page/Options/Math.html" id="xolnki_3" title="Options/Math">Options/Math</a> and choosing LaTeX
</p>
<h2>
<span class="mw-headline" id="Test">Test</span>
</h2>
<ul>
<li>
Visit <a href="http://xowa.org/wiki/home/page/Diagnostics/Math.html" id="xolnki_4" title="Diagnostics/Math" class="xowa-visited">Diagnostics/Math</a>
</li>
</ul>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

113
App/Xtn/Mediawiki/Math/Latex/Mac_OS_X.html Normal file
View File

@@ -0,0 +1,113 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Math/Latex/Mac OS X - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Math/Latex/Mac OS X</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
XOWA currently has no instructions for Mac OS X. You can help by installing LaT<sub>E</sub>X and dvipng on our machine and posting your instructions. Please see <a href="http://xowa.org/wiki/home/page/Help/Feedback.html" id="xolnki_2" title="Help/Feedback" class="xowa-visited">Help/Feedback</a>.
</p>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

179
App/Xtn/Mediawiki/Math/Latex/Windows.html Normal file
View File

@@ -0,0 +1,179 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Math/Latex/Windows - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Math/Latex/Windows</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
LaT<sub>E</sub>X is not natively available to Windows. Fortunately, <a href="http://miktex.org/" rel="nofollow" class="external text">MiKT<sub>E</sub>X</a> is open-source and distributed under <a href="http://miktex.org/copying" rel="nofollow" class="external text">Free Software Guidelines</a>.
</p>
<h2>
<span class="mw-headline" id="Manual:_download">Manual: download</span>
</h2>
<ul>
<li>
Navigate to <a href="http://mirror.unl.edu/ctan/systems/win32/miktex/setup/" rel="nofollow" class="external free">http://mirror.unl.edu/ctan/systems/win32/miktex/setup/</a>
</li>
<li>
Download <b>miktex-portable.exe</b>
</li>
<li>
Launch the exe. Choose an installation directory of <b>C:\xowa\bin\windows\miktex\</b>. When you are done, you should have a file called <b>C:\xowa\bin\windows\miktex\miktex\bin\latex.exe</b>
</li>
</ul>
<p>
Note that you may receive some prompts along the way
</p>
<ul>
<li>
Paper size should be left to a4, else some images may wrap.
</li>
<li>
Under MiKTeX Settings, choose Refresh FNDB, else errors when generating other dvi
</li>
</ul>
<h2>
<span class="mw-headline" id="Manual:_options">Manual: options</span>
</h2>
<p>
The math module uses MathJax by default. You can change it to LaT<sub>E</sub>X by navigating to <a href="http://xowa.org/wiki/home/page/Options/Math.html" id="xolnki_2" title="Options/Math">Options/Math</a> and choosing LaTeX
</p>
<h2>
<span class="mw-headline" id="Testing">Testing</span>
</h2>
<ul>
<li>
Visit <a href="http://xowa.org/wiki/home/page/Diagnostics/Math.html" id="xolnki_3" title="Diagnostics/Math" class="xowa-visited">Diagnostics/Math</a>
</li>
<li>
Wait a few seconds. You will get a MikTeX prompt to download another repository. Specifically:
</li>
</ul>
<dl>
<dd>
<dl>
<dd>
<code>The package will be installed from: &lt;Random package repository&gt;</code>
</dd>
<dd>
<code>The package will be installed for: &lt;your_user_name&gt;</code>
</dd>
</dl>
</dd>
<dd>
Accept the defaults and press Install
</dd>
<dd>
This should be the only other download request when using MikTeX.
</dd>
<dd>
Note that the first request may take a full minute to process and there will be no progress indicator.
</dd>
<dd>
Note also that this message box may disrupt dynamic math updates. You will need to manually refresh the page in order to see the math image. This manual refresh is only needed for the first page; future pages will automatically update images dynamically.
</dd>
</dl>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

247
App/Xtn/Mediawiki/Math/MathJax.html Normal file
View File

@@ -0,0 +1,247 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Math/MathJax - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Math/MathJax</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<h2>
<span class="mw-headline" id="Credits">Credits</span>
</h2>
<p>
Considerable thanks goes to Schnark for proposing and implementing the <a href="http://www.mathjax.org/" rel="nofollow" class="external text">MathJax</a> integration.
</p>
<h2>
<span class="mw-headline" id="Setup_notes">Setup notes</span>
</h2>
<p>
The following is a list of setup notes for MathJax:
</p>
<ul>
<li>
Get latest of Math Extension: <a href="http://www.mediawiki.org/wiki/Extension:Math" rel="nofollow" class="external free">http://www.mediawiki.org/wiki/Extension:Math</a> or <a href="https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/Math.git;a=snapshot;h=refs/heads/master;sf=tgz" rel="nofollow" class="external free">https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/Math.git;a=snapshot;h=refs/heads/master;sf=tgz</a>
</li>
<li>
Unzip to <b>/xowa/bin/any/javascript/xowa/mathjax_temp/</b>. When you are done you should have <b>/xowa/bin/any/javascript/xowa/mathjax_temp/Math.php</b> and many other files
</li>
<li>
Move <b>/xowa/bin/any/javascript/xowa/mathjax_temp/modules/Mathjax</b> to <b>/xowa/bin/any/javascript/xowa/mathjax/</b>. When you are done you will have a file called <b>/xowa/bin/any/javascript/xowa/mathjax/Mathjax.js</b> as well as many others. (We basically want to ignore everything except for the inner modules/Mathjax directory)
</li>
<li>
Edit the following file: <b>/xowa/bin/any/javascript/xowa/mathjax/extensions/wiki2jax.js</b>
</li>
</ul>
<p>
replace this:
</p>
<pre>
$('span.tex, img.tex', element || document).each(function(i, span) {
that.ConvertMath(span);
});
</pre>
<p>
with this:
</p>
<pre>
var math = document.querySelectorAll('[id^="xowa_math_txt"]');
for (var i = 0; i &lt; math.length; i++) {
that.ConvertMath(math[i]);
}
</pre>
<ul>
<li>
In the same file:
</li>
</ul>
<p>
replace this:
</p>
<pre>
tex = $(node).text().replace(/^\$/,"").replace(/\$$/,"");
</pre>
<p>
with this:
</p>
<pre>
tex = node.textContent.replace(/^\$/,"").replace(/\$$/,""); //patched for XOWA
</pre>
<ul>
<li>
Create a text file at <b>/xowa/bin/any/javascript/xowa/mathjax/xowa_mathjax.js</b> and add the following
</li>
</ul>
<pre>
document.addEventListener( "DOMContentLoaded", function(){
var math = document.querySelectorAll('[id^="xowa_math_txt"]');
if (math.length) {
window.mathJax_Config = function () {
MathJax.Hub.Config({
root: window.xowa_root_dir + 'bin/any/javascript/xowa/mathjax',
config: ["TeX-AMS-texvc_HTML.js"],
"v1.0-compatible": false,
styles: { ".mtext": { "font-family": "sans-serif ! important", "font-size": "80%" } },
displayAlign: "left",
menuSettings: { zoom: "Click" },
"HTML-CSS": { imageFont: null, availableFonts: ["TeX"] }
});
MathJax.OutputJax.fontDir = window.xowa_root_dir + 'bin/any/javascript/xowa/mathjax/fonts';
}
var config = 'mathJax_Config();',
script1 = document.createElement( 'script' ),
script2 = document.createElement( 'script' );
script1.setAttribute( 'type', 'text/x-mathjax-config' );
script1.text = config;
document.getElementsByTagName('head')[0].appendChild( script1 );
script2.setAttribute( 'src', window.xowa_root_dir + 'bin/any/javascript/xowa/math/mathjax/MathJax.js?config=default' );
document.getElementsByTagName('head')[0].appendChild( script2 );
}
}, false );
</pre>
<ul>
<li>
Change "menuSettings:" in <b>/xowa/bin/javascript/xowa/math/mathjax/config/default.js</b>
<ul>
<li>
add 'renderer: "SVG"'
</li>
<li>
change 'texHints: false'
</li>
</ul>
</li>
</ul>
<p>
Example
</p>
<pre>
menuSettings: {
renderer: "SVG", // XOWA: manually specify SVG b/c HTML/CSS fails with "Can't Load Web Font TeX/Math/Italic"
texHints: false // XOWA: include class names for TeXAtom elements; changed from true to false, b/c it sometimes crashes XOWA
},
</pre>
<dl>
<dd>
Note that xowa_mathjax.js will use the config since it calls '/MathJax.js?config=default'
</dd>
</dl>
<ul>
<li>
Change "blacker" from 10 to 1 b/c 1 looks closer to the HTML/CSS renderer and 10 looks too "blocky"
</li>
</ul>
<pre>
blacker: 1, // XOWA: changed from 10 to 1 b/c 1 looks closer to the HTML/CSS renderer and 10 looks too "blocky"
</pre>
<ul>
<li>
Embed this in the xowa.gfs file (XOWA does this through ~{math_mathjax_script})
</li>
</ul>
<pre>
&lt;script src="file:///xowa/bin/any/javascript/xowa/mathjax/xowa_mathjax.js"&gt;&lt;/script&gt;
</pre>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

208
App/Xtn/Mediawiki/Math/Setup.html Normal file
View File

@@ -0,0 +1,208 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Math/Setup - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Math/Setup</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
Math formulas (of the form <code>&lt;math&gt;a^2 + b^2 = c^2&lt;/math&gt;</code>) will need LaT<sub>E</sub>X support.
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#MathJax"><span class="tocnumber">1</span> <span class="toctext">MathJax</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#LaTEX"><span class="tocnumber">2</span> <span class="toctext">LaTEX</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#MathJax_compared_to_XOWA_LaTEX"><span class="tocnumber">3</span> <span class="toctext">MathJax compared to XOWA LaTEX</span></a>
</li>
<li class="toclevel-1 tocsection-4">
<a href="#MathJax_developer_notes"><span class="tocnumber">4</span> <span class="toctext">MathJax developer notes</span></a>
</li>
<li class="toclevel-1 tocsection-5">
<a href="#Test"><span class="tocnumber">5</span> <span class="toctext">Test</span></a>
</li>
<li class="toclevel-1 tocsection-6">
<a href="#Notes"><span class="tocnumber">6</span> <span class="toctext">Notes</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="MathJax">MathJax</span>
</h2>
<p>
XOWA uses MathJax<sup id="cite_ref-mathjax_0-0" class="reference"><a href="#cite_note-mathjax-0">[1]</a></sup> as the default method for LaT<sub>E</sub>X support. No additional setup is required, and performance will often be quicker than a standard LaT<sub>E</sub>X application.
</p>
<h2>
<span class="mw-headline" id="LaTEX">LaT<sub>E</sub>X</span>
</h2>
<p>
XOWA also supports LaT<sub>E</sub>X for those users who prefer to work directly with the application.
</p>
<p>
If you wish to set up LaT<sub>E</sub>X, then please click one of these links:
</p>
<dl>
<dd>
<a href="http://xowa.org/wiki/home/page/App/Xtn/Mediawiki/Math/Latex/Windows.html" id="xolnki_2" title="App/Xtn/Mediawiki/Math/Latex/Windows">Set up math (Windows)</a>
</dd>
<dd>
<a href="http://xowa.org/wiki/home/page/App/Xtn/Mediawiki/Math/Latex/Linux.html" id="xolnki_3" title="App/Xtn/Mediawiki/Math/Latex/Linux" class="xowa-visited">Set up math (Linux)</a>
</dd>
<dd>
<a href="http://xowa.org/wiki/home/page/App/Xtn/Mediawiki/Math/Latex/Mac_OS_X.html" id="xolnki_4" title="App/Xtn/Mediawiki/Math/Latex/Mac OS X">Set up math (Mac OS X)</a>
</dd>
</dl>
<h2>
<span class="mw-headline" id="MathJax_compared_to_XOWA_LaTEX">MathJax compared to XOWA LaT<sub>E</sub>X</span>
</h2>
<p>
Here is a quick summary of the differences between MathJax vs XOWA LaT<sub>E</sub>X:
</p>
<ul>
<li>
MathJax is a javascript approach that will work cross-platform. LaT<sub>E</sub>X relies on platform specific binaries, which take up several hundred MBs.
</li>
<li>
MathJax will be faster in generating multiple images for the first time view. As a rough comparison, a page with 100 formulas will take MathJax &lt; 5 seconds, whereas LaT<sub>E</sub>X may take as long as a minute. (the latter is because XOWA generates a png for each formula)
</li>
<li>
MathJax has more dynamic rendering options, including "zoom" and different renderers (HTML-CSS, MathML, SVG). XOWA's LaT<sub>E</sub>X support is basic.
</li>
<li>
XOWA LaT<sub>E</sub>X will be faster in generating multiple images for successive views (second, third, fourth, etc). XOWA's LaT<sub>E</sub>X will cache the images on the hard drive and display them more quickly than Mathjax can generate them.
</li>
</ul>
<h2>
<span class="mw-headline" id="MathJax_developer_notes">MathJax developer notes</span>
</h2>
<p>
For more info on how Mathjax was integrated into XOWA, please see <a href="http://xowa.org/wiki/home/page/Help:Component/MathJax.html" id="xolnki_5" title="Help:Component/MathJax">Help:Component/MathJax</a>.
</p>
<h2>
<span class="mw-headline" id="Test">Test</span>
</h2>
<ul>
<li>
Visit <a href="http://xowa.org/wiki/home/page/Diagnostics/Math.html" id="xolnki_6" title="Diagnostics/Math" class="xowa-visited">Diagnostics/Math</a>
</li>
</ul>
<h2>
<span class="mw-headline" id="Notes">Notes</span>
</h2>
<ol class="references">
<li id="cite_note-mathjax-0">
<span class="mw-cite-backlink"><a href="#cite_ref-mathjax_0-0">^</a></span> <span class="reference-text">For more info on MathJax, please visit <a href="http://www.mathjax.org/" rel="nofollow" class="external free">http://www.mathjax.org/</a></span>
</li>
</ol>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

239
App/Xtn/Mediawiki/Score.html Normal file
View File

@@ -0,0 +1,239 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Score - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Score</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<p>
The <a href="https://www.mediawiki.org/wiki/Extension:Score" rel="nofollow" class="external text">Score Extension</a> transforms LilyPond or ABC markup into musical scores and / or midis
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Installation"><span class="tocnumber">1</span> <span class="toctext">Installation</span></a>
<ul>
<li class="toclevel-2 tocsection-2">
<a href="#Windows"><span class="tocnumber">1.1</span> <span class="toctext">Windows</span></a>
</li>
<li class="toclevel-2 tocsection-3">
<a href="#Linux_.28Ubuntu.2C_Mint.29"><span class="tocnumber">1.2</span> <span class="toctext">Linux (Ubuntu, Mint)</span></a>
</li>
<li class="toclevel-2 tocsection-4">
<a href="#Mac_OS_X"><span class="tocnumber">1.3</span> <span class="toctext">Mac OS X</span></a>
</li>
</ul>
</li>
<li class="toclevel-1 tocsection-5">
<a href="#Configuration"><span class="tocnumber">2</span> <span class="toctext">Configuration</span></a>
</li>
<li class="toclevel-1 tocsection-6">
<a href="#Testing"><span class="tocnumber">3</span> <span class="toctext">Testing</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Installation">Installation</span>
</h2>
<p>
The Score extension depends on LilyPond. This package is fairly large (90 MB) and not portable (i.e.: it must be installed).
</p>
<p>
The following are installation instructions per operating system.
</p>
<h3>
<span class="mw-headline" id="Windows">Windows</span>
</h3>
<ul>
<li>
Go to the <a href="http://www.lilypond.org/windows.html" rel="nofollow" class="external text">LilyPond Windows download page</a> and download the "Windows: LilyPond *.**.*-*" package. At time of writing, this link is "Windows: LilyPond 2.16.2-1"
</li>
<li>
Run the exe. Choose the default installation path (C:\Program Files\Lilypond) or your XOWA bin directory (C:\xowa\bin\windows\lilypond)
</li>
</ul>
<h3>
<span class="mw-headline" id="Linux_.28Ubuntu.2C_Mint.29">Linux (Ubuntu, Mint)</span>
</h3>
<ul>
<li>
Open up a terminal and run the following:
</li>
</ul>
<p>
<code>sudo apt-get install lilypond</code>
</p>
<dl>
<dd>
This should install to /usr/bin/
</dd>
</dl>
<h3>
<span class="mw-headline" id="Mac_OS_X">Mac OS X</span>
</h3>
<p>
[Note: No testing has been done with Mac OS X machines, so these are best guesses]
</p>
<ul>
<li>
Go to the <a href="http://www.lilypond.org/macos-x.html" rel="nofollow" class="external text">LilyPond Mac OS Xdownload page</a> and download the proper "MacOS X *.**.*-*" package.
</li>
<li>
Install the package. It should install to /bin/
</li>
</ul>
<h2>
<span class="mw-headline" id="Configuration">Configuration</span>
</h2>
<p>
After the installation completes, you will need to specify the directory.
</p>
<ul>
<li>
Go to <a href="http://xowa.org/wiki/home/page/Options/Score.html" id="xolnki_2" title="Options/Score">Options/Score</a>.
</li>
<li>
Configure the <b>lilypond</b> binary to whatever directory you chose above.
</li>
</ul>
<dl>
<dd>
For Windows, that will probably be "C:\Program Files\Lilypond\usr\bin\lilypond.exe"
</dd>
<dd>
For Linux, that will probably be "/usr/bin/lilypond"
</dd>
<dd>
For Mac OS X, that will probably be "/bin/lilypond"
</dd>
</dl>
<ul>
<li>
Configure the <b>abc2ly</b> binary
</li>
</ul>
<dl>
<dd>
For Windows, that will probably be "C:\Program Files\Lilypond\usr\bin\python" (note that lilypond ships with python)
</dd>
<dd>
For Linux, that will probably be "/usr/bin/python" (note that the abc2ly.py script must be in the same directory as python)
</dd>
<dd>
For Mac OS X, that will probably be "/bin/python". (note that the abc2ly.py script must be in the same directory as python)
</dd>
</dl>
<h2>
<span class="mw-headline" id="Testing">Testing</span>
</h2>
<p>
When you're done, visit <a href="http://xowa.org/wiki/home/page/Diagnostics.html" id="xolnki_3" title="Diagnostics" class="xowa-visited">Diagnostics</a> and click on the Score links
</p>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

1112
App/Xtn/Mediawiki/Scribunto/Luaj.html Normal file
View File

File diff suppressed because it is too large Load Diff

372
App/Xtn/Mediawiki/Scribunto/Overview.html Normal file
View File

@@ -0,0 +1,372 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Scribunto/Overview - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Scribunto/Overview</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Background"><span class="tocnumber">1</span> <span class="toctext">Background</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Status"><span class="tocnumber">2</span> <span class="toctext">Status</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#Engines"><span class="tocnumber">3</span> <span class="toctext">Engines</span></a>
</li>
<li class="toclevel-1 tocsection-4">
<a href="#Lua"><span class="tocnumber">4</span> <span class="toctext">Lua</span></a>
<ul>
<li class="toclevel-2 tocsection-5">
<a href="#Binaries"><span class="tocnumber">4.1</span> <span class="toctext">Binaries</span></a>
</li>
<li class="toclevel-2 tocsection-6">
<a href="#Permissions"><span class="tocnumber">4.2</span> <span class="toctext">Permissions</span></a>
</li>
</ul>
</li>
<li class="toclevel-1 tocsection-7">
<a href="#Luaj"><span class="tocnumber">5</span> <span class="toctext">Luaj</span></a>
</li>
<li class="toclevel-1 tocsection-8">
<a href="#Scribunto_files"><span class="tocnumber">6</span> <span class="toctext">Scribunto files</span></a>
</li>
<li class="toclevel-1 tocsection-9">
<a href="#Links"><span class="tocnumber">7</span> <span class="toctext">Links</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Background">Background</span>
</h2>
<p>
Scribunto is a MediaWiki extension for embedding Lua code in wiki pages. Lua is used for programming constructs (conditional logic; loops) that were previously attempted by Templates.
</p>
<p>
For more information on Scribunto, see <a href="http://www.mediawiki.org/wiki/Extension:Scribunto" rel="nofollow" class="external free">http://www.mediawiki.org/wiki/Extension:Scribunto</a>
</p>
<p>
For the source code, see <a href="https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/Scribunto.git;a=summary" rel="nofollow" class="external free">https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/Scribunto.git;a=summary</a>
</p>
<h2>
<span class="mw-headline" id="Status">Status</span>
</h2>
<p>
The Wikimedia Foundation began rolling out Scribunto/Lua to its sites on 2013-02-15 and finished on 2013-03-13 (<a href="http://blog.wikimedia.org/2013/03/14/what-lua-scripting-means-wikimedia-open-source/" rel="nofollow" class="external free">http://blog.wikimedia.org/2013/03/14/what-lua-scripting-means-wikimedia-open-source/</a> . Data dumps after 2013-02-15 will probably have {{#invoke}} in their wikitext, which requires a lua processor.
</p>
<p>
Beginning with v0.3.2, XOWA included preliminary support for Scribunto. As of v1.3.1, the functionality level is approximately 95%+.
</p>
<h2>
<span class="mw-headline" id="Engines">Engines</span>
</h2>
<p>
XOWA provides two engines for processing Lua statements:
</p>
<ul>
<li>
<a href="http://lua.org/about" rel="nofollow" class="external text">lua</a>: the standard lua binary that is distributed with Scribunto. For MediaWiki developers, it is the <i>LuaStandalone</i> approach.
</li>
</ul>
<dl>
<dd>
<span style='text-decoration:underline'><b>advantages</b></span>
<ul>
<li>
<b>standard</b>: lua is the official reference standard
</li>
<li>
<b>performance</b>: lua is written in C which is highly performant. However...
</li>
</ul>
</dd>
<dd>
<span style='text-decoration:underline'><b>disadvantages</b></span>
<ul>
<li>
<b>performance</b>: lua needs every message to be serialized when communicating back and forth between the binary and Java (the same behavior as LuaStandalone). This can result in performance issues.
</li>
<li>
<b>limited platform support</b>: lua needs a binary compiled specifically for its OS. Although the major OSs are provided, some other OSs will require additional steps: See openSUSE 11.0 and <a href="#Binaries" id="xolnki_2">Binaries</a> below.
</li>
<li>
<b>permission setup</b>: lua needs to be granted execute permissions on Linux and Mac OS X. Although XOWA does this automatically, there may be complications. See <a href="#Permissions" id="xolnki_3">Permissions</a> below.
</li>
</ul>
</dd>
</dl>
<ul>
<li>
<a href="http://luaj.org/luaj/README.html" rel="nofollow" class="external text">luaj</a>: an open-source Java implementation of lua.
</li>
</ul>
<dl>
<dd>
<span style='text-decoration:underline'><b>advantages</b></span>
<ul>
<li>
<b>universal platform support</b>: luaj is written in Java and will automatically run on any platform that XOWA runs on
</li>
<li>
<b>consistent behavior</b>: luaj will run the same on all platforms. In contrast, lua will run differently on Windows versus Linux / Mac OS X (see os.time and mktime)
</li>
<li>
<b>easier customization</b>: luaj can be easily customized. In contrast, lua requires experience with C, and recompiling the source for each platform
</li>
<li>
<b>performance</b>: luaj runs in the same memory space as XOWA, and doesn't require message serializations for every call. In addition, the lua binary may not perform consistently on every OS. For some OSs, this makes a considerable difference. For example, it is reported that luaj runs dramatically faster than lua on Windows Vista (seconds versus minutes). However...
</li>
</ul>
</dd>
<dd>
<span style='text-decoration:underline'><b>disadvantages</b></span>
<ul>
<li>
<b>performance</b>: luaj is written in Java which is not as performant as C
</li>
</ul>
</dd>
</dl>
<p>
Luaj is the official Lua processor for XOWA.
</p>
<h2>
<span class="mw-headline" id="Lua">Lua</span>
</h2>
<h3>
<span class="mw-headline" id="Binaries">Binaries</span>
</h3>
<p>
XOWA packages the same Lua binaries (v5.1) that come with Scribunto. Note the following:
</p>
<ul>
<li>
The Windows, Linux, Linux 64, Mac OS X and Mac OS X 64 binaries have all been tested.
</li>
<li>
The Linux binaries may not work on older distributions. For example, the Linux 64 binary does not work on openSUSE 11.0. In these cases, you will need to get a lua binary for your distribution, or compile it manually.
</li>
<li>
XOWA/Lua has been tested on a Windows 7 64-bit machine. Note that the Windows 32-bit Lua binary is included, not the 64-bit one.
</li>
</ul>
<h3>
<span class="mw-headline" id="Permissions">Permissions</span>
</h3>
<p>
Linux / Mac OS X users will need to grant Execute permission to the Lua binary. Note that XOWA tries to do this automatically. If it fails, you will need to handle it manually by doing any one of the following (note you will need to replace &lt;OS&gt; with your system):
</p>
<ul>
<li>
Run the setup shell script
</li>
</ul>
<dl>
<dd>
Run <code>sh /xowa/setup_&lt;OS&gt;.sh script</code>
</dd>
</dl>
<ul>
<li>
Manually setup lua
</li>
</ul>
<dl>
<dd>
Run <code>mv -f /xowa/bin/&lt;OS&gt;/lua/lua_install /xowa/bin/&lt;OS&gt;/lua/lua</code>
</dd>
<dd>
Run <code>chmod 774 /xowa/bin/&lt;OS&gt;/lua/lua</code>
</dd>
</dl>
<ul>
<li>
Use a pre-existing lua
</li>
</ul>
<dl>
<dd>
Change the "Lua path" binary to one on your machine (which presumably has the correct permissions) (EX: /usr/bin/lua)
</dd>
</dl>
<h2>
<span class="mw-headline" id="Luaj">Luaj</span>
</h2>
<p>
XOWA packages a modified version of the luaj-jse-3.0 jar. Note that 3.0 was selected as it is the latest code branch and it fixes errors in 2.0.3.
</p>
<p>
Several changes were made to the default 3.0 version to accomodate issues. These changes are itemized at /xowa/bin/any/java/luaj/readme.txt as well as <a href="http://xowa.org/wiki/home/page/App/Xtn/Mediawiki/Scribunto/Luaj.html" id="xolnki_4" title="App/Xtn/Mediawiki/Scribunto/Luaj">App/Xtn/Mediawiki/Scribunto/Luaj</a>. The modified source is available at <a href="https://github.com/gnosygnu/luaj_xowa" rel="nofollow" class="external free">https://github.com/gnosygnu/luaj_xowa</a>
</p>
<p>
Additional files are also at <code>/xowa/bin/any/php/mediawiki/extensions/Scribunto/engines/Luaj/</code>
</p>
<h2>
<span class="mw-headline" id="Scribunto_files">Scribunto files</span>
</h2>
<p>
XOWA used the following files from Scribunto:
</p>
<ul>
<li>
The main Lua libraries: mw_main.lua, MWServer.lua
</li>
</ul>
<dl>
<dd>
<code>source: /mediawiki-1.21.11/extensions/Scribunto/engines/LuaStandalone/</code>
</dd>
<dd>
<code>target: /xowa/bin/any/php/mediawiki/extensions/Scribunto/engines/LuaStandalone/</code>
</dd>
</dl>
<ul>
<li>
The lualib directory hive
</li>
</ul>
<dl>
<dd>
<code>source: /mediawiki-1.21.11/extensions/Scribunto/engines/LuaCommon/lualib/</code>
</dd>
<dd>
<code>target: /xowa/bin/any/php/mediawiki/extensions/Scribunto/engines/LuaCommon/lualib/</code>
</dd>
</dl>
<ul>
<li>
The Lua binary for the appropriate OS
</li>
</ul>
<dl>
<dd>
<code>source: /mediawiki-1.21.11/extensions/Scribunto/engines/LuaStandalone/binaries/&lt;OS&gt;/</code>
</dd>
<dd>
<code>target: /xowa/bin/&lt;OS&gt;/lua</code>
</dd>
</dl>
<p>
XOWA modifies many of the lua files in order to cache library data across multiple page loads (Scribunto reloads the libraries for every page)
</p>
<h2>
<span class="mw-headline" id="Links">Links</span>
</h2>
<ul>
<li>
For Options see <a href="http://xowa.org/wiki/home/page/Options/Scribunto.html" id="xolnki_5" title="Options/Scribunto">Options/Scribunto</a>
</li>
<li>
For Diagnostics see <a href="http://xowa.org/wiki/home/page/Diagnostics.html#Scribunto" id="xolnki_6" title="Diagnostics">Diagnostics#Scribunto</a>
</li>
</ul>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

331
App/Xtn/Mediawiki/Tidy/JTidy.html Normal file
View File

@@ -0,0 +1,331 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Tidy/JTidy - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Tidy/JTidy</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#Source"><span class="tocnumber">1</span> <span class="toctext">Source</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Modifications"><span class="tocnumber">2</span> <span class="toctext">Modifications</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#jtidy_xowa_changes"><span class="tocnumber">3</span> <span class="toctext">jtidy_xowa changes</span></a>
<ul>
<li class="toclevel-2 tocsection-4">
<a href="#ParseBlock_should_handle_exiled_variable_during_element_reparenting"><span class="tocnumber">3.1</span> <span class="toctext">ParseBlock should handle exiled variable during element reparenting</span></a>
</li>
<li class="toclevel-2 tocsection-5">
<a href="#Do_not_trim_empty_block_element_if_it_has_attributes"><span class="tocnumber">3.2</span> <span class="toctext">Do not trim empty block element if it has attributes</span></a>
</li>
<li class="toclevel-2 tocsection-6">
<a href="#Do_not_convert_empty_.3Cp.3E_to_.3Cbr.3E"><span class="tocnumber">3.3</span> <span class="toctext">Do not convert empty &lt;p&gt; to &lt;br&gt;</span></a>
</li>
<li class="toclevel-2 tocsection-7">
<a href="#Do_not_add_.5Cn_after_.3Cspan.3E_in_.3Cpre.3E"><span class="tocnumber">3.4</span> <span class="toctext">Do not add \n after &lt;span&gt; in &lt;pre&gt;</span></a>
</li>
</ul>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="Source">Source</span>
</h2>
<p>
The jtidy_xowa.jar was built using the source at <a href="https://sourceforge.net/projects/jtidy/files/JTidy/r938/" rel="nofollow" class="external free">https://sourceforge.net/projects/jtidy/files/JTidy/r938/</a>.
</p>
<p>
Its source is not currently included with XOWA. It is available at the following location: <a href="https://sourceforge.net/projects/xowa/files/support/jtidy/" rel="nofollow" class="external free">https://sourceforge.net/projects/xowa/files/support/jtidy/</a>
</p>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="Modifications">Modifications</span>
</h2>
<p>
The jtidy_xowa.jar was created for the following reasons:
</p>
<ul>
<li>
JTidy is not completely in sync with tidy:
</li>
</ul>
<dl>
<dd>
JTidy appears to have been built off an earlier version of tidy. tidy has since made a number of bug fixes that are not in JTidy
</dd>
</dl>
<ul>
<li>
JTidy has significant differences in translating tidy
</li>
</ul>
<dl>
<dd>
JTidy is a very close translation of tidy, but deviates from tidy in a number of places.
</dd>
</dl>
<p>
<br>
</p>
<h2>
<span class="mw-headline" id="jtidy_xowa_changes">jtidy_xowa changes</span>
</h2>
<p>
The following is only a partial list of JTidy changes. Multiple changes were made for v1.6.2.1 of XOWA to have JTidy be more "tidy-like". In addition, more changes will probably occur in the future to close the gap in source code between tidy and JTidy.
</p>
<h3>
<span class="mw-headline" id="ParseBlock_should_handle_exiled_variable_during_element_reparenting">ParseBlock should handle exiled variable during element reparenting</span>
</h3>
<ul>
<li>
<b>purpose</b>: &lt;div&gt; between &lt;table&gt; and &lt;tr&gt; not reparented correctly;
</li>
<li>
<b>example</b>: fa.wikinews.org/wiki/Main_Page -&gt; invalid table layout
</li>
<li>
<b>file</b>: /jtidy-r938/src/main/java/org/w3c/tidy/ParserImpl.java
</li>
<li>
<b>proc</b>: ParseBlock.Parse
</li>
<li>
<b>add</b>:
</li>
</ul>
<pre>
else if ((node.tag.model &amp; Dict.CM_TABLE) != 0 || (node.tag.model &amp; Dict.CM_ROW) != 0)
{
// XOWA: DATE:2014-05-31
/* http://tidy.sf.net/issue/1316307 */
/* In exiled mode, return so table processing can
continue. */
if (lexer.exiled)
return;
</pre>
<p>
<br>
</p>
<h3>
<span class="mw-headline" id="Do_not_trim_empty_block_element_if_it_has_attributes">Do not trim empty block element if it has attributes</span>
</h3>
<ul>
<li>
<b>purpose</b>: empty block elements should not be trimmed if they have attributes
</li>
<li>
<b>example</b>: ko.wikisource.org/wiki/Main_Page -&gt; invalid table layout
</li>
<li>
<b>file</b>: /jtidy-r938/src/main/java/org/w3c/tidy/Lexer.java
</li>
<li>
<b>proc</b>: canPrune
</li>
<li>
<b>add</b>:
</li>
</ul>
<pre>
// XOWA: added to match tidy; DATE:2014-05-31
if ( ((element.tag.model &amp; Dict.CM_BLOCK) != 0) &amp;&amp; element.attributes != null)
return false;
if (element.tag == this.configuration.tt.tagA &amp;&amp; element.attributes != null)
</pre>
<p>
<br>
</p>
<h3>
<span class="mw-headline" id="Do_not_convert_empty_.3Cp.3E_to_.3Cbr.3E">Do not convert empty &lt;p&gt; to &lt;br&gt;</span>
</h3>
<ul>
<li>
<b>purpose</b>: commented code to convert empty &lt;p&gt; to &lt;br&gt; because it is not in tidy
</li>
<li>
<b>example</b>: none
</li>
<li>
<b>file</b>: /jtidy-r938/src/main/java/org/w3c/tidy/Node.java
</li>
<li>
<b>proc</b>: trimEmptyElement
</li>
<li>
<b>code</b>:
</li>
</ul>
<pre>
// XOWA: DELETED: not in tidy, and don't really agree with intent; DATE:2014-05-31
// else if (element.tag == tt.tagP &amp;&amp; element.content == null)
// {
// // replace &lt;p&gt;&lt;/p&gt; by &lt;br&gt;&lt;br&gt; to preserve formatting
// Node node = lexer.inferredTag("br");
// Node.coerceNode(lexer, element, tt.tagBr);
// element.insertNodeAfterElement(node);
// }
</pre>
<p>
<br>
</p>
<h3>
<span class="mw-headline" id="Do_not_add_.5Cn_after_.3Cspan.3E_in_.3Cpre.3E">Do not add \n after &lt;span&gt; in &lt;pre&gt;</span>
</h3>
<ul>
<li>
<b>purpose</b>: JTidy was incorrectly adding \n to all block elements inside pre
</li>
<li>
<b>example</b>: none
</li>
<li>
<b>file</b>: /jtidy-r938/src/main/java/org/w3c/tidy/PPrint.java
</li>
<li>
<b>proc</b>: printTag
</li>
<li>
<b>code</b>:
</li>
</ul>
<pre>
if (indent + linelen &lt; this.configuration.wraplen)
{
// wrap after start tag if is &lt;br/&gt; or if it's not inline
// fix for [514348]
if (!TidyUtils.toBoolean(mode &amp; NOWRAP)
&amp;&amp; (!TidyUtils.toBoolean(node.tag.model &amp; Dict.CM_INLINE) || (node.tag == tt.tagBr))
&amp;&amp; afterSpace(node))
{
wraphere = linelen;
}
}
// XOWA: DATE:2014-06-01
/* flush the current buffer only if it is known to be safe,
i.e. it will not introduce some spurious white spaces.
See bug #996484 */
else if ( TidyUtils.toBoolean(mode &amp; NOWRAP)
|| node.tag == tt.tagBr
|| afterSpace(node)
)
{
condFlushLine(fout, indent);
}
</pre>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>

151
App/Xtn/Mediawiki/Tidy/tidy.html Normal file
View File

@@ -0,0 +1,151 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Xtn/Mediawiki/Tidy/tidy - XOWA</title>
<link rel="shortcut icon" href="http://xowa.org/xowa_logo.png" />
<link rel="stylesheet" href="http://xowa.org/xowa_common.css" type="text/css">
</head>
<body class="mediawiki ltr sitedir-ltr ns-0 ns-subject skin-vector action-submit vector-animateLayout" spellcheck="false">
<div id="mw-page-base" class="noprint"></div>
<div id="mw-head-base" class="noprint"></div>
<div id="content" class="mw-body">
<h1 id="firstHeading" class="firstHeading"><span>App/Xtn/Mediawiki/Tidy/tidy</span></h1>
<div id="bodyContent" class="mw-body-content">
<div id="siteSub">From XOWA: the free, open-source, offline wiki application</div>
<div id="contentSub"></div>
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr">
<table class="metadata plainlinks ambox ambox-delete" style="">
<tr>
<td class="mbox-empty-cell">
</td>
<td class="mbox-text" style="">
<p>
<span class="mbox-text-span">Note: This page is obsolete. It is preserved for historical reference only.</span>
</p>
</td>
</tr>
</table>
<p>
MediaWiki often uses <a href="http://www.w3.org/People/Raggett/tidy/" rel="nofollow" class="external text">HTML tidy</a> to clean up "dirty" HTML.
</p>
<p>
For example, HTML tidy will take the sequence "&lt;sup&gt;a&lt;/sub&gt;" and transform it to "&lt;sup&gt;a&lt;/su<span style="color:red;">p</span>&gt;".
</p>
<p>
XOWA integrates some of this functionality within its parser. However, it only implements a very small subset of the HTML tidy binary.
</p>
<p>
If you notice pages that are rendering incorrectly, you may want to enable HTML tidy. The following steps will need to be taken:
</p>
<ul>
<li>
In the <b>xowa.gfs</b> file, change 'n' to 'y' for html.tidy_enabled_('n');
</li>
<li>
In the <b>xowa.gfs</b> file, point '.tidy_html' to the location of the binary (/usr/bin/tidy on Linux).
</li>
</ul>
<dl>
<dd>
If you're on Windows, you should download HTML tidy and place it in <b>/xowa/bin/windows/tidy</b>
</dd>
</dl>
<ul>
<li>
Restart XOWA
</li>
</ul>
</div>
</div>
</div>
<div id="mw-head" class="noprint">
<div id="left-navigation">
<div id="p-namespaces" class="vectorTabs">
<h3>Namespaces</h3>
<ul>
<li id="ca-nstab-main" class="selected"><span><a id="ca-nstab-main-href" href="index.html">Page</a></span></li>
</ul>
</div>
</div>
</div>
<div id='mw-panel' class='noprint'>
<div id='p-logo'>
<a style="background-image: url(http://xowa.org/xowa_logo.png);" href="index.html" title="Visit the main page"></a>
</div>
<div class="portal" id='xowa-portal-home'>
<h3>XOWA</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/index.html" title='Visit the main page'>Main page</a></li>
<li><a href="http://xowa.org/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/wiki/home/page/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-stargin'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up other Wikipedias'>Other Wikipedias</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-help'>
<h3>Help</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-blog'>
<h3>Blog</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/wiki/home/page/Blog.html" title='Follow XOWA''s development process'>Current</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-links'>
<h3>Links</h3>
<div class="body">
<ul>
<li><a href="http://dumps.wikimedia.org/backup-index.html" title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><a href="https://archive.org/search.php?query=xowa" title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><a href="http://en.wikipedia.org" title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-donate'>
<h3>Donate</h3>
<div class="body">
<ul>
<li><a href="https://archive.org/donate/index.php" title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
<li><a href="https://donate.wikimedia.org/wiki/Special:FundraiserRedirector" title="Support Wikipedia!">Wikipedia</a></li>
<!-- <li><a href="" title="Support XOWA! (but only after you've supported archive.org and Wikipedia)">XOWA</a></li> -->
</ul>
</div>
</div>
</div>
</body>
</html>