mirror of
https://github.com/gnosygnu/xowa.git
synced 2026-03-02 03:49:30 +00:00
Add FAQ
This commit is contained in:
gnosygnu
@@ -27,7 +27,7 @@
|
||||
<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">App/Xtn/Browser/XOWA_viewer</a>).
|
||||
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" id="xolnki_2" title="App/Xtn/Browser/XOWA viewer">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.
|
||||
|
||||
@@ -119,10 +119,10 @@
|
||||
<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.
|
||||
<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="/site/en.wikipedia.org/wiki/Wikipedia:Tools/Navigation_popups">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>.
|
||||
The javascript was modified from Reference tooltips, which was kindly provided by <a href="/site/de.wikipedia.org/wiki/Benzuter:Schnark">Schnark</a>.
|
||||
</p>
|
||||
<p>
|
||||
<br>
|
||||
|
||||
@@ -78,7 +78,7 @@
|
||||
<span class="mw-headline" id="Options">Options</span>
|
||||
</h2>
|
||||
<p>
|
||||
See <a href="http://xowa.org/home/wiki/Options/Import_Dansguardian.html" id="xolnki_2" title="Options/Import Dansguardian">Options/Import_Dansguardian</a>
|
||||
See <a href="http://xowa.org/home/wiki/Options/Import_Dansguardian" id="xolnki_2" title="Options/Import Dansguardian">Options/Import_Dansguardian</a>
|
||||
</p>
|
||||
<h2>
|
||||
<span class="mw-headline" id="Phraselists">Phraselists</span>
|
||||
@@ -204,7 +204,7 @@
|
||||
<span class="mw-headline" id="Exclusion">Exclusion</span>
|
||||
</h2>
|
||||
<p>
|
||||
By default, anything that matches a rule (has a score > 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/home/wiki/Options/Import_Dansguardian.html" id="xolnki_3" title="Options/Import Dansguardian">Options/Import_Dansguardian</a>
|
||||
By default, anything that matches a rule (has a score > 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/home/wiki/Options/Import_Dansguardian" id="xolnki_3" title="Options/Import Dansguardian">Options/Import_Dansguardian</a>
|
||||
</p>
|
||||
<h2>
|
||||
<span class="mw-headline" id="Inclusion">Inclusion</span>
|
||||
|
||||
@@ -76,7 +76,7 @@
|
||||
</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/home/wiki/Dev/Config_files.html" id="xolnki_2" title="Dev/Config files">Dev/Config_files</a> for more information about config files.
|
||||
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/home/wiki/Dev/Config_files" id="xolnki_2" title="Dev/Config files">Dev/Config_files</a> for more information about config files.
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
@@ -99,14 +99,14 @@
|
||||
<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/home/wiki/Options/Math.html" id="xolnki_3" title="Options/Math">Options/Math</a> and choosing LaTeX
|
||||
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/home/wiki/Options/Math" 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/home/wiki/Diagnostics/Math.html" id="xolnki_4" title="Diagnostics/Math">Diagnostics/Math</a>
|
||||
Visit <a href="http://xowa.org/home/wiki/Diagnostics/Math" id="xolnki_4" title="Diagnostics/Math">Diagnostics/Math</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
<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/home/wiki/Help/Feedback.html" id="xolnki_2" title="Help/Feedback">Help/Feedback</a>.
|
||||
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/home/wiki/Help/Feedback" id="xolnki_2" title="Help/Feedback">Help/Feedback</a>.
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -49,14 +49,14 @@
|
||||
<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/home/wiki/Options/Math.html" id="xolnki_2" title="Options/Math">Options/Math</a> and choosing LaTeX
|
||||
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/home/wiki/Options/Math" 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/home/wiki/Diagnostics/Math.html" id="xolnki_3" title="Diagnostics/Math">Diagnostics/Math</a>
|
||||
Visit <a href="http://xowa.org/home/wiki/Diagnostics/Math" id="xolnki_3" title="Diagnostics/Math">Diagnostics/Math</a>
|
||||
</li>
|
||||
<li>
|
||||
Wait a few seconds. You will get a MikTeX prompt to download another repository. Specifically:
|
||||
|
||||
@@ -64,13 +64,13 @@
|
||||
</p>
|
||||
<dl>
|
||||
<dd>
|
||||
<a href="http://xowa.org/home/wiki/App/Xtn/Mediawiki/Math/Latex/Windows.html" id="xolnki_2" title="App/Xtn/Mediawiki/Math/Latex/Windows">Set up math (Windows)</a>
|
||||
<a href="http://xowa.org/home/wiki/App/Xtn/Mediawiki/Math/Latex/Windows" id="xolnki_2" title="App/Xtn/Mediawiki/Math/Latex/Windows">Set up math (Windows)</a>
|
||||
</dd>
|
||||
<dd>
|
||||
<a href="http://xowa.org/home/wiki/App/Xtn/Mediawiki/Math/Latex/Linux.html" id="xolnki_3" title="App/Xtn/Mediawiki/Math/Latex/Linux">Set up math (Linux)</a>
|
||||
<a href="http://xowa.org/home/wiki/App/Xtn/Mediawiki/Math/Latex/Linux" id="xolnki_3" title="App/Xtn/Mediawiki/Math/Latex/Linux">Set up math (Linux)</a>
|
||||
</dd>
|
||||
<dd>
|
||||
<a href="http://xowa.org/home/wiki/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>
|
||||
<a href="http://xowa.org/home/wiki/App/Xtn/Mediawiki/Math/Latex/Mac_OS_X" id="xolnki_4" title="App/Xtn/Mediawiki/Math/Latex/Mac OS X">Set up math (Mac OS X)</a>
|
||||
</dd>
|
||||
</dl>
|
||||
<h2>
|
||||
@@ -97,14 +97,14 @@
|
||||
<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/home/wiki/Help:Component/MathJax.html" id="xolnki_5" title="Help:Component/MathJax">Help:Component/MathJax</a>.
|
||||
For more info on how Mathjax was integrated into XOWA, please see <a href="http://xowa.org/home/wiki/Help:Component/MathJax" 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/home/wiki/Diagnostics/Math.html" id="xolnki_6" title="Diagnostics/Math">Diagnostics/Math</a>
|
||||
Visit <a href="http://xowa.org/home/wiki/Diagnostics/Math" id="xolnki_6" title="Diagnostics/Math">Diagnostics/Math</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>
|
||||
|
||||
@@ -107,7 +107,7 @@
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
Go to <a href="http://xowa.org/home/wiki/Options/Score.html" id="xolnki_2" title="Options/Score">Options/Score</a>.
|
||||
Go to <a href="http://xowa.org/home/wiki/Options/Score" id="xolnki_2" title="Options/Score">Options/Score</a>.
|
||||
</li>
|
||||
<li>
|
||||
Configure the <b>lilypond</b> binary to whatever directory you chose above.
|
||||
@@ -144,7 +144,7 @@
|
||||
<span class="mw-headline" id="Testing">Testing</span>
|
||||
</h2>
|
||||
<p>
|
||||
When you're done, visit <a href="http://xowa.org/home/wiki/Diagnostics.html" id="xolnki_3" title="Diagnostics" class="xowa-visited">Diagnostics</a> and click on the Score links
|
||||
When you're done, visit <a href="http://xowa.org/home/wiki/Diagnostics" id="xolnki_3" title="Diagnostics" class="xowa-visited">Diagnostics</a> and click on the Score links
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -215,7 +215,7 @@
|
||||
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/home/wiki/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>
|
||||
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/home/wiki/App/Xtn/Mediawiki/Scribunto/Luaj" 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>
|
||||
@@ -273,10 +273,10 @@
|
||||
</h2>
|
||||
<ul>
|
||||
<li>
|
||||
For Options see <a href="http://xowa.org/home/wiki/Options/Scribunto.html" id="xolnki_5" title="Options/Scribunto">Options/Scribunto</a>
|
||||
For Options see <a href="http://xowa.org/home/wiki/Options/Scribunto" id="xolnki_5" title="Options/Scribunto">Options/Scribunto</a>
|
||||
</li>
|
||||
<li>
|
||||
For Diagnostics see <a href="http://xowa.org/home/wiki/Diagnostics.html#Scribunto" id="xolnki_6" title="Diagnostics">Diagnostics#Scribunto</a>
|
||||
For Diagnostics see <a href="http://xowa.org/home/wiki/Diagnostics#Scribunto" id="xolnki_6" title="Diagnostics">Diagnostics#Scribunto</a>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
@@ -109,7 +109,7 @@
|
||||
<span class="mw-headline" id="Options">Options</span>
|
||||
</h2>
|
||||
<p>
|
||||
The options page is at <a href="http://xowa.org/home/wiki/Options/Page_sync.html" id="xolnki_2" title="Options/Page sync">Options/Page_sync</a>
|
||||
The options page is at <a href="http://xowa.org/home/wiki/Options/Page_sync" id="xolnki_2" title="Options/Page sync">Options/Page_sync</a>
|
||||
</p>
|
||||
<h2>
|
||||
<span class="mw-headline" id="Background">Background</span>
|
||||
@@ -122,7 +122,7 @@
|
||||
Wikimedia generates offline Wikitext dumps twice per month. See <a href="https://dumps.wikimedia.org/backup-index.html" rel="nofollow" class="external free">https://dumps.wikimedia.org/backup-index.html</a>
|
||||
</li>
|
||||
<li>
|
||||
XOWA generates HTML dumps once per month. See <a href="http://xowa.org/home/wiki/Special:XowaDownloadCentral.html" id="xolnki_3" title="Special:XowaDownloadCentral" class="xowa-visited">Special:XowaDownloadCentral</a>
|
||||
XOWA generates HTML dumps once per month. See <a href="http://xowa.org/home/wiki/Special:XowaDownloadCentral" id="xolnki_3" title="Special:XowaDownloadCentral" class="xowa-visited">Special:XowaDownloadCentral</a>
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
@@ -149,7 +149,7 @@
|
||||
<span class="mw-headline" id="Math.2C_Helper_Buttons_.28enlarge_.2F_more_info.29.2C_Musical_scores.2C_and_other_images_don.27t_work"><s>Math,</s> Helper Buttons (enlarge / more info), Musical scores, and other images don't work</span>
|
||||
</h3>
|
||||
<p>
|
||||
Wikipedia stores some images in a separate location. XOWA still needs code to detect this location, copy it offline, and show it correctly. This should be done in the next few releases, but in the meantime it's heavily recommended that you don't use Automatic sync for all pages. <s>In particular, math pages will lose all equations after a sync. For example, <a href="https://en.wikipedia.org/wiki/Pythagorean_theorem" rel="nofollow" class="external free">https://en.wikipedia.org/wiki/Pythagorean_theorem</a></s>
|
||||
Wikipedia stores some images in a separate location. XOWA still needs code to detect this location, copy it offline, and show it correctly. This should be done in the next few releases, but in the meantime it's heavily recommended that you don't use Automatic sync for all pages. <s>In particular, math pages will lose all equations after a sync. For example, <a href="/site/en.wikipedia.org/wiki/Pythagorean_theorem">https://en.wikipedia.org/wiki/Pythagorean_theorem</a></s>
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
@@ -173,7 +173,7 @@
|
||||
Backup en.wikipedia.org-html.user.xowa and en.wikipedia.org-sync.xowa if they exist.
|
||||
</li>
|
||||
<li>
|
||||
Synchronize <a href="https://en.wikipedia.org/wiki/Pythagorean_theorem" rel="nofollow" class="external free">https://en.wikipedia.org/wiki/Pythagorean_theorem</a>
|
||||
Synchronize <a href="/site/en.wikipedia.org/wiki/Pythagorean_theorem">https://en.wikipedia.org/wiki/Pythagorean_theorem</a>
|
||||
</li>
|
||||
<li>
|
||||
Realize that the synchronization is bad and start the rollback.
|
||||
@@ -191,7 +191,7 @@
|
||||
If backups don't exist, delete en.wikipedia.org-html.user.xowa and en.wikipedia.org-sync.xowa
|
||||
</li>
|
||||
<li>
|
||||
Run XOWA and go to <a href="https://en.wikipedia.org/wiki/Pythagorean_theorem" rel="nofollow" class="external free">https://en.wikipedia.org/wiki/Pythagorean_theorem</a>
|
||||
Run XOWA and go to <a href="/site/en.wikipedia.org/wiki/Pythagorean_theorem">https://en.wikipedia.org/wiki/Pythagorean_theorem</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h3>
|
||||
@@ -231,7 +231,7 @@
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
<b>online mode required</b>: You must have "Web access enabled" in <a href="http://xowa.org/home/wiki/Options/Security.html" id="xolnki_4" title="Options/Security">Options/Security</a>
|
||||
<b>online mode required</b>: You must have "Web access enabled" in <a href="http://xowa.org/home/wiki/Options/Security" id="xolnki_4" title="Options/Security">Options/Security</a>
|
||||
</li>
|
||||
<li>
|
||||
<b>exclusions</b>: Page sync does not work for the following pages:
|
||||
|
||||
@@ -101,7 +101,7 @@
|
||||
<span class="mw-headline" id="Options">Options</span>
|
||||
</h2>
|
||||
<p>
|
||||
The options page is at <a href="http://xowa.org/home/wiki/Options/Scripting.html" id="xolnki_2" title="Options/Scripting">Options/Scripting</a>
|
||||
The options page is at <a href="http://xowa.org/home/wiki/Options/Scripting" id="xolnki_2" title="Options/Scripting">Options/Scripting</a>
|
||||
</p>
|
||||
<h2>
|
||||
<span class="mw-headline" id="Background">Background</span>
|
||||
@@ -118,7 +118,7 @@
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
If you would like to have an extension supported directly by XOWA, please contact the developer through <a href="http://xowa.org/home/wiki/Help/Feedback.html" id="xolnki_3" title="Help/Feedback">Help/Feedback</a>. You can also hack the XOWA source to add your own extension in Java.
|
||||
If you would like to have an extension supported directly by XOWA, please contact the developer through <a href="http://xowa.org/home/wiki/Help/Feedback" id="xolnki_3" title="Help/Feedback">Help/Feedback</a>. You can also hack the XOWA source to add your own extension in Java.
|
||||
</p>
|
||||
<p>
|
||||
However, if you want a simpler approach, XOWA does allow an extension system by adding javascript / lua files
|
||||
|
||||
Reference in New Issue
Block a user