Extension:UploadWizard

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

Release status: stable

Implementation Media, Special page
Description Multi-file, step-by-step upload wizard
Author(s) Neil Kandalgaonkar (NeilKTalk)
Last version 1.1
MediaWiki 1.19+
License GPL
Download Download snapshot
Subversion [Help]

Browse source code
View code changes

README

Example Commons Prototype

Check usage (experimental)

UploadWizard is an extension that allows a user to upload multiple files with a step-by-step JavaScript wizard. It was designed by Guillaume Paumier as part of the Multimedia usability project and developed by Neil Kandalgaonkar.

See also usability:Multimedia:Upload wizard.

This extension shares some of the same features as Extension:AddMediaWizard, which is part of Extension:UsabilityInitiative. AddMediaWizard and UploadWizard are expected to eventually share most of their uploading media backend code.

Contents

[edit] Installation

screenshot of the extension

[edit] 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 the manual page on image administration, particularly image thumbnailing.

Quick start for Linux or Mac OS X users:

  • Make sure that the images directory is writable by your web server.
  • Install the ImageMagick libraries and binaries.
  • Add the following configuration to LocalSettings.php:
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = <path to your convert command>;  # often /usr/bin/convert

require_once( "$IP/extensions/UploadWizard/UploadWizard.php" );

[edit] Other configuration

  • You need to have InstantCommons enabled in order to access the licensing tutorial. To enable InstantCommons add
    $wgUseInstantCommons = true;
    
    to LocalSettings.php.
  • You may want to set
    $wgUploadNavigationUrl = '/wiki/Special:UploadWizard';
    
    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:
$wgExtensionFunctions[] = function() {
        $GLOBALS['wgUploadNavigationUrl'] = SpecialPage::getTitleFor( 'UploadWizard' )->getLocalURL();
        return true;
};

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

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

$wgUploadWizardConfig = array(
        'debug' => false,
        'autoCategory' => 'Uploaded with UploadWizard',
        'feedbackPage' => 'FeedbackTest2',
        'altUploadForm' => 'Special:Upload',
        'fallbackToAltUploadForm' => false,
        'enableFormData' => false,  # Should FileAPI uploads be used on supported browsers?
        'enableMultiFileSelect' => false
);

[edit] 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.

[edit] See also

[edit] Related specs

[edit] Related extensions


Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox