Extension:MultimediaViewer

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
MultimediaViewer

Release status: beta

Implementation Media
Description Provides a better experience to users when they click on thumbnails in a page
Author(s) Mark Holmquist (MarkTraceurtalk)
Latest version 0.2.0 (2013-11-20)
MediaWiki 1.23+
PHP 5.3+
Database changes No
License GPLv2+
Download
Example Multimedia Alpha site
Namespace main
Hooks used
GetBetaFeaturePreferences

BeforePageDisplay
CategoryPageView
ResourceLoaderGetConfigVars

Translate the MultimediaViewer extension if possible

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

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

Installation[edit | edit source]

Option A: use Vagrant. See the MediaWiki-Vagrant page for instructions to get a MediaWiki installation going with a Vagrant virtual machine system.

Then do vagrant enable-role multimediaviewer and then vagrant provision.

Option B: install manually.

First, consider installing Extension:BetaFeatures. It may be helpful to hide the media viewer feature behind a preference. If you don't install this, it will be enabled everywhere. MultimediaViewer uses the GetBetaFeaturePreferences hook, which is created and run from BetaFeatures, to register this preference.

  • Download and extract the files in a directory called MultimediaViewer in your extensions/ folder. If you're a developer and this extension is in a Git repository, then instead you should clone the repository.
  • Add the following code at the bottom of your LocalSettings.php:
require_once( "$IP/extensions/MultimediaViewer/MultimediaViewer.php" );
  • Done! Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Configuration[edit | edit source]

There are two configuration variables that are relevant for MultimediaViewer - $wgMediaViewerIsInBeta, which will register a preference with BetaFeatures if set to true, and $wgEnableMediaViewerForLoggedInUsersOnly, which will turn MMV on for only logged-in users if set to true. If neither are set, MMV will be turned on for all users!

Setting up context for metadata[edit | edit source]

You might want to create a structure similar to what User:MarkTraceur has on his wiki, which is a barebones version of the Commons Information template system. You'll also likely want to download Extension:CommonsMetadata - it's not a hard requirement, but without it you won't get very much information in your lightboxes.

You should probably also add [[Category:CC-BY-SA-3.0]] to the image in order to test some of the licensing functionality.

Using the extension[edit | edit source]

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.

See also[edit | edit source]