Extension:UploadWizard

The UploadWizard extension allows a user to upload multiple files with a step-by-step JavaScript wizard.

See also: 1>Commons:Special:MyLanguage/Commons:Upload Wizard|Upload Wizard description page on Wikimedia Commons

Enabling uploads and thumbnails
Your MediaWiki will need to be capable of hosting media files and creating thumbnails (smaller previews of media files). If you can upload images and see smaller previews on their File page, you're already ready. If not, for full instructions, see , particularly 2>Special:MyLanguage/Manual:Image administration#Image thumbnailing|image thumbnailing.


 * For GNU/Linux or Mac OS X users :


 * Make sure that the   directory is writable by your web server.
 * Install the [https://www.imagemagick.org/index.php ImageMagick] libraries and binaries.
 * Download and extract the UploadWizard files as specified here: Special:ExtensionDistributor/UploadWizard
 * Add the following configuration to LocalSettings.php:

You also need to change the following core configuration variable.

You should also install the extension. This is used only if you use the campaigns feature, and should be made a soft dependency at some point in the future.

Enabling Flickr uploads
You can also use UploadWizard to transfer files directly from Flickr. To enable this option, first you'll need to get an API key from Flickr:


 * 1) Log in to Flickr;
 * 2) Go to the Apps By You page in the Flickr App Garden;
 * 3) Click on 'Get another key';
 * 4) Choose 'Apply for a non-commercial key';
 * 5) Enter a name and a description and check the two waiver checkboxes before submitting.

Once you have a key, add the following to your LocalSettings.php:

You may also want to limit the upload domains specifically to Flickr:

Updating from versions before 07/2013
The following is essentially important if you made use of the Campaign feature:
 * Update MediaWiki core to version 1.22 or later
 * Check your custom configuration against the new default config. Parameters like automatically added categories changed (  →  ).
 * Install.
 * Run

Other configuration

 * You need to have InstantCommons enabled in order to access the licensing tutorial. To enable InstantCommons add  to.
 * You may want to set  in LocalSettings.php, where /wiki/ is the correct path for your wiki. A more general way of doing this that works for whatever path configuration you have, but that requires PHP 5.3 or later is:

This modifies the sidebar's "Upload file" link - probably in other places as well. More at.

Several other options are available through a configuration array. For example:

Usage in license-free environments
If you are installing UploadWizard in an environment where licenses are not used, you may want to add the configuration below to LocalSettings.php. This will limit the license choices to a single default that references the wiki's generic disclaimer. Note that there are many other configuration settings to add depending on your use case.

Modifying the generic UI messages
If you wish to modify the generic messages, you can do so within the wiki itself editing the following pages:


 * MediaWiki:Mwe-upwiz-source-ownwork
 * MediaWiki:Mwe-upwiz-source-ownwork-assert-generic
 * MediaWiki:Mwe-upwiz-source-ownwork-generic-explain

URL arguments
There are several URL arguments that can be specified to alter the behaviour of the UploadWizard:


 * campaign: Specifies which upload campaign to use.
 * description: Sets the initial value for the description field.
 * lat: Sets the initial value for the latitude field.
 * lon: Sets the initial value for the longitude field.
 * alt: Sets the initial value for the altitude field.
 * categories: Sets the initial value for the categories field, multiple categories separated by |.
 * fields[]: The initial values of additional fields defined by a campaign. Values of multiple fields must be passed in the exact same order as defined in the campaign.
 * (e. g. )


 * objref: Specifies an object reference that can be used to update a page with a thumbnail of an uploaded image. See #Object references for further details.
 * updateList: Specifies whether a list page should be updated at all. This parameter only works in combination with . See #Object references for further details.

These arguments can be specified as follows: if you have an argument named "campaign" and want to provide the value "foobar", then append  to the url. For example  or.

The following URL arguments are still supported for existing URLs, but deprecated:
 * id: If specified, this value is used instead of the first fields[] value. Please use fields[] instead.
 * id2: If specified, this value is used instead of the second fields[] value. Please use fields[] instead.

Object references
Upload Wizard provides a way to store “object references” - references to list templates in Wiki pages - in the file description page. These may be used by bots to insert a thumbnail image into a list page. A bot that is doing this for monument lists of German Wikipedia is running on tool labs. Its code is hosted on GitHub. Though its purpose is to update monument lists on Wikipedia it can be adopted to serve in different scenarios.

This feature uses the parameters  and. If both parameters are passed, the Upload Wizard shows a checkbox for each upload, which can be used to select the image that the object reference is added to. If the parameter  is omitted, the checkboxes will be disabled and an additional notice is being displayed stating that an image for the object already exists in the list.


 * objref: Specifies an object reference that can be used to update a page with a thumbnail of an uploaded image. Passing this parameter is expected in the following format
 * prefix - Interwiki or interlanguage prefix as defined per Special:Interwiki. The prefix must be defined in order to make this work.
 * page_title - The title of the page the object is listed on.
 * object_id - A unique identifier of the object for a bot to update
 * updateList: Specifies whether a list page should be updated at all. Set to any value, this parameter enables a checkbox

Testing
If you're testing UploadWizard for whatever reason, and you've run out of "real" images to upload as test cases, you can always use the handy MediaWiki utility for creating test images. Open a terminal emulator, get into a directory where you want to store a bunch of test JPG files, and run

Here's a Bash script that should make it easier to do all of this without much trouble. It's a good idea to put this in your PATH and/or make a handy shortcut to it somewhere that will make it trivial to update your images with new ones.

Templates
Upload Wizard will insert a few templates into generated file description pages, which need to exist on the wiki in order for the description pages to be rendered correctly. The templates used include:


 * the "Information" template (you could use mediawiki's export tool to import this template into your own installation of mediawiki)
 * Description language identifiers like the "En" template, if none are defined, then only is used.
 * the Location template for geocoordinates
 * Various licensing tags (which are configurable)
 * (Optionally) a template to indicate that a file is uncategorized

Development status
While we feel that this is ready for others to use, so far, this extension has mostly been used only on Wikimedia wikis. We'd like to get reports from other MediaWiki installations as well.

History
Extension:UploadWizard was originally designed by Guillaume Paumier as part of the Multimedia usability project and developed by Neil Kandalgaonkar, and has evolved since then.

Related specs

 * - entering gps coordinates / deriving them from EXIF
 * - entering gps coordinates / deriving them from EXIF