Jump to content

Extension:MediaUploader

From mediawiki.org
MediaWiki extensions manual
MediaUploader
Release status: beta
Implementation Media, Special page
Description Flexible, multi-file, step-by-step uploader
Author(s) Ostrzyciel, authors of UploadWizard
Latest version 0.1.0
Compatibility policy Master maintains backward compatibility.
MediaWiki 1.37+
PHP 7.3
Database changes Yes
Tables mu_campaign
License GNU General Public License 2.0 or later
Download
README
Campaign
  • $wgMediaUploaderConfig
  • $wgUploadWizardConfig
upwizcampaigns, mass-upload
Quarterly downloads 18 (Ranked 111st)
Translate the MediaUploader extension if it is available at translatewiki.net
Issues Open tasks ¡ Report a bug

MediaUploader is an easy to use and flexible file upload tool. It is designed to be configurable and meet the demands of a wide variety of wikis.

Installation

[edit]

Note Note: If you are migrating from UploadWizard, see the dedicated guide.

  • 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 Manual:Image administration, particularly image thumbnailing.
  • Download and move the extracted MediaUploader folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MediaUploader
  • Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See task T173141 for potential complications.)
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'MediaUploader' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Configure as needed.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Features

[edit]

TBD

Configuration

[edit]

MediaUploader has extensive and very flexible configuration that can also be partially adjusted on-wiki with the use of campaigns. If you find the config overwhelming, there are also several ready-to-use configuration sets that you can just copy to your wiki and get started in no time.

Origin and design

[edit]

The idea of MediaUploader stemmed from the numerous issues with using UploadWizard on third-party wikis. The original tool was mostly designed for use by Wikimedia Commons, fulfilling its very specific needs (e.g. Wikibase support, specific licensing hacks, image-based tutorials). Third parties usually have a very different set of requirements that emphasize simplicity and flexibility. The two approaches are hard to reconcile in a single extension, especially given that UploadWizard must meet Commons' requirements and has no obligation to consider the needs of third parties. Thus, MediaUploader was born.

Main design goals of MediaUploader are:

  • Ease of use, at least as good as the original UploadWizard.
  • Configurability of all elements, well-described in documentation.
  • Ability to simplify certain elements of the wizard for wikis with less strict image description requirements.
  • Extensibility to allow for wiki-specific enhancements to be created locally.
  • No Wikimedia Commons-specific features.

See also

[edit]