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

306
Dev/Config_files/Details.html Normal file
View File

@@ -0,0 +1,306 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>Dev/Config files/Details - 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>Dev/Config files/Details</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="#General_characteristics"><span class="tocnumber">1</span> <span class="toctext">General characteristics</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#Comments"><span class="tocnumber">2</span> <span class="toctext">Comments</span></a>
</li>
<li class="toclevel-1 tocsection-3">
<a href="#Whitespace"><span class="tocnumber">3</span> <span class="toctext">Whitespace</span></a>
</li>
<li class="toclevel-1 tocsection-4">
<a href="#Quotes"><span class="tocnumber">4</span> <span class="toctext">Quotes</span></a>
</li>
<li class="toclevel-1 tocsection-5">
<a href="#Booleans"><span class="tocnumber">5</span> <span class="toctext">Booleans</span></a>
</li>
<li class="toclevel-1 tocsection-6">
<a href="#Integers"><span class="tocnumber">6</span> <span class="toctext">Integers</span></a>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="General_characteristics">General characteristics</span>
</h2>
<p>
A gfs file has the following general characteristics:
</p>
<ul>
<li>
Encoding is UTF-8 (without Byte Order Mark)
</li>
<li>
Line-endings should be <code>\n</code> not <code>\r\n</code>.
</li>
</ul>
<dl>
<dd>
There is support for <code>\r\n</code>, but for safety's sake, please use <code>\n</code>.
</dd>
</dl>
<ul>
<li>
Text is case-sensitive. There is a difference between <code>app</code> and <code>APP</code>.
</li>
</ul>
<h2>
<span class="mw-headline" id="Comments">Comments</span>
</h2>
<p>
Comments can be indicated by the conventional C comments of <code>//</code> or <code>/**/</code>. For example, any text between <code>/*</code> and <code>*/</code> is ignored.
</p>
<h2>
<span class="mw-headline" id="Whitespace">Whitespace</span>
</h2>
<p>
Whitespace is not significant. There is no difference between the following commands.
</p>
<ul>
<li>
no whitespace
</li>
</ul>
<pre>
app.wikis.get('en.wikipedia.org');
</pre>
<ul>
<li>
multiple spaces (ASCII 32)
</li>
</ul>
<pre>
app . wikis . get ( 'en.wikipedia.org' ) ;
</pre>
<ul>
<li>
spaces and new lines (ASCII 32 and ASCII 10)
</li>
</ul>
<pre>
app
. wikis
. get ( 'en.wikipedia.org' )
;
</pre>
<p>
Note that tabs (ASCII 9) and carriage returns (ASCII 13) are permitted but not recommended.
</p>
<h2>
<span class="mw-headline" id="Quotes">Quotes</span>
</h2>
<ul>
<li>
Strings should be quoted. Quote characters are the apostrophe (<code>'</code>) or the quote (<code>"</code>). Note that <code>'</code> is often used.
</li>
<li>
A special quote sequence of <code>&amp;lt:['\n</code> and <code>\n}':]&gt;</code> is used to handle text with significant delimiters
</li>
</ul>
<dl>
<dd>
For example, the following is identical to <code>app.wikis.get('en.wikipedia.org');</code>
</dd>
</dl>
<pre>
app.wikis.get(
&lt;:['
en.wikipedia.org
']:&gt;
);
</pre>
<dl>
<dd>
Note that this quote sequence allows processing a mixture of various syntax forms without escaping. This is especially useful for wiki text which can have elements of HTML and significant other symbols.
</dd>
</dl>
<h2>
<span class="mw-headline" id="Booleans">Booleans</span>
</h2>
<p>
Booleans can be indicated in different forms as per the following table:
</p>
<table>
<tr>
<td>
Value
</td>
<td>
<b>true</b>
</td>
<td>
<b>false</b>
</td>
</tr>
<tr>
<td>
Text (uppercase)
</td>
<td>
<code>'TRUE'</code>
</td>
<td>
<code>'FALSE'</code>
</td>
</tr>
<tr>
<td>
Text (lowercase)
</td>
<td>
<code>'true'</code>
</td>
<td>
<code>'false'</code>
</td>
</tr>
<tr>
<td>
Text (simple)
</td>
<td>
<code>'y'</code>
</td>
<td>
<code>'n'</code>
</td>
</tr>
<tr>
<td>
Number
</td>
<td>
<code>1</code>
</td>
<td>
<code>0</code>
</td>
</tr>
</table>
<p>
Note that for brevity's sake, <code>'y'</code> and <code>'n'</code> will be used.
</p>
<h2>
<span class="mw-headline" id="Integers">Integers</span>
</h2>
<p>
Integers can be indicated with or without quotes. Note that without quotes is recommended.
</p>
<p>
Integers can not include commas or decimal places. For example, <code>1,234</code> is not valid. Use <code>1234</code> instead.
</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>

212
Dev/Config_files/Examples.html Normal file
View File

@@ -0,0 +1,212 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>Dev/Config files/Examples - 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>Dev/Config files/Examples</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="Changing_a_keyboard_shortcut">Changing a keyboard shortcut</span>
</h2>
<ul>
<li>
Open xowa.gfs in a text editor.
</li>
<li>
Search for <code>'app_exit'</code> (Note the single quotes).
</li>
</ul>
<dl>
<dd>
The following line should be found:
<dl>
<dd>
<code>.set('app_exit' , 'mod.c+key.q')</code>
</dd>
</dl>
</dd>
<dd>
This line defines Control+Q as the shortcut to exit the application.
</dd>
</dl>
<ul>
<li>
Change the shortcut from Control+Q to Control+Z by changing <code>key.q</code> to <code>key.z</code>.
</li>
</ul>
<dl>
<dd>
When you are done you should have the following line (note the red highlight):
<dl>
<dd>
<code>.set('app_exit' , 'mod.c+key.<span style="color:red;">z</span>')</code>
</dd>
</dl>
</dd>
</dl>
<ul>
<li>
Save xowa.gfs and close the file.
</li>
<li>
Run XOWA. Press Control+Z to exit the application.
</li>
</ul>
<h2>
<span class="mw-headline" id="Changing_the_HTML_view">Changing the HTML view</span>
</h2>
<ul>
<li>
Open xowa.gfs in a text editor.
</li>
<li>
Search for the line <code>.page_read_(</code>
</li>
</ul>
<dl>
<dd>
The following lines define the HTML used for the "Read" tab.
</dd>
<dd>
For now, let's add a "Hello World!"
</dd>
</dl>
<ul>
<li>
Scroll down about 20 lines. You will see the following line:
</li>
</ul>
<dl>
<dd>
<dl>
<dd>
<code>&lt;div id="siteSub"&gt;From XOWA:....</code> .
</dd>
</dl>
</dd>
</dl>
<ul>
<li>
Add a "Hello World!" right before "From XOWA:". When you are done you should have the following line (note the red highlight):
</li>
</ul>
<dl>
<dd>
<dl>
<dd>
<code>&lt;div id="siteSub"&gt;<span style="color:red;">Hello World!</span> From XOWA:....</code> .
</dd>
</dl>
</dd>
</dl>
<ul>
<li>
Save xowa.gfs and close the file.
</li>
<li>
Run XOWA. Note the "Hello World!" text at the top of the page.
</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>

174
Dev/Config_files/Files.html Normal file
View File

@@ -0,0 +1,174 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>Dev/Config files/Files - 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>Dev/Config files/Files</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 saves its config files in multiple locations. These will be itemized at a later writing.
</p>
<p>
For the purposes of general use, you will generally be concerned with the following:
</p>
<ul>
<li>
<b>/xowa/xowa.gfs</b>.
</li>
</ul>
<dl>
<dd>
This is the main config file loaded by the application
</dd>
<dd>
Note that the xowa.gfs will change from version to version. Any change here will be lost during upgrades.
</dd>
</dl>
<ul>
<li>
<b>/xowa/user/anonymous/app/data/cfg/user_system_cfg.gfs</b>
</li>
</ul>
<dl>
<dd>
This config is used for changes made by the UI
</dd>
<dd>
These changes are meant to persist from version to version. However, they should not be directly edited by a user. Any manual change here may be lost in future versions.
</dd>
<dd>
Any API that shows up here is intended to be backward compatible. Note that this is not a guarantee, but it is the closest you will ever get. If any setting here needs to change, then XOWA will be responsible for automatically changing it.
</dd>
</dl>
<ul>
<li>
<b>/xowa/user/anonymous/app/data/cfg/user_custom_cfg.gfs</b>
</li>
</ul>
<dl>
<dd>
This config is meant for users to store their config settings.
</dd>
<dd>
It is not modified by XOWA at all. It will not be overwritten during upgrades.
</dd>
<dd>
However, note that the "gfs" syntax is not fixed, and may change from version to version. There should be no expectation of backward compatibility. If you need to make lots of custom changes, please notify me, and I will try to make the proper provisions in the UI, or "solidify" the API/object model.
</dd>
</dl>
<p>
Finally, note that the last two files are called at the bottom of /xowa/xowa.gfs
</p>
<pre>
app.gfs_mgr.run_file_by_type('user_system_cfg');
app.gfs_mgr.run_file_by_type('user_custom_cfg');
</pre>
<p>
If you wish to disable them for testing purposes you can comment out these lines.
</p>
<p>
<br>
</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>

130
Dev/Config_files/Index.html Normal file
View File

@@ -0,0 +1,130 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>Dev/Config files/Index - 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>Dev/Config files/Index</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>
This is a list of pages relating to XOWA config files (.gfs)
</p>
<ul>
<li>
<a href="http://xowa.org/wiki/home/page/Dev/Config_files/Overview.html" id="xolnki_2" title="Dev/Config files/Overview">Overview</a>
</li>
<li>
<a href="http://xowa.org/wiki/home/page/Dev/Config_files/Examples.html" id="xolnki_3" title="Dev/Config files/Examples">Examples</a>
</li>
<li>
<a href="http://xowa.org/wiki/home/page/Dev/Config_files/Files.html" id="xolnki_4" title="Dev/Config files/Files">Files</a>
</li>
<li>
<a href="http://xowa.org/wiki/home/page/Dev/Config_files/Details.html" id="xolnki_5" title="Dev/Config files/Details">Details and format</a>
</li>
<li>
<a href="http://xowa.org/wiki/home/page/Dev/Config_files/Syntax.html" id="xolnki_6" title="Dev/Config files/Syntax">Syntax and object model</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>

170
Dev/Config_files/Overview.html Normal file
View File

@@ -0,0 +1,170 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>Dev/Config files/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>Dev/Config files/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">
<h2>
<span class="mw-headline" id="Overview_.28and_disclaimer.29">Overview (and disclaimer)</span>
</h2>
<p>
XOWA uses a custom text format called gfs (an acronym for the gfs flexible script). It is a plain-text config file with a Java-like syntax.
</p>
<p>
Please note that gfs was an early personal project, dating back over five years ago. Although there are considerable flaws in the project, it was incorporated into XOWA for reasons of expedience.
</p>
<p>
Unfortunately, although the script is flexible for my purposes, the format is very easy to break and the resulting error messages can be cryptic and indecipherable.
</p>
<p>
As such, please follow these guidelines when working with a gfs file.
</p>
<ul>
<li>
Always have a backup.
</li>
<li>
Add changes in small steps.
</li>
<li>
Do not stray far from the provided file.
</li>
<li>
Do not be clever. You will outsmart the library.
</li>
</ul>
<h2>
<span class="mw-headline" id="Recommended_procedure_for_changes">Recommended procedure for changes</span>
</h2>
<p>
Please follow the steps below when changing config files. Windows instructions are provided in parentheses.
</p>
<p>
Note that you can keep XOWA open while making changes to the .gfs file. (for example, while reading this help page). However, in order for the changes to take effect, you must restart XOWA.
</p>
<ul>
<li>
Open up the config file in a text editor. (launch jEdit or Notepad++).
</li>
<li>
Make the desired change. (see <a href="http://xowa.org/wiki/home/page/Dev/Config_files_files/Examples.html" id="xolnki_2" title="Dev/Config files files/Examples">Dev/Config_files files/Examples</a> for examples.)
</li>
<li>
Save and close the file.
</li>
<li>
Run XOWA (<code>java -jar xowa_windows.jar</code>)
</li>
</ul>
<dl>
<dd>
If it works, then XOWA will launch normally.
</dd>
<dd>
If it fails, then a message box will display an error. Note that the log will also have the same information: <b>/xowa/user/anonymous/app/tmp/log/current</b>.
</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>

157
Dev/Config_files/Syntax.html Normal file
View File

@@ -0,0 +1,157 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>Dev/Config files/Syntax - 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>Dev/Config files/Syntax</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="Syntax">Syntax</span>
</h2>
<ul>
<li>
Syntax follows an object-oriented convention.
</li>
</ul>
<dl>
<dd>
For example, <code>app.wikis('en.wikipedia.org')</code> can be expanded to
<dl>
<dd>
find an object that accepts the "app" message in the current context
</dd>
<dd>
find an object that accepts the "wikis" message in the "app" context
</dd>
<dd>
pass the last object a message that has one argument with a value of 'en.wikipedia.org'
</dd>
</dl>
</dd>
</dl>
<ul>
<li>
Note that instances/methods can return itself. This allows chaining multiple message calls.
</li>
</ul>
<dl>
<dd>
For example, in <code>app.wikis.get('en.wikipedia.org').files.cfg_download</code>, enabled_ and redownload_ both return the cfg_download object. This allows the following call
</dd>
</dl>
<pre>
app.wikis.get('en.wikipedia.org').files.cfg_download
.enabled_('y') // returns cfg_download
.redownload_('none') // uses the cfg_download from .enabled_ and calls .redownload_
;
</pre>
<p>
Note that the above is the same as the following:
</p>
<pre>
app.wikis.get('en.wikipedia.org').files.cfg_download.enabled_('y');
app.wikis.get('en.wikipedia.org').files.cfg_download.redownload_('none');
</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>