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


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
							<!DOCTYPE html>
<html dir="ltr">
<head>
  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
  <title>App/Xtn/Html/Popups - 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/Xtn/Html/Popups</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>
      <b>XOWA Popups</b> appear when hovering over a link. They will show the first part of the page for the hovered link.
    </p>
    <div id="toc" class="toc">
      <div id="toctitle">
        <h2>
          Contents
        </h2>
      </div>
      <ul>
        <li class="toclevel-1 tocsection-1">
          <a href="#Purpose"><span class="tocnumber">1</span> <span class="toctext">Purpose</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="#Background"><span class="tocnumber">3</span> <span class="toctext">Background</span></a>
        </li>
        <li class="toclevel-1 tocsection-4">
          <a href="#Design_principles"><span class="tocnumber">4</span> <span class="toctext">Design principles</span></a>
        </li>
        <li class="toclevel-1 tocsection-5">
          <a href="#Future_changes"><span class="tocnumber">5</span> <span class="toctext">Future changes</span></a>
        </li>
        <li class="toclevel-1 tocsection-6">
          <a href="#Technical_details"><span class="tocnumber">6</span> <span class="toctext">Technical details</span></a> 
          <ul>
            <li class="toclevel-2 tocsection-7">
              <a href="#Words"><span class="tocnumber">6.1</span> <span class="toctext">Words</span></a>
            </li>
            <li class="toclevel-2 tocsection-8">
              <a href="#Parser"><span class="tocnumber">6.2</span> <span class="toctext">Parser</span></a>
            </li>
          </ul>
        </li>
      </ul>
    </div>
    <h2>
      <span class="mw-headline" id="Purpose">Purpose</span>
    </h2>
    <p>
      <b>XOWA Popups</b> shows a preview of an article when hovering over a link. It has the following benefits:
    </p>
    <ul>
      <li>
        <b>No click</b>: Articles can be retrieved by <i>hovering</i> over a link rather than <i>clicking</i> on it.
      </li>
      <li>
        <b>Same view</b>: The preview shows up in the same visual space as the current article, where the current text is still available.
      </li>
    </ul>
    <p>
      <br>
    </p>
    <h2>
      <span class="mw-headline" id="Usage">Usage</span>
    </h2>
    <ul>
      <li>
        Hover over a link to popup a preview
      </li>
      <li>
        Links in popups are also previewable. Note that only 2 popups can be visible at any point in time.
      </li>
      <li>
        Hovering over the 2nd popup will display a 3rd popup, but the 1st popup will disappear.
      </li>
      <li>
        Each popup has a control panel with the following commands 
        <ul>
          <li>
            Open popup's page in current tab
          </li>
          <li>
            Open popup's page in new tab and switch focus to the new tab
          </li>
          <li>
            Open popup's page in new tab but stay on current tab
          </li>
          <li>
            Bookmark popup's page
          </li>
          <li>
            Show more text from the popup's page
          </li>
          <li>
            Show all text from the popup's page
          </li>
          <li>
            Go to the Popup option page.
          </li>
        </ul>
      </li>
    </ul>
    <p>
      <br>
    </p>
    <h2>
      <span class="mw-headline" id="Background">Background</span>
    </h2>
    <p>
      <b>XOWA Popups</b> is based on MediaWiki's <a href="https://www.mediawiki.org/wiki/Extension:Hovercards" rel="nofollow" class="external text">Hovercards</a> and <a href="https://en.wikipedia.org/wiki/Wikipedia:Tools/Navigation_popups" rel="nofollow" class="external text">Navigation popups</a>. It does not aim to be an exact reproduction of either, but picks the best features from each.
    </p>
    <p>
      The javascript was modified from Reference tooltips, which was kindly provided by <a href="https://de.wikipedia.org/wiki/Benzuter:Schnark" rel="nofollow" class="external text">Schnark</a>.
    </p>
    <p>
      <br>
    </p>
    <h2>
      <span class="mw-headline" id="Design_principles">Design principles</span>
    </h2>
    <p>
      The following is a list of intentional design differences from MediaWiki's Hovercards and Navigation Popups:
    </p>
    <ul>
      <li>
        Popups retrieve as much text as possible, including sections, not just text from the introductory paragraphs. This behavior is necessary because: 
        <ul>
          <li>
            Wikis like Wiktionary don't have a concept of an introductory paragraph.
          </li>
          <li>
            Many articles have very short introductory sentences, which do not provide much info.
          </li>
        </ul>
      </li>
      <li>
        Popups are word based, not sentence based. There are some defects with MediaWiki's Hovercards which stops at abbreviations. For example, "St." counts as a sentence.
      </li>
      <li>
        Popup lengths are customizable, not fixed (unlike MediaWiki Hovercards's 2 sentences)
      </li>
      <li>
        Popups show links, lists, advanced formatting, and math equations.
      </li>
    </ul>
    <p>
      <br>
    </p>
    <h2>
      <span class="mw-headline" id="Future_changes">Future changes</span>
    </h2>
    <ul>
      <li>
        <b>Redlinks</b>: Popups do not indicate missing links in red. This should be added within the next few releases
      </li>
      <li>
        <b>Single image</b>: XOWA will provide a single image preview, just like MediaWiki Hovercards. However, it may be several weeks before this is included.
      </li>
      <li>
        <b>Popup window management</b>: Popups are automatically hidden / shown based on mouse movement. A future version may provide the ability to "move", "pin", "close", etc. I may need some help with the javascript to do so. See: /xowa/bin/any/xowa/html/modules/xowa.popups/xowa.popups.js
      </li>
      <li>
        <b>Performance</b>: Most articles should preview in less than one second, but some articles may take as long as 5. This performance will be improved whenever HTML dumps are included in XOWA, though this may be several months.
      </li>
    </ul>
    <p>
      <br>
    </p>
    <h2>
      <span class="mw-headline" id="Technical_details">Technical details</span>
    </h2>
    <h3>
      <span class="mw-headline" id="Words">Words</span>
    </h3>
    <p>
      <b>XOWA Popups</b> has the following rules for words:
    </p>
    <ul>
      <li>
        A word is one or more characters terminated by a space, tab, new line, wikitext token, or end of document. For example, "A B C" is three words: 2 terminated by a space, and one by the end of the document. Meanwhile, "A[[B]]C" is three words, as <code>[[</code> and <code>]]</code> are wikitext tokens.
      </li>
      <li>
        Words inside a &lt;table&gt;, &lt;div&gt;, [[File:]], or [[Category:]] are not included.
      </li>
      <li>
        Words counts are not exact. Currently, the following rules govern word counts, but may change in the future: 
        <ul>
          <li>
            A header counts as one word. For example, "== A B C ==" is one word, not three.
          </li>
          <li>
            The entire caption of an external link counts as one word. For example, "[http://a.org b c d]" is one word, not three.
          </li>
        </ul>
      </li>
    </ul>
    <h3>
      <span class="mw-headline" id="Parser">Parser</span>
    </h3>
    <p>
      <b>XOWA Popups</b> uses a modified version of the XOWA parser. The popup parser has the following attributes:
    </p>
    <ul>
      <li>
        <b>Faster incremental parsing</b>: An article is parsed incrementally, in smaller pieces, rather than all at once. This allows for speedier, sub-second article views, which is important for large articles (&gt; 40 KB).
      </li>
      <li>
        <b>Textual data only</b>: In keeping with both MediaWiki approaches, only textual data is shown. Tables, boxes (infoboxes, navboxes), and images are removed from the preview.
      </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="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>
      </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 class="portal" id='xowa-portal-image'>
      <br/>
      <a href="https://play.google.com/store/apps/details?id=org.xowa" class="image">
        <img width='140px' src="https://gnosygnu.github.io/xowa/en-play-badge.png" />
      </a>    
  </div>
  
</div>
</body>
</html>