Skip to content

Latest commit

 

History

History
101 lines (74 loc) · 3.98 KB

README.md

File metadata and controls

101 lines (74 loc) · 3.98 KB
Raw

SimpleBatchUpload

Latest Stable Version Packagist download count Scrutinizer Code Quality Dependency Status

The SimpleBatchUpload extension provides basic, no-frills uploading of multiple files to MediaWiki.

Requirements

  • PHP 5.4 or later
  • MediaWiki 1.26 or later

Installation

The recommended way to install this extension is by using Composer. Just add the following to the MediaWiki composer.local.json file and run php composer.phar update mediawiki/simple-batch-upload from the MediaWiki installation directory.

{
	"require": {
		"mediawiki/simple-batch-upload": "~1.0"
	}
}

(Alternatively you can download a tar ball or zip file from GitHub and extract it into the extensions directory of your MediaWiki installation.)

Then add the following line to your LocalSettings.php:

wfLoadExtension('SimpleBatchUpload');

Note: To use the extension $wgEnableWriteAPI needs to be enabled and the user needs the writeapi right. Both is the default MediaWiki setting for registered users, but it may have been changed during the configuration of the wiki.

Usage

There are four ways to upload files using this extension:

  • Go to Special:BatchUpload to get a plain upload page
  • Go to Special:BatchUpload/Foo to get an upload page that sets {{Foo}} as the wikitext of the uploaded file's page
  • Add {{#batchupload:}} to any wikipage to get a simple upload button
  • Add {{#batchupload:Foo|Bar|Baz}} to any wikipage to get an upload button that sets {{Foo|Bar|Baz}} as the wikitext of the uploaded file's page

Note: The wikitext will only be set for newly uploaded files. If the file exists already, subsequent uploads of new versions of the file will not change the wikitext.

Customization

It is possible to specify dedicated parameter sets for the upload of specific file types by editing the MediaWiki:Simplebatchupload-parameters page. Each line of that page is considered as one set of parameters.

Available parameters are:

  • Name of template to be stored as text on initial upload
  • Upload comment
  • Title line of the Special:BatchUpload page

Parameters should be separated by pipes (|).

The line to be used is selected by appending the name of the template as the subpage to the URL of the Special:BatchUpload page.

Example:

Consider the parameter line

Pics | These pics were uploaded using [[mw:Extension:SimpleBatchUpload{{!}}SimpleBatchUpload]] | Upload some pics!
  • This can be selected by going to Special:BatchUpload/Pics.
  • The title of this page will be Upload some pics!.
  • The comment for the upload will be These pics were uploaded using [[mw:Extension:SimpleBatchUpload{{!}}SimpleBatchUpload]].
  • If a file with that name is uploaded for the first time it will have {{Pics}} as wikitext.

Configuration

Available configuration options:

  • $wgSimpleBatchUploadMaxFilesPerBatch - defines maximum number of files that could be uploaded at time.

License

GNU General Public License 2.0 or later.