Extension:MultimediaViewer

This extension comes with MediaWiki 1.31 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

MediaWiki extensions manual

MultimediaViewer Release status: stable
Implementation	User interface, Ajax
Description	Provides a better experience to users when they click on thumbnails in a page
Author(s)	Mark Holmquist Gergő Tisza Gilles Dubuc
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.25+
PHP	5.4+
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (Phabricator · GitHub) commit history repository contributors (GitHub) code review
Example	MediaWiki.org
Parameters $wgMediaViewerUseThumbnailGuessing $wgMediaViewerRecordVirtualViewBeaconURI $wgMediaViewerImageQueryParameter $wgMediaViewerEnableByDefault $wgMediaViewerEnableByDefaultForAnonymous $wgMediaViewerExtensions
Hooks used BeforePageDisplay CategoryPageView GetPreferences MakeGlobalVariablesScript ResourceLoaderGetConfigVars ThumbnailBeforeProduceHTML UserGetDefaultOptions
Quarterly downloads	188 (Ranked 48th)
Public wikis using	1,926 (Ranked 195th)
Translate the MultimediaViewer extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The MultimediaViewer extension gives the user of a wiki a different interface for viewing full-size, or nearly full-size, images in their browser without extraneous page loads or confusing interstitial pages.

Installation

First, consider installing Extension:BetaFeatures . It may be helpful to hide the media viewer feature behind a preference. If you do not install this, it will be enabled everywhere.

You will also likely want to download Extension:CommonsMetadata . It is not a hard requirement, but without it you will not get very much information into the boxes showing details about the images.

• Download and place the file(s) in a directory called MultimediaViewer in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'MultimediaViewer' );
  

• Configure as required
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Vagrant installation:

• If using Vagrant , install with vagrant roles enable multimediaviewer --provision

Configuration

• $wgMediaViewerIsInBeta will register a preference with BetaFeatures if set to "true"
• $wgMediaViewerEnableByDefault and $wgMediaViewerEnableByDefaultForAnonymous will determine whether MMV is enabled by default for everyone and for anonymous users, respectively. They both default to true. $wgDefaultUserOptions[ 'multimediaviewer-enable' ] = 1; can be used as a replacement for $wgMediaViewerEnableByDefault.
• $wgMediaViewerUseThumbnailGuessing will improve performance when enabled, but can be fragile depending on how the wiki is set up (it will probably work fine if you use a 404 handler).

Forced download

To ensure files are offered for download and not viewed in the user's browser following a click on the Download … button, the server has to be configured, except when using vagrant:

If the requested URL to an image directory contains the download query parameter, the Content-Disposition-header must be set to attachment. This can be achieved in Apache and compatible servers using mod_rewrite and mod_headers in a .htaccess file. Varnish configuration can look like this.

Usage testing

First thing, before testing, is to make sure you're logged in and you have the preference enabled: Log in to the wiki and go to Special:Preferences, then visit the "Beta features" tab and check the appropriate box.

Next, go to a page that has a thumbnail on it. Try clicking on the image or on the "expand" icon near it. The lightbox should pop up and give you a bigger view of the image.

If you'd prefer, there's an exported test environment that you can use via Special:Import to quickly set up a suitable testing environment.

Templates

MultimediaViewer and UploadWizard need several templates to show data of photos. Just save this code in a xml file and import it in your wiki.

See also

• Help:Extension:Media Viewer
• Multimedia/Media Viewer
• Extension:SlimboxThumbs