mirror of
https://github.com/gnosygnu/xowa.git
synced 2024-10-27 20:34:16 +00:00
394 lines
21 KiB
HTML
394 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html dir="ltr">
|
|
<head>
|
|
<meta http-equiv="content-type" content="text/html;charset=UTF-8" />
|
|
<title>Options/Files - XOWA</title>
|
|
<link rel="shortcut icon" href="/xowa/wiki/home/page/xowa_logo.png" />
|
|
<link rel="stylesheet" href="/xowa/wiki/home/page/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>Options/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">
|
|
|
|
<div>
|
|
<table>
|
|
<tr>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/Window'>Apps (basic)</a>
|
|
</td>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/Security'>Apps (advanced)</a>
|
|
</td>
|
|
<td class='optionsButton active'>
|
|
<a class='optionsLink' href='/wiki/Options/Import'>Wiki</a>
|
|
</td>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/HTML'>HTML</a>
|
|
</td>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/Content_apps'>External apps</a>
|
|
</td>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/Search_suggest'>Modules</a>
|
|
</td>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/Math'>Extensions</a>
|
|
</td>
|
|
<td class='optionsButton'>
|
|
<a class='optionsLink' href='/wiki/Options/Dev'>Misc</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="tabs">
|
|
<div>
|
|
<ul class='tab-links' style='margin-left:0px;'>
|
|
<li class=''>
|
|
<a href='/wiki/Options/Import'>Import</a>
|
|
</li>
|
|
<li class='active'>
|
|
<a href='/wiki/Options/Files'>Files</a>
|
|
</li>
|
|
<li class=''>
|
|
<a href='/wiki/Options/Category'>Category</a>
|
|
</li>
|
|
<li class=''>
|
|
<a href='/wiki/Options/Import_Dansguardian'>Import Dansguardian</a>
|
|
</li>
|
|
</ul>
|
|
</div><br>
|
|
<div class='tab-content'>
|
|
<div id="toc" class="toc">
|
|
<div id="toctitle">
|
|
<h2>
|
|
Contents
|
|
</h2>
|
|
</div>
|
|
<ul>
|
|
<li class="toclevel-1 tocsection-1">
|
|
<a href="#Files"><span class="tocnumber">1</span> <span class="toctext">Files</span></a>
|
|
</li>
|
|
<li class="toclevel-1 tocsection-2">
|
|
<a href="#Cache_"><span class="tocnumber">2</span> <span class="toctext">Cache</span></a>
|
|
</li>
|
|
<li class="toclevel-1 tocsection-3">
|
|
<a href="#System_Applications"><span class="tocnumber">3</span> <span class="toctext">System Applications</span></a>
|
|
</li>
|
|
<li class="toclevel-1 tocsection-4">
|
|
<a href="#Notes"><span class="tocnumber">4</span> <span class="toctext">Notes</span></a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div style='float:right; margin-right:10px; margin-top:5px;'>
|
|
<p>
|
|
<a href="xowa-cmd:app.user.prefs.save();" accesskey='s'><img src='file:///C:/xowa/bin/any/xowa/file/app.window/save.png' width="16" height="16">Save</a>
|
|
</p>
|
|
</div><br>
|
|
|
|
<p>
|
|
<br>
|
|
</p>
|
|
<h2>
|
|
<span class="mw-headline" id="Files">Files</span>
|
|
</h2>
|
|
<table class='options_table'>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Retrieval enabled: <sup id="cite_ref-download_enabled_0-0" class="reference"><a href="#cite_note-download_enabled-0">[1]</a></sup>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="app.files.download.enabled" type="checkbox" class="options_checkbox" id='xowa_prop_0' checked='checked'>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>
|
|
<span class="mw-headline" id="Cache_">Cache <sup id="cite_ref-cache_1-0" class="reference"><a href="#cite_note-cache-1">[2]</a></sup></span>
|
|
</h2>
|
|
<table class='options_table'>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Minumum disk space used: <sup id="cite_ref-fsys_size_min_2-0" class="reference"><a href="#cite_note-fsys_size_min-2">[3]</a></sup>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="xowa.api.usr.cache.fsys_size_min" class="options_textbox_num" style="width: 40px;" id='xowa_prop_1' value='75'>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Maxiumum disk space used: <sup id="cite_ref-fsys_size_max_3-0" class="reference"><a href="#cite_note-fsys_size_max-3">[4]</a></sup>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="xowa.api.usr.cache.fsys_size_max" class="options_textbox_num" style="width: 40px;" id='xowa_prop_2' value='100'>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Reduce cache to min<sup id="cite_ref-reduce_to_min_4-0" class="reference"><a href="#cite_note-reduce_to_min-4">[5]</a></sup>
|
|
</td>
|
|
<td>
|
|
<button class='options_button' id='xowa_update_dump_status' onclick='return cache_reduce_to_min();'>Reduce</button>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Clear cache<sup id="cite_ref-reduce_to_zero_5-0" class="reference"><a href="#cite_note-reduce_to_zero-5">[6]</a></sup>
|
|
</td>
|
|
<td>
|
|
<button class='options_button' accesskey='c' id='xowa_update_dump_status' onclick='return cache_reduce_to_zero();'><u>C</u>lear</button>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Info: <sup id="cite_ref-info_6-0" class="reference"><a href="#cite_note-info-6">[7]</a></sup>
|
|
</td>
|
|
<td>
|
|
<textarea xowa_prop="xowa.api.usr.cache.info" class="options_textbox options_readonly" readonly='readonly' style="width: 600px; height: 100px;" id='xowa_prop_3'>
|
|
cache folder: C:\xowa\file
|
|
space used: 60.539 MB
|
|
file count: 3499
|
|
oldest file: 2016-03-27 18:14:18
|
|
</textarea>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>
|
|
<span class="mw-headline" id="System_Applications">System Applications</span>
|
|
</h2>
|
|
<table class="options_table">
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
ImageMagick - Identify:
|
|
<p>
|
|
<sup id="cite_ref-7" class="reference"><a href="#cite_note-7">[8]</a></sup>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="app.fsys.apps.query_img_size.cmd" class="options_textbox" style="width: 380px; margin-bottom:2px;" type="xowa_io" id='xowa_prop_4' value='C:\xowa\bin\windows_64\imagemagick\identify'><button id='xowa_prop_4_io' class='options_button' onclick='xowa_io_select("file", "xowa_prop_4", "Please select a file.");'>...</button>
|
|
<p>
|
|
<input xowa_prop="app.fsys.apps.query_img_size.args" class="options_textbox" style="width: 380px;" id='xowa_prop_5' value='-ping -format "<{%w,%h}>" "~{file}"'>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
ImageMagick - Convert:
|
|
<p>
|
|
<sup id="cite_ref-8" class="reference"><a href="#cite_note-8">[9]</a></sup>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="app.fsys.apps.resize_img.cmd" class="options_textbox" style="width: 380px; margin-bottom:2px;" type="xowa_io" id='xowa_prop_6' value='C:\xowa\bin\windows_64\imagemagick\convert'><button id='xowa_prop_6_io' class='options_button' onclick='xowa_io_select("file", "xowa_prop_6", "Please select a file.");'>...</button>
|
|
<p>
|
|
<input xowa_prop="app.fsys.apps.resize_img.args" class="options_textbox" style="width: 380px;" id='xowa_prop_7' value='"~{source}" -coalesce -resize ~{width}x~{height} "~{target}"'>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Inkscape
|
|
<p>
|
|
<sup id="cite_ref-9" class="reference"><a href="#cite_note-9">[10]</a></sup>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="app.fsys.apps.convert_svg_to_png.cmd" class="options_textbox" style="width: 380px; margin-bottom:2px;" type="xowa_io" id='xowa_prop_8' value='C:\xowa\bin\windows_64\inkscape\inkscape'><button id='xowa_prop_8_io' class='options_button' onclick='xowa_io_select("file", "xowa_prop_8", "Please select a file.");'>...</button>
|
|
<p>
|
|
<input xowa_prop="app.fsys.apps.convert_svg_to_png.args" class="options_textbox" style="width: 380px;" id='xowa_prop_9' value='-z -w ~{width} -f "~{source}" -e "~{target}"'>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='options_row_label'>
|
|
Djvu converter
|
|
<p>
|
|
<sup id="cite_ref-10" class="reference"><a href="#cite_note-10">[11]</a></sup>
|
|
</p>
|
|
</td>
|
|
<td>
|
|
<input xowa_prop="app.fsys.apps.convert_djvu_to_tiff.cmd" class="options_textbox" style="width: 380px; margin-bottom:2px;" type="xowa_io" id='xowa_prop_10' value='C:\xowa\bin\windows_64\djvulibre\ddjvu'><button id='xowa_prop_10_io' class='options_button' onclick='xowa_io_select("file", "xowa_prop_10", "Please select a file.");'>...</button>
|
|
<p>
|
|
<input xowa_prop="app.fsys.apps.convert_djvu_to_tiff.args" class="options_textbox" style="width: 380px;" id='xowa_prop_11' value='-format=tiff -page=1 "~{source}" "~{target}"'>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<h2>
|
|
<span class="mw-headline" id="Notes">Notes</span>
|
|
</h2>
|
|
<ol class="references">
|
|
<li id="cite_note-download_enabled-0">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-download_enabled_0-0">^</a></span> <span class="reference-text">Choose one of the following (default is <code>unchecked</code>)</span>
|
|
<ul>
|
|
<li>
|
|
<span class="reference-text"><b>checked</b> to automatically download images / retrieve images from database</span>
|
|
<ul>
|
|
<li>
|
|
<span class="reference-text">ImageMagick and Inkscape <b>must</b> be installed (See <a href="/xowa/wiki/home/page/Dev/File/Setup.html" id="xolnki_2" title="Dev/File/Setup">Dev/File/Setup</a>)</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">An internet connection must be available, or a local tarball must be set up. (See <a href="/xowa/wiki/home/page/Archive/Usage/Offline_images.html" id="xolnki_3" title="Archive/Usage/Offline images">Archive/Usage/Offline_images</a>)</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text"><b>unchecked</b> to leave images unprocessed</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li id="cite_note-cache-1">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-cache_1-0">^</a></span> <span class="reference-text">Although files are saved in the bin.sqlite3 database, they are also cached locally at <code>C:\xowa\file</code>. This is done for the following reasons:</span>
|
|
<ul>
|
|
<li>
|
|
<span class="reference-text"><b>The HTML browser must display the image</b>: The HTML browser cannot read directly from a sqlite database. The "src" attribute must point to a file resource. (It could take a base64 encoded string, but this has its own complications)</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text"><b>Viewer apps must be able to access the image</b>: Similar to the above, when a file is clicked in the commons wiki, XOWA sends it to an external viewer app. These viewer apps will not be able to access files from the sqlite database or from a base64 encoded string</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text"><b>Performance</b>: Images will load more quickly if they are already on the file system (as opposed to being continually extracted from the database)</span>
|
|
</li>
|
|
</ul><span class="reference-text">Some other details worth noting:</span>
|
|
<ul>
|
|
<li>
|
|
<span class="reference-text">The cache is stored in <code>C:\xowa\user\user-anonymous.xowa</code></span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">This value should not be set any lower than 5 MB (or else all images may not load on a page)</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li id="cite_note-fsys_size_min-2">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-fsys_size_min_2-0">^</a></span> <span class="reference-text">Enter a minimum size for the cache to use (in MB) (default is <code>75</code>) .<br>
|
|
This is an advanced configuration tweak. When the cache reaches its maximum size, it will delete files to free space. It will continue deleting files until the minimum size is reached.<br>
|
|
For example:</span>
|
|
<ul>
|
|
<li>
|
|
<span class="reference-text">If the max is set to 100 MB</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">... and the current size of all files in the cache is 99.9 MB</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">... and a 200 KB file is added</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">Then the cache size will be temporarily 100.1 MB</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">... triggering the delete mechanism</span>
|
|
</li>
|
|
<li>
|
|
<span class="reference-text">... which will reduce the current size of all files to 75 MB</span>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li id="cite_note-fsys_size_max-3">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-fsys_size_max_3-0">^</a></span> <span class="reference-text">Enter a maximum size for the cache to use (in MB) (default is <code>100</code>) .<br>
|
|
</span>
|
|
</li>
|
|
<li id="cite_note-reduce_to_min-4">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-reduce_to_min_4-0">^</a></span> <span class="reference-text">Press to reduce the cache to the minimum now (typically 75 MB).</span>
|
|
</li>
|
|
<li id="cite_note-reduce_to_zero-5">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-reduce_to_zero_5-0">^</a></span> <span class="reference-text">Press to clear the cache (reduces to 0 MB).</span>
|
|
</li>
|
|
<li id="cite_note-info-6">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-info_6-0">^</a></span> <span class="reference-text">Miscellaneous information about the cache</span>
|
|
</li>
|
|
<li id="cite_note-7">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-7">^</a></span> <span class="reference-text">Queries image for size (needed for online images; not needed for offline databases) . Recommended: <a href="http://www.imagemagick.org/" rel="nofollow" class="external text">ImageMagick</a></span>
|
|
</li>
|
|
<li id="cite_note-8">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-8">^</a></span> <span class="reference-text">Resizes image (needed for online images; not needed for offline databases) . Recommended: <a href="http://www.imagemagick.org/" rel="nofollow" class="external text">ImageMagick</a></span>
|
|
</li>
|
|
<li id="cite_note-9">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-9">^</a></span> <span class="reference-text">Converts svg to png (needed for online images; not needed for offline databases) . Recommended: <a href="http://www.inkscape.org/" rel="nofollow" class="external text">Inkscape</a></span>
|
|
</li>
|
|
<li id="cite_note-10">
|
|
<span class="mw-cite-backlink"><a href="#cite_ref-10">^</a></span> <span class="reference-text">Converts djvu to png (needed for online images; not needed for offline databases) . Recommended: <a href="http://www.miktex.org/" rel="nofollow" class="external text">MikTeX</a></span>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
|
|
</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(/xowa/wiki/home/page/xowa_logo.png);" href="https://gnosygnu.github.io/xowa/" title="Visit the main page"></a>
|
|
</div>
|
|
<div class="portal" id='xowa-portal-home'>
|
|
<h3>XOWA</h3>
|
|
<div class="body">
|
|
<ul>
|
|
<li><a href="https://gnosygnu.github.io/xowa/" title='Visit the main page'>Main page</a></li>
|
|
<li><a href="https://gnosygnu.github.io/xowa/blog.html" title='Follow XOWA''s development process'>Blog</a></li>
|
|
<li><a href="https://gnosygnu.github.io/xowa/screenshots.html" title='See screenshots of XOWA'>Screenshots</a></li>
|
|
<li><a href="https://gnosygnu.github.io/xowa/download.html" title='Download the XOWA application'>Download XOWA</a></li>
|
|
<li><a href="/xowa/wiki/home/page/Dashboard/Image_databases" title='Download offline wikis and image databases'>Download wikis</a></li>
|
|
<li><a href="https://gnosygnu.github.io/xowa/reviews.html" title='Read what others have written about XOWA'>Media</a></li>
|
|
<li><a href="/xowa/wiki/home/page/Help/About.html" title='Get more information about XOWA'>About</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="portal" id='xowa-portal-help'>
|
|
<h3>Help</h3>
|
|
<div class="body">
|
|
<ul>
|
|
<li><a href="/xowa/wiki/home/page/App/Setup/System_requirements.html" title='Get XOWA's system requirements'>Requirements</a></li>
|
|
<li><a href="/xowa/wiki/home/page/App/Setup/Installation.html" title='Get instructions for installing XOWA'>Installation</a></li>
|
|
<li><a href="/xowa/wiki/home/page/App/Import/Simple_Wikipedia.html" title='Learn how to set up Simple Wikipedia'>Set up Simple Wikipedia</a></li>
|
|
<li><a href="/xowa/wiki/home/page/App/Import/English_Wikipedia.html" title='Learn how to set up English Wikipedia'>Set up English Wikipedia</a></li>
|
|
<li><a href="/xowa/wiki/home/page/App/Import/Other_wikis.html" title='Learn how to set up Other Wikipedias'>Set up Other Wikipedias</a></li>
|
|
<li><a href="/xowa/wiki/home/page/Help/Feedback.html" title='Questions? Comments? Leave feedback for XOWA'>Feedback</a></li>
|
|
<li><a href="/xowa/wiki/home/page/Help/Contents.html" title='View a list of help topics'>Contents</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> |