1
0
mirror of https://github.com/gnosygnu/xowa.git synced 2024-10-27 20:34:16 +00:00
gnosygnu_xowa/home/wiki/App/Databases/Overview.html
2017-01-08 22:37:12 -05:00

227 lines
11 KiB
HTML

<!DOCTYPE html>
<html dir="ltr">
<head>
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
<title>App/Databases/Overview - 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/Databases/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">
<p>
XOWA stores wiki data in SQLite databases. These databases can be classified as either Wikitext or HTML
</p>
<div id="toc" class="toc">
<div id="toctitle">
<h2>
Contents
</h2>
</div>
<ul>
<li class="toclevel-1 tocsection-1">
<a href="#SQLite"><span class="tocnumber">1</span> <span class="toctext">SQLite</span></a>
</li>
<li class="toclevel-1 tocsection-2">
<a href="#XOWA_Database_sets:_Wikitext_vs_HTML"><span class="tocnumber">2</span> <span class="toctext">XOWA Database sets: Wikitext vs HTML</span></a>
<ul>
<li class="toclevel-2 tocsection-3">
<a href="#Wikitext"><span class="tocnumber">2.1</span> <span class="toctext">Wikitext</span></a>
</li>
<li class="toclevel-2 tocsection-4">
<a href="#HTML"><span class="tocnumber">2.2</span> <span class="toctext">HTML</span></a>
</li>
</ul>
</li>
</ul>
</div>
<h2>
<span class="mw-headline" id="SQLite">SQLite</span>
</h2>
<p>
XOWA uses SQLite database files to store its data.
</p>
<ul>
<li>
Files have an extension of either ".xowa" or ".sqlite3". Note that ".xowa" files are just plain old sqlite3 databases with a renamed extension.
</li>
<li>
Files are limited to 2 GB. Note that SQLite can easily handle files greater than 100 GB. The 2 GB limit is imposed for the following two constraints:
<ul>
<li>
<b>2 GB limit for SQLite files on Android</b>. I've not found any documentation that states this, but opening a file larger than 2 GB file always fails.
</li>
<li>
<b>4 GB limit for FAT32 on flash cards</b>. FAT32 is an old file-system format. However, it is the only format that is supported natively by all major operating systems. I install a set of wikis on a 200 GB FAT32-formatted microSD card and carry it around from machine to machine
</li>
</ul>
</li>
</ul>
<p>
Various programs can be used to read SQLite3.
</p>
<ul>
<li>
<b>sqlite3 command shell</b>: This is the official shell for SQLite. Instructions are available here: the <a href="https://www.sqlite.org/cli.html" rel="nofollow" class="external free">https://www.sqlite.org/cli.html</a> . Download is available here: <a href="https://www.sqlite.org/download.html" rel="nofollow" class="external free">https://www.sqlite.org/download.html</a>
</li>
<li>
<b>SQLite browser</b>. This is a free, open-source GUI that can be useful for those who don't want just a command-line shell. See: <a href="http://sqlitebrowser.org/" rel="nofollow" class="external free">http://sqlitebrowser.org/</a>
</li>
</ul>
<h2>
<span class="mw-headline" id="XOWA_Database_sets:_Wikitext_vs_HTML">XOWA Database sets: Wikitext vs HTML</span>
</h2>
<p>
There are two types of database sets for XOWA: Wikitext and HTML
</p>
<h3>
<span class="mw-headline" id="Wikitext">Wikitext</span>
</h3>
<ul>
<li>
Wikitext is a custom language by MediaWiki to generate HTML. For example, two apostrophes are used for italics: <code>''italics''</code>
</li>
<li>
Wikitext databases will have <code>-text-</code> in the file name. For example, <code>en.wikipedia.org-text-ns.000.xowa</code>
</li>
<li>
Users can generates this Wikitext set by using either <a href="http://xowa.org/home/wiki/Dashboard/Import/Online.html" id="xolnki_2" title="Dashboard/Import/Online" class="xowa-visited">Dashboard/Import/Online</a> or <a href="http://xowa.org/home/wiki/Dashboard/Import/Offline.html" id="xolnki_3" title="Dashboard/Import/Offline" class="xowa-visited">Dashboard/Import/Offline</a>
</li>
<li>
Wikitext databases have been supported since the very start of XOWA. As such, they have a full set of functionality
</li>
<li>
However, Wikitext databases are slower. They need to take the Wikitext and convert it to HTML. As such, Wikitext databases don't work for Android, nor for other low-spec machines like Raspberry Pi
</li>
</ul>
<h3>
<span class="mw-headline" id="HTML">HTML</span>
</h3>
<ul>
<li>
HTML is the raw text as used by a web browser. For example, the following is used for italics: <code>&lt;i&gt;italics&lt;/i&gt;</code>
</li>
<li>
HTML databases will have <code>-html-</code> in the file name. For example, <code>en.wikipedia.org-html.xowa</code>
</li>
<li>
Users can generate this HTML database using <a href="http://xowa.org/home/wiki/Dev/Command-line/Thumbs.html" id="xolnki_4" title="Dev/Command-line/Thumbs">Dev/Command-line/Thumbs</a>. However, for most users, they will just download the already-generated HTML databases from <a href="http://archive.org" rel="nofollow" class="external free">http://archive.org</a> through <a href="http://xowa.org/home/wiki/Special:XowaDownloadCentral.html" id="xolnki_5" title="Special:XowaDownloadCentral" class="xowa-visited">Special:XowaDownloadCentral</a>
</li>
<li>
HTML databases have only been supported recently (as of 2016-06). As such, they are missing a small percentage of functionality. The most significant piece of that functionality is Popups, but there may be other features.
</li>
<li>
HTML databases are fast, as they don't need to convert Wikitext to HTML. As such, HTML databases are used for Android and recommended for Raspberry Pi
</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="https://www.youtube.com/watch?v=q0qbXYXEH6M" title="See a video of XOWA Desktop in action">Video</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>
<li><a href="https://www.youtube.com/watch?v=jsMTBxGweUw" title="See a video of XOWA Android in action">Video</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>