Extension:Popups

From MediaWiki.org
Jump to: navigation, search

Other languages:
català • ‎Deutsch • ‎English • ‎español • ‎suomi • ‎français • ‎italiano • ‎日本語 • ‎한국어 • ‎polski • ‎português • ‎português do Brasil • ‎русский • ‎sicilianu • ‎中文
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
Popups

Release status:Extension status beta

HoverCard Inheritance.png
ImplementationTemplate:Extension#type Skin
DescriptionTemplate:Extension#description Displays popups when users hover over article links
Author(s)Template:Extension#username Prateek Saxena, Yair Rand, Sam Smith, Joaquín Oltra Hernández, Bahodir Mansurov, Jon Robson, Piotr Miazga, Jeff Hobson (Prtksxnatalk)
MediaWikiTemplate:Extension#mediawiki 1.25+
PHPTemplate:Extension#php 5.4+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
Hooks usedTemplate:Extension#hook
GetBetaFeaturePreferencesManual:Hooks/GetBetaFeaturePreferences
GetPreferencesManual:Hooks/GetPreferences
BeforePageDisplayManual:Hooks/BeforePageDisplay
ResourceLoaderTestModulesManual:Hooks/ResourceLoaderTestModules
ResourceLoaderGetConfigVarsManual:Hooks/ResourceLoaderGetConfigVars
MakeGlobalVariablesScriptManual:Hooks/MakeGlobalVariablesScript
UserGetDefaultOptionsManual:Hooks/UserGetDefaultOptions

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

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The Popups extension displays page previews − summaries of an article's content when the user hovers over a link to that article.

This is an initiative of the Design team, inspired by the popular Navigation popups gadget. Currently this feature is available on all Wikipedias (with an exception of English and German Wikipedia). A description of how the extension functions and more information on its use on Wikimedia projects is available at Page Previews.

Dependencies[edit]

This extension has a hard dependency on Extension:TextExtractsExtension:TextExtracts and Extension:PageImagesExtension:PageImages. There are also optional dependencies on Beta FeaturesBeta Features (without BetaFeatures, it loads for all users), and Extension:EventLoggingExtension:EventLogging and Extension:WikimediaEventsExtension:WikimediaEvents (for instrumentation).

Installation[edit]

  • Download and place the file(s) in a directory called Popups in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'Popups' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'Popups' );, you need to use:

require_once "$IP/extensions/Popups/Popups.php";
  • Enable the beta feature
$wgPopupsBetaFeature = true;

Configuration options[edit]

Option Default value Useful for... Documentation
$wgPopupsBetaFeature false sysadmins Whether the extension should be enabled as an opt-in beta feature. If true, the BetaFeatures extension must be installed. False by default.
$wgPopupsHideOptInOnPreferencesPage false sysadmins Whether the option to enable/disable Page Previews should be hidden on Preferences page. Please note if PopupsBetaFeature is set to true this option will be always hidden. False by default
$wgPopupsOptInDefaultState 0 sysadmins Default Page Previews visibility. Has to be a string as a compatibility with beta feature settings
$wgPopupsConflictingNavPopupsGadgetName Navigation_popups sysadmins Navigation popups gadget name
$wgPopupsGateway mwApiPlain sysadmins Which gateway to use for fetching Popups data. Available options: [mwApiPlain|restbasePlain|restbaseHTML]. Full and always up to date list is available in src/gateway/index.js
$wgPopupsAnonsExperimentalGroupSize 0 sysadmins Defines the fraction of users that should be subject to an A/B test. When enabled half of users in this group will see page previews. The rest will be divided into one of two buckets where previews will not show and the control group size will match the enabled bucket. If undefined, or 0, no users will be subject to experimentation and previews will be enabled for everyone unless $wgPopupsBetaFeature is enabled.
$wgPopupsEventLogging false sysadmins Whether we should log events. This should be used carefully alongside PopupsAnonsExperimentalGroupSize. Note if this is enabled without using that variable events will be logged for all users. Be careful!
$wgPopupsExperiment true sysadmins Enables A/B experiments with Popups in desktop stable.
$wgPopupsExperimentConfig
$wgPopupsExperimentConfig = [
        'name' => 'Popups A/B Test - May, 2016',
        'enabled' => true,
        'buckets' => [
                'control' => 0.5,
                'A' => 0.5
        ],
];
sysadmins Configuration for Popups A/B test

control and bucket determine which percentage of users will see Popups enabled. Bucketing is done per browser/device, not user accounts.

$wgPopupsExperiment will override the experiment setting enabling Popups if explicitly enabled in beta features.

$wgPopupsSchemaSamplingRate 0 sysadmins Sampling rate for logging performance data to statsv
$wgPopupsSurveyLink sysadmins URL for survey
$wgPopupsPageBlacklist [ "Special:Userlogin", "Special:CreateAccount" ] sysadmins Blacklisted pages are subject to the HTML cache policy of the wiki. A purge on a blacklisted page maybe needed to see the effect of this configuration variable. Every blacklisted page should be defined by a canonical name, eg: Special:Userlogin

Content[edit]

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

Image[edit]

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]

The text comes from the Extension:TextExtracts from which a plain-text extract is requested (see that extension for exclusions). Two sentences are requested from the intro section and 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]

The timing of the show/hide can currently be adjusted via code, which should be added to your local common.js or global.js file :

mw.loader.using( [ 'ext.popups' ], function() { // wait for popups to be loaded

// Time to wait in ms before showing a popup on hover. Default is 500.
mw.popups.render.POPUP_DELAY = 500;

// Time to wait in ms before closing a popup on de-hover. Default is 300.
mw.popups.render.POPUP_CLOSE_DELAY = 300;

// Time to wait in ms before starting the API queries on hover, must be <= POPUP_DELAY. Default is 50.
// Don't change this unless you know what you're doing.
mw.popups.render.API_DELAY = 50;

});

Renderers[edit]

This extensions currently has only one renderer, that is for ordinary pages.

New renderers for different kind of pages, or things like references can be easily added.

One needs to create a new object with the following methods:

  • init
  • createPopup
  • getOffset
  • getClasses
  • processPopup

You can see details of these methods in ext.popups.renderer.article.js or this patch that adds a renderer for references.


Known problems[edit]

Users of the Translate extension should note that Page Previews requests previews in the content language of the page. If the preview contains a complete translatable block, then it will be translated. If, however, the preview contains an incomplete translateable block – because a sentence is cut off, say – then it isn't translated and will be displayed in the content language of the page. If you are observing this behavior, then you should consider marking up individual sentences in your lead section.

T167852 is for a technical audience but has more information on the underlying problem.

FAQ[edit]

Why can't I copy and paste text from a preview?[edit]

At time of writing, the cons of doing so outweigh the pros. Essentially it boils down to decreasing the touch area to read the article in full. Once Page Previews is deployed on English and German Wikipedia, feel free to reopen this task and reignite the discussion, but right now we have no plans.

How can I remove content from a page preview?[edit]

TextExtracts will strip any element that is marked with the noexcerpt class. This class is one of the classes in the wgExtractsRemoveClasses configuration variable.