david
/
xowa
mirror of https://github.com/gnosygnu/xowa.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687
							<!DOCTYPE html>
<html dir="ltr">
<head>
  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
  <title>App/Search - 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">
  <style data-source="xowa" type="text/css">
.symbol-col {
    text-align:center;
  }
  code {
    border: solid 1px gray;
    background: #EFEFEF;
    text-align:center;
    padding: 1px;
  }
  .page-inc, .page-exc {
    border: solid 1px gray;
    text-align:center;
    padding: 1px;
  }
  .page-inc {
    background:#89C35C;
  }
  .page-exc {
    background:#F62217;
  }
  .page-inc b, .page-exc b {
    font-weight: bold;
  }
</style>

</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/Search</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 search for a page by title
    </p>
    <div id="toc" class="toc">
      <div id="toctitle" class="toctitle">
        <h2>
          Contents
        </h2>
      </div>
      <ul>
        <li class="toclevel-1 tocsection-1">
          <a href="#Search_by_page_title"><span class="tocnumber">1</span> <span class="toctext">Search by page title</span></a>
        </li>
        <li class="toclevel-1 tocsection-2">
          <a href="#Usage"><span class="tocnumber">2</span> <span class="toctext">Usage</span></a>
        </li>
        <li class="toclevel-1 tocsection-3">
          <a href="#Syntax"><span class="tocnumber">3</span> <span class="toctext">Syntax</span></a> 
          <ul>
            <li class="toclevel-2 tocsection-4">
              <a href="#General"><span class="tocnumber">3.1</span> <span class="toctext">General</span></a>
            </li>
            <li class="toclevel-2 tocsection-5">
              <a href="#Wildcard"><span class="tocnumber">3.2</span> <span class="toctext">Wildcard</span></a>
            </li>
            <li class="toclevel-2 tocsection-6">
              <a href="#Not"><span class="tocnumber">3.3</span> <span class="toctext">Not</span></a>
            </li>
            <li class="toclevel-2 tocsection-7">
              <a href="#Quote"><span class="tocnumber">3.4</span> <span class="toctext">Quote</span></a>
            </li>
          </ul>
        </li>
        <li class="toclevel-1 tocsection-8">
          <a href="#Sorting"><span class="tocnumber">4</span> <span class="toctext">Sorting</span></a>
        </li>
        <li class="toclevel-1 tocsection-9">
          <a href="#Background_database_search"><span class="tocnumber">5</span> <span class="toctext">Background database search</span></a>
        </li>
        <li class="toclevel-1 tocsection-10">
          <a href="#Database_update"><span class="tocnumber">6</span> <span class="toctext">Database update</span></a>
        </li>
        <li class="toclevel-1 tocsection-11">
          <a href="#Options"><span class="tocnumber">7</span> <span class="toctext">Options</span></a>
        </li>
      </ul>
    </div>
    <h2>
      <span class="mw-headline" id="Search_by_page_title">Search by page title</span>
    </h2>
    <p>
      XOWA can find a page by words in its title. For example, typing <code>earth</code> will pull up all titles with the word, including <span class='page-inc'>Earth</span> and <span class='page-inc'>History of Earth</span>. More complicated searches can be performed, such as <code>earth + (history, future) -middle</code>
    </p>
    <p>
      XOWA can also search by text within a page (full-text search). More information is available here: <a href="/wiki/App/Full-text_search" id="xolnki_2" title="App/Full-text search">App/Full-text search</a>
    </p>
    <h2>
      <span class="mw-headline" id="Usage">Usage</span>
    </h2>
    <p>
      There are three ways to use search:
    </p>
    <ul>
      <li>
        Type into the address bar. A list of suggestions appear underneath.
      </li>
      <li>
        Type into the suggest box. A list of suggestions appear underneath. Note that this box is near the top-right hand corner of the page between "View HTML" and the magnifying glass icon.
      </li>
      <li>
        Type "?:some word" into the address bar. For example, enter <code>?:earth</code> in the address bar when in Simple Wikipedia
      </li>
    </ul>
    <h2>
      <span class="mw-headline" id="Syntax">Syntax</span>
    </h2>
    <p>
      The following syntax is supported for search text:
    </p>
    <table class='wikitable' style='background: white;'>
      <tr>
        <th>
          name
        </th>
        <th>
          description
        </th>
        <th>
          symbol
        </th>
        <th>
          example
        </th>
        <th>
          finds
        </th>
        <th>
          skips
        </th>
      </tr>
      <tr>
        <td>
          single word
        </td>
        <td>
          finds pages which start with this word<br>
          (automatic wildcard at the end)
        </td>
        <td>
        </td>
        <td>
          <code>earth</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>Earth</b></span><br>
            <span class='page-inc'><b>History</b> of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b>quake</span>
          </p>
        </td>
        <td>
        </td>
      </tr>
      <tr>
        <td>
          single word with space
        </td>
        <td>
          finds pages which have this word exactly<br>
           (no automatic wildcard)
        </td>
        <td>
        </td>
        <td>
          <code>earth&nbsp;</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>Earth</b></span><br>
            <span class='page-inc'><b>History</b> of <b>Earth</b></span>
          </p>
        </td>
        <td>
          <span class='page-exc'>Earthquake</span>
        </td>
      </tr>
      <tr>
        <td>
          multiple words
        </td>
        <td>
          finds pages which have all these words
        </td>
        <td>
        </td>
        <td>
          <code>earth history</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>History</b> of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b> <b>history</b></span>
          </p>
        </td>
        <td>
          <span class='page-exc'>Earth</span>
        </td>
      </tr>
      <tr>
        <td>
          wildcard
        </td>
        <td>
          finds pages which start with these letters
        </td>
        <td class='symbol-col'>
          <code>*</code>
        </td>
        <td>
          <code>earth*</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>Earth</b></span><br>
            <span class='page-inc'>History of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b>quake</span>
          </p>
        </td>
        <td>
        </td>
      </tr>
      <tr>
        <td>
        </td>
        <td>
          finds pages which end with these letters
        </td>
        <td class='symbol-col'>
          <code>*</code>
        </td>
        <td>
          <code>*earth</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>Earth</b></span><br>
            <span class='page-inc'>History of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b>quake</span><br>
            <span class='page-inc'>H<b>earth</b></span>
          </p>
        </td>
        <td>
        </td>
      </tr>
      <tr>
        <td>
        </td>
        <td>
          finds pages which start / end with these letters
        </td>
        <td class='symbol-col'>
          <code>*</code>
        </td>
        <td>
          <code>e*h</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>Earth</b></span><br>
            <span class='page-inc'>History of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b>quake</span><br>
            <span class='page-inc'><b>E</b>nglis<b>h</b> language</span>
          </p>
        </td>
        <td>
        </td>
      </tr>
      <tr>
        <td>
          not
        </td>
        <td>
          skips pages which have this word
        </td>
        <td class='symbol-col'>
          <code>-</code>
        </td>
        <td>
          <code>earth -history</code>
        </td>
        <td>
          <span class='page-inc'><b>Earth</b></span>
        </td>
        <td>
          <span class='page-exc'>History of Earth</span>
        </td>
      </tr>
      <tr>
        <td>
          or
        </td>
        <td>
          includes pages which have this word
        </td>
        <td class='symbol-col'>
          <code>,</code>
        </td>
        <td>
          <code>earth, history</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>History</b> of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b> <b>history</b></span><br>
            <span class='page-inc'><b>History</b></span><br>
            <span class='page-inc'><b>Earth</b></span>
          </p>
        </td>
      </tr>
      <tr>
        <td>
          and
        </td>
        <td>
          requires pages to have this word
        </td>
        <td class='symbol-col'>
          <code>+</code>
        </td>
        <td>
          <code>earth + history</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>History</b> of <b>Earth</b></span><br>
            <span class='page-inc'><b>Earth</b> <b>history</b></span>
          </p>
        </td>
        <td>
          <span class='page-exc'>History</span><br>
           
          <p>
            <span class='page-exc'>Earth</span>
          </p>
        </td>
      </tr>
      <tr>
        <td>
          quote
        </td>
        <td>
          requires pages to have this exact text
        </td>
        <td class='symbol-col'>
          <code>"</code>
        </td>
        <td>
          <code>"earth history"</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>Earth history</b></span>
          </p>
        </td>
        <td>
          <p>
            <span class='page-exc'>History of Earth</span><br>
            <span class='page-exc'>History</span><br>
            <span class='page-exc'>Earth</span>
          </p>
        </td>
      </tr>
      <tr>
        <td>
          parentheses
        </td>
        <td>
          allows complicated and / or grouping
        </td>
        <td class='symbol-col'>
          <code>(</code> <code>)</code>
        </td>
        <td>
          <code>earth + (history, future)</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>History</b> of <b>Earth</b></span><br>
            <span class='page-inc'><b>Future</b> of <b>Earth</b></span>
          </p>
        </td>
        <td>
          <span class='page-exc'>Earth</span>
        </td>
      </tr>
      <tr>
        <td>
          escape
        </td>
        <td>
          allows searching for any symbols above
        </td>
        <td class='symbol-col'>
          <code>\</code>
        </td>
        <td>
          <code>c\+\+</code>
        </td>
        <td>
          <p>
            <span class='page-inc'><b>C++</b></span>
          </p>
        </td>
      </tr>
    </table>
    <h3>
      <span class="mw-headline" id="General">General</span>
    </h3>
    <ul>
      <li>
        Spaces are ignored 
        <ul>
          <li>
            <code>earth, history</code> is the same as <code>earth , history</code> or <code>earth ,history</code>
          </li>
        </ul>
      </li>
      <li>
        Incorrect terms are auto-corrected as per the following: 
        <ul>
          <li>
            <code>earth - history</code> is the same as <code>earth history</code>
          </li>
          <li>
            <code>earth +</code> is the same as <code>earth</code>
          </li>
          <li>
            <code>earth,</code> is the same as <code>earth</code>
          </li>
          <li>
            <code>"earth</code> is the same as <code>"earth"</code>. Note that <code>"earth history</code> becomes <code>"earth" history</code>.
          </li>
          <li>
            <code>(earth</code> is the same as <code>earth</code>
          </li>
          <li>
            <code>c\</code> is the same as <code>c</code>
          </li>
        </ul>
      </li>
    </ul>
    <h3>
      <span class="mw-headline" id="Wildcard">Wildcard</span>
    </h3>
    <ul>
      <li>
        Wildcards are automatically added to the last word. For example, <code>earth histor</code> is the same as <code>earth histor*</code>.
      </li>
      <li>
        Wildcards will be slower than non-wildcarded versions. In terms of performance, they are ranked as following: 
        <ul>
          <li>
            <b>end of word</b> 
            <ul>
              <li>
                faster, especially when word is longer. EX: <code>abcdefghi*</code> vs <code>a*</code>
              </li>
              <li>
                may be slow for certain multi-word queries. EX: <code>page meg*</code>
              </li>
              <li>
                uses the <code>&gt;=</code> <code>&lt;</code> operators: <code>word_text &gt;= ? AND word_text &lt; ?</code>
              </li>
              <li>
                uses an INDEX scan
              </li>
            </ul>
          </li>
          <li>
            <b>beginning of word</b> / <b>middle of word</b> 
            <ul>
              <li>
                may be fast if matching a common string. EX: <code>*a</code>, <code>*arth</code>
              </li>
              <li>
                will be slow for queries that don't match results. EX: <code>ea*rh</code>
              </li>
              <li>
                uses the LIKE operator: <code>word_text LIKE ? ESCAPE '|'</code>
              </li>
              <li>
                uses a TABLE scan
              </li>
            </ul>
          </li>
        </ul>
      </li>
    </ul>
    <h3>
      <span class="mw-headline" id="Not">Not</span>
    </h3>
    <ul>
      <li>
        <code>-</code> only works at the start of the word 
        <ul>
          <li>
            <code>earth hi-story</code> is the same as <code>earth "hi-story"</code>. In other words, the <code>-</code> is literal
          </li>
        </ul>
      </li>
      <li>
        <code>-</code> must be used with a word. Entering just <code>-QXZ</code> will return 0 results
      </li>
    </ul>
    <h3>
      <span class="mw-headline" id="Quote">Quote</span>
    </h3>
    <ul>
      <li>
        Quotes can also be used for escaping. For example <code>"c++"</code> is the same as <code>c\+\+</code>
      </li>
      <li>
        Quotes must be doubled up inside quotes. For example <code>"a""b"</code> means search for a word with <code>a"b</code>
      </li>
    </ul>
    <h2>
      <span class="mw-headline" id="Sorting">Sorting</span>
    </h2>
    <p>
      By default, XOWA returns results sorted by "page length descending". In other words, the largest page would be the first in the list and the smallest page would be the last.
    </p>
    <p>
      If a wiki is built with PageRank, or if a wiki is downloaded from archive.org, then the results will be sorted by "PageRank descending". See <a href="/wiki/Options/Search" id="xolnki_3" title="Options/Search">Options/Search</a> for enabling PageRank.
    </p>
    <h2>
      <span class="mw-headline" id="Background_database_search">Background database search</span>
    </h2>
    <p>
      By default, XOWA runs database searches in the background. This will return results to the screen quickly for complicated searches. For example, consider a search for <code>Earth*</code>:
    </p>
    <ul>
      <li>
        When the search runs in the background, the first result shows up in 2 seconds, and more results show up every second afterwards. The search will complete in 5 seconds.
      </li>
      <li>
        When the search does not run in the background, all the results show up at the 5 second mark.
      </li>
    </ul>
    <p>
      While a search is running in the background, there will be a link called <code>Stop searching</code>. Clicking on the link will stop the background search, though the current results may be incomplete.
    </p>
    <p>
      Finally, all search results are cached. The first time you search for <code>Earth*</code>, XOWA will search the database. Every time afterwards, it will pull the results up from memory. If you restart XOWA, it will search the database again.
    </p>
    <h2>
      <span class="mw-headline" id="Database_update">Database update</span>
    </h2>
    <p>
      XOWA wikis created before v3.3.4.1 will need to be upgraded. XOWA will detect if an upgrade is needed, and show a message box for confirmation. The upgrade process will take a few minutes.
    </p>
    <p>
      Note that new wikis created after v3.3.4.1 will automatically be in the new format.
    </p>
    <h2>
      <span class="mw-headline" id="Options">Options</span>
    </h2>
    <p>
      There are 2 pages for configuring Search
    </p>
    <ul>
      <li>
        <b>Configure PageRank</b>: See <a href="/wiki/Options/Search" id="xolnki_4" title="Options/Search">Options/Search</a>
      </li>
      <li>
        <b>Configure Address bar autocomplete</b>: See <a href="/wiki/Options/Search_suggest" id="xolnki_5" title="Options/Search suggest">Options/Search_suggest</a>
      </li>
    </ul>
    <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(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="http://xowa.org/home/wiki/Help/Donate.html" title="Support XOWA!">XOWA</a></li>
      </ul>
    </div>
  </div>
  
</div>
</body>
</html>