Extension:SimpleBatchUpload
SimpleBatchUpload Release status: stable |
|
---|---|
Implementation | Special page , Parser function |
Description | Allows for basic, no-frills uploading of multiple files |
Author(s) | Stephan Gambke (F.trotttalk) |
Maintainer(s) | Professional Wiki |
Latest version | 2.0.1 (2023-12-07) |
Compatibility policy | For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension. |
MediaWiki | 1.35+ |
PHP | 8.0+ |
Database changes | No |
Composer | mediawiki/simple-batch-upload |
License | GNU General Public License 2.0 or later |
Download | GitHub: Note: README release-notes |
|
|
Translate the SimpleBatchUpload extension | |
The SimpleBatchUpload extension allows for basic, no-frills uploading of multiple files to MediaWiki at "Special:BatchUpload", using the jQuery File Upload JavaScript library.
Download
The recommended way to download this extension is by using Composer .
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"
}
}
Just run php composer to update the extension.phar update mediawiki/simple-batch-upload
again.
Alternatively, you can download a tarball or zip file from GitHub and extract it into the extensions
directory of your MediaWiki installation.
Installation
Add the following line to your "LocalSettings.php" file:
wfLoadExtension( 'SimpleBatchUpload' );
To make sure that SimpleBatchUpload has been installed correctly, check that an entry for it exists at Special:Version
and that Special:BatchUpload
is working.
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 upload pages for 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 the template to be stored as text on initial upload
- Upload comment
- Title line of the
Special:BatchUpload/subpage
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 [[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 SimpleBatchUpload".
- If a file with that name is uploaded for the first time, it will have
{{Pics}}
as wikitext.
Configuration
$wgSimpleBatchUploadMaxFilesPerBatch
Array defining the maximum number of files that can be uploaded each time depending on the user group. When a user is trying to upload larger batches of files, an error message is displayed.
Default:
$wgSimpleBatchUploadMaxFilesPerBatch = [
'*' => 1000,
];
Users can still use the regular file upload or the MediaWiki API.
For selectively blocking uploads see Manual:Configuring file uploads . For throttling uploads see $wgRateLimits .
See also
This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |