Skip to content

Latest commit

 

History

History
106 lines (78 loc) · 3.91 KB

README.md

File metadata and controls

106 lines (78 loc) · 3.91 KB
Raw

SimpleBatchUpload

GitHub Workflow Status Latest Stable Version Packagist download count

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

It is maintained by Professional.Wiki. Contact us for commercial support or development work.

Requirements

  • PHP 8.0 or later
  • MediaWiki 1.35 or later

Installation

You need use Composer to install this extension. 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": "^2.0"
	}
}

Then add the following line to your "LocalSettings.php" file:

wfLoadExtension( 'SimpleBatchUpload' );

Note: To use the extension the user needs the writeapi right. This 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

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 - Array defining the maximum number of files that can be uploaded each time depending on the user group.
    Default:
$wgSimpleBatchUploadMaxFilesPerBatch = [
	'*' => 1000,
];

Note: Be aware that this is not the right setting to completely block file uploads! Users can still use the normal file upload or the MediaWiki API. See the paragraph on user permissions on Configuring file uploads on mediawiki.org.

License

GNU General Public License 2.0 or later