WMDE Technical Wishes/Move files to Commons/Configuration file documentation
Jump to navigation
Jump to search
Contents
File checks and template matching with the FileImporter extension[edit]
In a nutshell[edit]
When you import a local file, the FileImporter checks its templates and then processes the file accordingly, e.g.
- the import is prevented if the file has a license that's not suitable for Wikimedia Commons,
- the import is prevented if the file is missing a template that clearly allows an import to Wikimedia Commons,
- a template is replaced if an equivalent template exists on Wikimedia Commons.
All checks and their resulting actions are described in the table below.
The checks are based on configuration files. These files originate from the configuration files of the Commons2Helper tool.
- Many wikis already have a configuration file.
- Overview of all configuration files: https://www.mediawiki.org/wiki/Extension:FileImporter/Data
Please note[edit]
- Each wiki must have a configuration file. Imports from wikis without a configuration file will be blocked.
- The configuration files are maintained by the individual wiki communities. If you want to use the FileExporter on your wiki, please check if your wiki's configuration file is set up correctly. The table below explains the function and structure of a configuration file.
In detail: How do the configuration files work?[edit]
Any changes that are made to these files come into effect immediately. E.g. if you add a template to the section “Templates:Transfer”, the next export will immediately include a check for this template.
| What | Where it's defined in the config file |
How it works | Is it supported? | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| check license to allow or block imports | Categories: Bad | The FileImporter checks if the file contains any of the categories listed under “Bad”.
|
||||||||||||
| Templates: Good | The FileImporter checks if the file contains any of the templates listed under “Good”.
|
|||||||||||||
| Templates: Bad | The FileImporter checks if the file contains any of the templates listed under “Bad”.
|
|||||||||||||
| remove templates | Templates: Remove | The FileImporter checks if the file contains any of the templates listed under “Remove”, e.g. {{Move to Commons}}.
|
||||||||||||
| replace templates and parameters | Templates: Transfer | The FileImporter replaces the file’s local templates and parameters with the corresponding Commons templates and parameters from the list.
How to write the transfer rules in the config file:
|
(apart from language templates: T198607) | |||||||||||
| replace section headings | Information: Description | Replaces the heading of the description section according to the configuration file, e. g from Beschreibung in German Wikipedia to {{int:filedesc}} on Commons. If the heading of the local file isn’t in the configuration file, no replacements will be made.
|
||||||||||||
| Information: Licensing | Replaces the heading of the licensing section according to the configuration file, e. g from اجازهنامه in Farsi Wikipedia to {{int:license-header}} on Commons. If the heading of the local file isn’t in the configuration file, no replacements will be made.
|