|This extension is maintained by the Reading Web team.|
Release status: stable
|Description||Displays popups when users hover over article links and footnote markers|
|License||GNU General Public License 2.0 or later|
|Translate the Popups extension if it is available at translatewiki.net|
|Check usage and version matrix.|
|Issues||Open tasks · Report a bug|
The Popups extension displays page and reference previews when hovering over a link to an article or respectively to a reference. The former consists of summaries of an article's content, the latter shows the full content of the reference.
The extension is an initiative of the Design team, inspired by the popular Navigation popups gadget. Currently this feature is available on all Wikipedias by default for logged-out users. A description of how the extension functions and more information on its use on Wikimedia projects is available at Page Previews.
The Reference Previews feature was added eventually and aims to fulfill a wish from the German-speaking community's Technical Wishlist. A more detailed description and more information on its use is available at Reference Previews.
- 1 Dependencies
- 2 Installation
- 3 Page previews API
- 4 Configuration options
- 5 Page previews content
- 6 Reference previews content
- 7 Renderers
- 8 Known problems
- 9 FAQ
- 10 Links
This extension has a hard dependency on Extension:TextExtracts and Extension:PageImages. There are also optional dependencies on Beta Features (if you want to enable the Reference Previews as beta feature), and Extension:EventLogging and Extension:WikimediaEvents (for instrumentation).
- Install the dependencies.
- Download and place the file(s) in a directory called
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'Popups' );
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
To users running MediaWiki 1.25 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.25 and earlier), instead of
wfLoadExtension( 'Popups' );, you need to use:
Example of final LocalSettings configuration for a non-testing site (regular wiki)
wfLoadExtensions([ 'TextExtracts', 'PageImages', 'Popups' ]); $wgPopupsHideOptInOnPreferencesPage = true; $wgPopupsOptInDefaultState = '1'; $wgPopupsReferencePreviewsBetaFeature = false;
Page previews API
Every project is different, and what displays in your previews is highly dependent on the content inside your wiki.
Extension:Popups has been optimised to work with Wikipedia-like content (e.g. wikitext). If your wiki is using a different kind of content handler (for example as is the case for Wikibase) it will need to provide its own API.
The API can be written in any language, but the response of the API must match the spec defined here:
Defining new APIs is out of scope for the Popups extension.
Once defined, you can configure page previews to point to your API using $wgPopupsRestGatewayEndpoint configuration option.
|Option||Default value||Useful for...||Documentation|
||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|
||sysadmins||Default Page Previews visibility. Has to be a string as a compatibility with beta feature settings|
||sysadmins||Navigation popups gadget name|
||sysadmins||Which gateway to use for fetching Popups data. Available options: [mwApiPlain|restbasePlain|restbaseHTML]. Full and always up to date list is available in |
||sysadmins||Whether Reference Previews should be available as a Beta feature, or be enabled for all users by default.|
||sysadmins||Specify a REST endpoint where summaries should be sourced from. Endpoint must meet the spec at Specs/Summary/1.2.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 |
||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!|
||sysadmins||Sampling rate for logging performance data to statsv|
||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: |
Page previews content
The page preview popups show an image (if one is available) and a small text excerpt.
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.
The page previews can be configured with any compatible API that is compatible with the Page content service summary endpoint using
$wgPopupsRestGatewayEndpoint. For third parties we encourage using the Page Content Service to enjoy using Popups with your local wiki.
Reference previews content
The content in the reference preview popups is taken directly from the reference section on the page itself. No external services are involved here. If the content exceeds the popup size scrollbars are shown so everything can be looked at.
The reference types displayed are set by using specific CSS-classes on the
<cite>-tag that can be used to encapsulate the content of a reference e.g.
Currently there are four different types supported:
Apart from that there is always a generic fallback if neither the cite tag was found nor an appropriate class was used.
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:
- 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.
- Longer math formulas cutting off in preview - long math or chemical formulas (formulas wider than the preview width) display as truncated in previews. We were not able to add a gradient in order to indicate that the formula is continued on the article itself.
Why can't I copy and paste text from a preview?
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 change the image that I see on preview?
How can I remove content from a page preview?
Any element marked with the
noexcerpt class will be stripped from the summary.
Where do summaries come from?
These are provided by the Summary REST API.
Why are parenthetical stripped?
There's a good discussion going on in T91344 in Phabricator. If you have any views on this or see any problems relating to this, please let us know there.
Why don't I see Popups outside of content namespaces?
Popups appear on links to pages in content namespaces only. This is a limitation of Popups; TextExtracts are available from other namespaces. You may work around this by appending more namespaces into $wgContentNamespaces.
- Page Previews help page and central feedback page on MediaWiki.org
- Reference Previews help page and central feedback page on MediaWiki.org
- Reference Previews main project page on Meta
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|