Open main menu

Other languages:
Deutsch • ‎English • ‎français • ‎русский
File captions

File captions are a feature part of Structured data (the first part to be enabled). They are meant to store short, multilingual descriptions about files. See mw:Help:File captions for more information. They were enabled on Wikimedia Commons in January 2019.

Contents

What makes a good caption?Edit

Precise guidelines on file captions still have to be developed.

There are technical requirements (limited to 255 characters in length, and cannot contain markup) which necessarily make captions short.

FAQEdit

How is this different from descriptions?Edit

  • Captions are meant to be simple and short. While descriptions can be very expansive, captions are limited to 255 characters in length, and cannot contain markup (like Wikitext links or HTML) and do not support external links.
  • Captions are available as part of our structured data, while descriptions are not. In technical terms, a description is plain wikitext wrapped in a language template, wrapped again in an Information template ; while captions are Wikibase labels. As such, they will be searchable through the API, making it easy to find/filter/pull captions from files as metadata.

In many cases, the caption will be similar or identical to the description (or even the file title!). For example, File:Fire station Hallstatt - October 2017 - 02.jpg has the English caption "Hallstatt fire station in October 2017".

Conversely, on Pluto-01 Stern 03 Pluto Color TXT.jpg there is a very extensive description (858 characters, and links) and the caption is much shorter (more or less the same caption used on the Wikipedia articles using that image).

Can't I (or a bot) simply copy descriptions into captions?Edit

Firstly, caption are shorter than many descriptions; they cannot contain links, nor wiki-markup.

While it may be possible to copy short pieces of text from a description to a caption, this needs human interpretation.

Only text which is so short that it is not copyrightable should be copied into captions, as captions are published under a CC0 ("public domain") waiver.

What are the benefits of captions?Edit

One of the core benefit is improved language-aware searchability. Classical file descriptions are in the wikitext, and are only searchable through full-text search, which necessarily searches through the entire page contents, including categories and license templates ; and it is not possible to do search search per language. As they are searchable via the API, it is easier for 3rd party reusers to find and reuse media and the captions themselves.

Other possible usages can be:

  • filling in infoboxes
  • query files for missing captions in a given language
  • building lists for translation of important files needing a caption localized for a project or campaign

Where are captions stored?Edit

Captions are stored on Wikimedia Commons, as part of Wikibase (and thus not as part of the wikitext). They are not stored on Wikidata. While Wikibase is indeed powering Wikidata, it is also deployed here on Wikimedia Commons.

How can I search by caption?Edit

Users can search for files by their MediaInfo captions just as they would search for anything else. For example, if a user uploads a picture of the Eiffel Tower, and enters ‘Tour Eiffel’ (French) and ‘Eiffel Tower’ (English) as multilingual file captions, the picture is findable by another user searching for either ‘Eiffel Tower’ or ‘Tour Eiffel’.

Why are languages X Y and Z displayed for me?Edit

If you are a logged in user the languages displayed are the ones listed in Babel boxes on your userpage.

How can I change the appearance of captions?Edit

You may enable the following gadgets in your preferences (under “Interface: Files and categories”):

  • To collapse the caption block and add a link to expand it when needed: Collapse Captions (main script code, additional style code)
  • To make the captions block more compact: Compact Captions (code)
  • To hide the captions completely: Hide Captions (code)

Collapse Captions and Compact Captions can be combined if desired.

See in addition section Styling below.

TechnicalEdit

How can I query the captions using the API?Edit

API support is for now limited but will be improved soon.

You can retrieve captions using the wbgetentities module with the entity ID. For each file there is a Wikibase entity ID MXXXX, XXXX being the page_id. So for example, File:Pluto-01 Stern 03 Pluto Color TXT.jpg has the page ID 41837276, so the entity ID is M41837276, and you can query wbgetentities&ids=M41837276. An easy way to get the Mid is to use the API action=query&prop=info&titles=File:Pluto-01_Stern_03_Pluto_Color_TXT.jpg (the page ID is provided by the pageid field).

How can I query the captions using Lua/templatesEdit

This is not documented yet, but should be soon − stay tuned.

How can I set captions at upload time?Edit

 
Adding captions in the Upload Wizard.

You can already fill-in captions when uploading using the Upload Wizard. You can pre-fill a caption with url-parameters caption and captionlang when calling the Upload Wizard via link e.g. in the context of an upload campaign.

For others upload methods, support will be added in the future − you may follow the work on different bug trackers, for Pywikibot, for the Commons Android app or for Pattypan.

How can I edit the captions using the API?Edit

You could use the API wbsetlabel module with the Wikibase entity ID MXXXX (see the section about querying for more details).

StylingEdit

