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.55'

Browse Source
This commit is contained in:
gnosygnu
2016-04-17 11:48:03 -04:00
parent 720b111814
commit 70e48dc738
240 changed files with 114045 additions and 176 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
home/wiki/App/Xtn/Browser/HTTP_Server.html Normal file
View File

@@ -0,0 +1,176 @@
<!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="https://gnosygnu.github.io/xowa/xowa_logo.png" />
<link rel="stylesheet" href="https://gnosygnu.github.io/xowa/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/home/wiki/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(https://gnosygnu.github.io/xowa/xowa_logo.png);" href="http://xowa.org/" 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/home/wiki/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/home/wiki/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-started'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/home/wiki/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/home/wiki/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/home/wiki/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/home/wiki/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/home/wiki/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-android'>
<h3>Android</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/home/wiki/Android/Setup.html" title='Setup XOWA on your Android device'>Setup</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/home/wiki/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/home/wiki/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/home/wiki/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/home/wiki/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/home/wiki/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>

293
home/wiki/App/Xtn/Browser/TCP_Server.html Normal file
View File

@@ -0,0 +1,293 @@
<!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="https://gnosygnu.github.io/xowa/xowa_logo.png" />
<link rel="stylesheet" href="https://gnosygnu.github.io/xowa/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(https://gnosygnu.github.io/xowa/xowa_logo.png);" href="http://xowa.org/" 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/home/wiki/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/home/wiki/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-started'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/home/wiki/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/home/wiki/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/home/wiki/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/home/wiki/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/home/wiki/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-android'>
<h3>Android</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/home/wiki/Android/Setup.html" title='Setup XOWA on your Android device'>Setup</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/home/wiki/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/home/wiki/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/home/wiki/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/home/wiki/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/home/wiki/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>

339
home/wiki/App/Xtn/Browser/XOWA_viewer.html Normal file
View File

@@ -0,0 +1,339 @@
<!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="https://gnosygnu.github.io/xowa/xowa_logo.png" />
<link rel="stylesheet" href="https://gnosygnu.github.io/xowa/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(https://gnosygnu.github.io/xowa/xowa_logo.png);" href="http://xowa.org/" 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/home/wiki/Help/Download_XOWA.html" title='Download the XOWA application'>Download XOWA</a></li>
<li><a href="http://xowa.org/home/wiki/Dashboard/Image_databases.html" title='Download offline wikis and image databases'>Download wikis</a></li>
</ul>
</div>
</div>
<div class="portal" id='xowa-portal-started'>
<h3>Getting started</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/home/wiki/App/Setup/System_requirements.html" title='Get XOWA&apos;s system requirements'>Requirements</a></li>
<li><a href="http://xowa.org/home/wiki/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
<li><a href="http://xowa.org/home/wiki/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Simple Wikipedia</a></li>
<li><a href="http://xowa.org/home/wiki/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>English Wikipedia</a></li>
<li><a href="http://xowa.org/home/wiki/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-android'>
<h3>Android</h3>
<div class="body">
<ul>
<li><a href="http://xowa.org/home/wiki/Android/Setup.html" title='Setup XOWA on your Android device'>Setup</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/home/wiki/Help/About.html" title='Get more information about XOWA'>About</a></li>
<li><a href="http://xowa.org/home/wiki/Help/Contents.html" title='View a list of help topics'>Contents</a></li>
<li><a href="http://xowa.org/home/wiki/Help/Media.html" title='Read what others have written about XOWA'>Media</a></li>
<li><a href="http://xowa.org/home/wiki/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/home/wiki/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>