View source for Extension:SimpleBatchUpload

<languages />
{{Professional Wiki LTS notice|extension}}
{{Extension
|status          = stable
|type1           = special
|type2           = parser function 
|hook1           = ParserFirstCallInit
|hook2           = MakeGlobalVariablesScript
|hook3           = SetupAfterCache
|author          = Stephan Gambke
|username        = F.trott
|maintainer      = {{ProfessionalWiki}}
|version         = 2.0.1
|update          = 2023-12-07
|mediawiki       = 1.35+
|php             = 8.0+
|composer        = mediawiki/simple-batch-upload
|download        = {{GithubDownload|ProfessionalWiki|SimpleBatchUpload}}
[https://github.com/ProfessionalWiki/SimpleBatchUpload/releases/latest '''Latest stable''']
|readme          = <span style="white-space: nowrap;font-size:smaller;">[https://github.com/ProfessionalWiki/SimpleBatchUpload/blob/master/README.md README]</span>
|changelog       = <span style="white-space: nowrap;font-size:smaller;">[https://github.com/ProfessionalWiki/SimpleBatchUpload/blob/master/release-notes.md release-notes]</span>
|needs-updatephp = No
|description     = <translate><!--T:1--> Allows for basic, no-frills uploading of multiple files</translate>
|parameters      = <nowiki/>
* $wgSimpleBatchUploadMaxFilesPerBatch
|example         = 
|license         = GPL-2.0-or-later
|image           = SimpleBatchUpload.png
|translate       = mwgithub-simplebatchupload
|compatibility policy = ltsrel
}}
<translate>
<!--T:2-->
The <tvar name=1>'''SimpleBatchUpload'''</tvar> extension allows for basic, no-frills uploading of multiple files to MediaWiki at "<tvar name=2>Special:BatchUpload</tvar>", using the <tvar name=3>[https://github.com/blueimp/jQuery-File-Upload jQuery File Upload]</tvar> JavaScript library.

== Download == <!--T:4-->

<!--T:10-->
The recommended way to download this extension is by using <tvar name=1>{{ll|Composer}}</tvar>.

<!--T:11-->
Add the following to the MediaWiki <tvar name=1><code>composer.local.json</code></tvar> file and run <tvar name=2><code>php composer.phar update mediawiki/simple-batch-upload</code></tvar> from the MediaWiki installation directory.
</translate>

<syntaxhighlight lang="json">
{
	"require": {
		"mediawiki/simple-batch-upload": "^2.0"
	}
}
</syntaxhighlight>

<translate>
<!--T:12-->
To update the extension, just run <tvar name=1><code>php composer.phar update mediawiki/simple-batch-upload</code></tvar> again.

<!--T:13-->
Alternatively, you can download a tar ball or zip file from [<tvar name=url>https://github.com/ProfessionalWiki/SimpleBatchUpload/releases/latest</tvar> GitHub], and extract it into the <tvar name=1><code>extensions</code></tvar> directory of your MediaWiki installation.

== Installation == <!--T:5-->

<!--T:14-->
Add the following line to your "<tvar name=1>LocalSettings.php</tvar>" file:
</translate>

<syntaxhighlight lang="php">
wfLoadExtension( 'SimpleBatchUpload' );
</syntaxhighlight>

<translate><!--T:15--> To make sure that <tvar name=1>SimpleBatchUpload</tvar> has been installed correctly, check that an entry for it exists at <tvar name=2><code>Special:Version</code></tvar> and that <tvar name=3><code>Special:BatchUpload</code></tvar> is working.</translate>

{{note|1=<translate><!--T:16--> To use the extension the user needs the <tvar name=1>{{ll|Manual:User rights#List of permissions|writeapi}}</tvar> right.</translate> <translate><!--T:17--> This is the default MediaWiki setting for registered users, but it may have been changed during the configuration of the wiki.</translate>}}

<translate>
== Usage == <!--T:6-->

<!--T:18-->
There are four ways to upload files using this extension:
</translate>

* <translate><!--T:19--> Go to <tvar name=1><code>Special:BatchUpload</code></tvar> to get a plain upload page</translate>
* <translate><!--T:20--> Go to <tvar name=1><code>Special:BatchUpload/Foo</code></tvar> to get an upload page that sets <tvar name=2><code><nowiki>{{Foo}}</nowiki></code></tvar> as the wikitext of the uploaded file's page</translate>
* <translate><!--T:21--> Add <tvar name=1><code><nowiki>{{#batchupload:}}</nowiki></code></tvar> to any wikipage to get a simple upload button</translate>
* <translate><!--T:22--> Add <tvar name=1><code><nowiki>{{#batchupload:Foo|Bar|Baz}}</nowiki></code></tvar> to any wikipage to get an upload button that sets <tvar name=2><code><nowiki>{{Foo|Bar|Baz}}</nowiki></code></tvar> as the wikitext of the uploaded file's page</translate>

{{note|1=<translate><!--T:23--> The wikitext will only be set for newly uploaded files.</translate> <translate><!--T:24--> If the file exists already, subsequent uploads of new versions of the file will not change the wikitext.</translate>}}

<translate>
== Customization == <!--T:7-->
</translate>
<translate><!--T:25--> It is possible to specify dedicated upload pages for specific file types by editing the <tvar name=1><code>MediaWiki:Simplebatchupload-parameters</code></tvar> page.</translate>
<translate><!--T:26--> Each line of that page is considered as one set of parameters.</translate>

<translate><!--T:27--> Available parameters are:</translate>

* <translate><!--T:28--> Name of template to be stored as text on initial upload</translate>
* <translate><!--T:29--> Upload comment</translate>
* <translate><!--T:30--> Title line of the <tvar name=1><code>Special:BatchUpload/subpage</code></tvar> page.</translate>

<translate>
<!--T:31-->
Parameters should be separated by pipes (<tvar name=1><code>|</code></tvar>).

<!--T:32-->
The line to be used is selected by appending the name of the template as the subpage to the URL of the <tvar name=1><code>Special:BatchUpload page</code></tvar>.
</translate>

{{note|1=<translate><!--T:37--> Spaces in the name of your template will cause this process to fail.</translate>}}

'''<translate><!--T:33--> Example:</translate>'''

<translate><!--T:34--> Consider the parameter line</translate>

<pre>
 Pics | These pics were uploaded using [[Extension:SimpleBatchUpload{{!}}SimpleBatchUpload]] | Upload some pics!
</pre>

* <translate><!--T:35--> This can be selected by going to <tvar name=1><code>Special:BatchUpload/Pics</code></tvar>.</translate>
* <translate><!--T:38--> The title of this page will be "Upload some pics!".</translate>
* <translate><!--T:39--> The comment for the upload will be "<tvar name=1>These pics were uploaded using [[Extension:SimpleBatchUpload{{!}}SimpleBatchUpload]]</tvar>".</translate>
* <translate><!--T:36--> If a file with that name is uploaded for the first time it will have <tvar name=1><code><nowiki>{{Pics}}</nowiki></code></tvar> as wikitext.</translate>

<translate>

== Configuration == <!--T:8-->
</translate>
; <code>$wgSimpleBatchUploadMaxFilesPerBatch</code>
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:
<syntaxhighlight lang="php">
$wgSimpleBatchUploadMaxFilesPerBatch = [
	'*' => 1000,
];
</syntaxhighlight>

'''Note:''' Be aware that this is neither the right setting to block file uploads, nor to throttle them!

Users can still use the normal file upload or the MediaWiki API.

For selectively blocking uploads see the [[Manual:Configuring_file_uploads|manual on configuring file uploads]]. For throttling uploads see the {{ll|Manual:$wgRateLimits|$wgRateLimits}} configuration parameter.

<translate>
==See also== <!--T:9-->
</translate>
* {{ll|Extension:UploadWizard}}
* {{ll|Extension:MsUpload}}
* [[Extension:VisualData/File_upload|VisualData/File upload]]

{{Clear}}
{{Used by}}

[[Category:Bulk upload{{#translation:}}]]