The captions form field can be styled with Cascading Style Sheets. Add the rules into your common.css file or a browser addon like Stylus Userstyles Manager or xStyle. In the latter case you should use the provided restriction to Commons domain commons.wikimedia.org.

Show caption in collapsed modeEdit

With the gadget Collapse Captions you will in collapsed mode by default only see an empty box apart from the Expand string. The following will make the caption visible in this state (i.e. Captions in your language):

 1 .mw-collapsible-content { display: initial !important; }
 2 .mw-slot-header,
 3 .wbmi-entityview-captionsPanel.mw-collapsed .mw-collapsible-content *:not(.wbmi-entityview-captions-header)
 4 	{ display: none; }
 5 .wbmi-entityview-captionsPanel.mw-collapsed .wbmi-entityview-captions-header	{
 6 	display: block;
 7 	border-bottom: none;
 8 	margin-bottom: 0;
 9 	padding-top: 0;
10 	font-style: italic;
11 	font-weight: normal;
12 }
13 .ltr .mw-collapsible-content .wbmi-entityview-captions-header { text-align: right; }
14 .rtl .mw-collapsible-content .wbmi-entityview-captions-header { text-align: left; }
15 .rtl .mw-collapsible-toggle { float: left; }

Notes:

  • Because of the method, how the line numbers are inserted here in the presentation, in the copy of the rules you will see every second line being empty. You can safely delete these empty lines, if you want. There is actually some indentation with a tab character, too, which is also not shown here.
    This is valid for the following rules with line numbers below, as well.
  • Line 1: In tests the part !important was necessary. This will provoke a warning here in Commons in the code editor of common.css. Maybe it could be even left out when this file is used (tested only with browser addon).
  • Line 2: This will remove the header (Structured data in your language). If you want to have it displayed instead, delete this line including the comma.
  • Lines 10–12 are for formatting of the visible caption. If you want to have the default upright, bold string, delete these lines.
  • Lines 13–14: You probably need in most cases only either of these two rules, though it doesn’t matter if you copy them both. To decide which one you usually will need look at their beginning:
    • .ltr: left-to-right writing systems like Latin script (e.g. English).
    • .rtl: right-to-left writing systems like Arabian script.
If you want to have the default string at beginning (left for ltr, right for rtl systems), delete these lines.
  • Line 15 is only needed for rtl systems. It sends the toggle for collapsing and decollapsing to the left of the page. This rule will be active also for every toggle on all other Commons pages.

Further styling just for appearance, add this below the rules from above:

1 .wbmi-entityview-captionsPanel.mw-collapsed .wbmi-entityview-captions-header::after { content: " …"; }
2 .wbmi-entityview-captionsPanel:not(.mw-collapsed) .wbmi-entityview-captions-header {
3 	border-bottom: none;
4 	text-decoration: underline;
5 }

Notes:

  • Line 1: If the ellipsis inside of content: " …"; is not in the usual style of your language then replace it according to your taste, but do not omit the quote signs! If the added content is on the wrong side in your writing system then replace after with before.
  • Lines 2–5 are for the caption in uncollapsed mode. If you don’t want it to be underlined then delete line 4.

More compact collapsed modeEdit

… but not that compact like with the gadget Compact Captions

 1 .mw-slot-header { display: none; }
 2 .wbmi-entityview-captionsPanel:not(.mw-collapsed) .wbmi-entityview-captions-header
 3 	{ border-bottom: none; }
 4 .wbmi-entityview-captionsPanel {
 5 	border: none;
 6 	margin-top: -1.5em;
 7 }
 8 .wbmi-entityview-captionsPanel .wbmi-entityview-captions-header {
 9 	margin-bottom: 0;
10 	padding-top: 0;
11 }
12 .wbmi-entityview-captionsPanel .wbmi-entityview-entitycontent {
13 	padding: 0.3em 0;
14 }

Notes:

  • If the block interferes with the preceding text block, then delete line 6 or at least reduce the amount of the value. margin-top: -0.5em; seems to be usable.
  • Lines 1–3 can be left out if you use the unchanged rules from above, but it does not cause harm if you add them twice, as long as you remember this in future edits.

Further styling just for appearance:

1 .wbmi-entityview-captions-header .wbmi-entityview-editButton { font-size: smaller; }
2 .ltr .wbmi-entityview-editButton { margin-left: 0.25em !important; }
3 .rtl .wbmi-entityview-editButton { margin-right: 0.25em !important; }
4 .wbmi-entityview-editButton::before { content: "("; }
5 .wbmi-entityview-editButton::after { content: ")"; }

Notes:

  • Lines 2–3: Read notes above for .ltr and .rtl.
  • Lines 4–5: If you do not want to have parentheses around the edit string (Edit in your language) either delete both rules or replace them with your preferred characters inside of content: "…";, but do not omit the quote signs!

See alsoEdit