Extension:Popups

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎中文
MediaWiki extensions manual
Crystal Clear action run.png
Popups

Release status: beta

HoverCard Inheritance.png
Implementation Skin
Description Displays popups when users hover over article links
Author(s) Prateek Saxena, Yair Rand (Prtksxnatalk)
MediaWiki 1.22+
PHP 5.3+
Database changes No
License GNU General Public License 2.0
Download
Hooks used
BeforePageDisplay

Translate the Popups extension if it is available at translatewiki.net

Check usage and version matrix; code metrics
Bugs: list open list all report

The Popups extension displays "hovercards" − popups with summaries of article contents when the user hovers over an article link.

This is an initiative of the Design team, to move popular Gadgets into Beta Features. Mockups and more information available at Hovercards.

Dependencies[edit | edit source]

This extension has a hard dependency on Extension:TextExtracts and Extension:PageImages. There is also an optional dependency on Beta Features (without BetaFeatures, it loads for all users) and Extension:EventLogging (for logging).

Installation[edit | edit source]

  • Download and extract the file(s) in a directory called Popups in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository using:
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Popups.git
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/Popups/Popups.php";
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Content[edit | edit source]

The popups show an image (if one is available), a small text excerpt and the timestamp of the last edit.

Image[edit | edit source]

The image comes from the Extension:PageImages which returns the single most appropriate thumbnail associated with an article. It ignores maintenance templates, stubs, flag icons etc.

Text[edit | edit source]

The text comes from the Extension:TextExtracts from which a plain-text extract is requested (see that extension for exclusions). Even though two sentences are requested a limit is put through CSS that makes sure that text doesn't overflow from the card. This is done by applying a max-height on that element. This approach would provide the same visual solution regardless of the language's script. A major con is that the text stops abruptly and ellipses can't be added.

Show/hide timing[edit | edit source]

The timing of the show/hide can currently be adjusted via this user.js code:

// Time to wait in ms before showing a popup on hover
// @property POPUP_DELAY
mw.popups.render.POPUP_DELAY = 1000;
// Time to wait in ms before closing a popup on de-hover
// @property POPUP_CLOSE_DELAY
mw.popups.render.POPUP_CLOSE_DELAY = 300;
// Time to wait in ms before starting the API queries on hover, must be <= POPUP_DELAY
// @property API_DELAY
mw.popups.render.API_DELAY = 500;