Template:Add file caption

Template documentation
Category:Template gadgets

This template inserts a tool for adding structured file captions to files in Wikimedia Commons.

This tool only edits Wikimedia Commons, but can be used from any wiki. See the installation instructions to get it working in your wiki.

Usage

{{Add file caption|History of Uruguay}}
Loading...
Category:Gadget:AddFileCaption

Installation

To install this template in your wiki:

  1. Create a template with the following markup. You can choose the template name, parameter names and defaults to suit your wiki.
    <includeonly><div class="AddFileCaption" data-category="{{{category|{{{1|}}}}}}" data-group="{{{group|}}}">Loading...</div>[[Category:Gadget:AddFileCaption]]</includeonly>
    
  2. Create MediaWiki:Gadget-AddFileCaption.js with the following code:
    /**
     * AddFileCaption is a tool for adding stuctured file captions to files in Wikimedia Commons
     * Documentation: https://www.mediawiki.org/wiki/AddFileCaption
     * Source code: https://www.mediawiki.org/wiki/MediaWiki:Gadget-Global-AddFileCaption.js
     */
    mw.loader.load( '//www.mediawiki.org/w/load.php?modules=ext.gadget.Global-AddFileCaption' );
    
  3. Add the following gadget to MediaWiki:Gadgets-definition:
    * AddFileCaption[ResourceLoader|hidden|default|categories=Gadget:AddFileCaption]|AddFileCaption.js
    

Done! Add your template to any page to verify that the installation was successful.

Localization

To help localize the messages of the interface, edit Data:AddFileCaption.tab.

Template data

This template inserts a tool for adding structured file captions to files in Wikimedia Commons.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Categorycategory 1

Category page (with no prefix) on Wikimedia Commons where to get the files

Example
History of Uruguay
Page namerequired
Groupgroup

User group to which to limit the use of the tool

Example
autoconfirmed
Stringoptional

See also

Category:Gadget:AddFileCaption Category:Global gadgets Category:Pages using the JsonConfig extension Category:Template gadgets