This page is protected against editing.

Template:InlineImageAnnotations

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]

This template can be used to restrict the display of image annotations in articles where the image appears. The template can be placed on a file description page to specify how notes on the file should be displayed when the image is used in articles. It does not activate display if notes are switched off for a given group of users or images in the site-wide configuration.

Usage

{{InlineImageAnnotations |inline= |thumb= }}

Template parameters

ParameterDescriptionDefaultStatus
inlinecontrol inline imagesOne of “show”, “hide”, and “icon”. “Show” means showing inline (not thumbnail) images’ notes in the articles, “hide” means hiding them completely, and “icon” means not showing the notes themselves, but only an icon suggesting the reader can find notes on the description page. If this parameter is set to “hide”, the other parameter has no effect, thumbnails’ notes are also hidden.showoptional
thumbcontrol thumbnail imagesOne of “show”, “hide”, and “icon” (see explanations at the other parameter). This parameter controls thumbnail images’ notes.showoptional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

This template can be used to restrict the display of image annotations in articles where the image appears. The template can be placed on a file description page to specify how notes on the file should be displayed when the image is used in articles. It does not activate display if notes are switched off for a given group of users or images in the site-wide configuration.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
control inline imagesinline

One of “show”, “hide”, and “icon”. “Show” means showing inline (not thumbnail) images’ notes in the articles, “hide” means hiding them completely, and “icon” means not showing the notes themselves, but only an icon suggesting the reader can find notes on the description page. If this parameter is set to “hide”, the other parameter has no effect, thumbnails’ notes are also hidden.

Default
show
Stringoptional
control thumbnail imagesthumb

One of “show”, “hide”, and “icon” (see explanations at the other parameter). This parameter controls thumbnail images’ notes.

Default
show
Stringoptional

Additional information

The template is intended to be used in the following namespaces: the File namespace

The template is intended to be used by the following user groups: all users

Localization

This template is not intended to be localized.

Examples

To allow display of notes only for inline images, but to show only an icon on thumbnails, use

{{InlineImageAnnotations|inline=show|thumb=icon}}

or just

{{InlineImageAnnotations|thumb=icon}}

To only show icons on all images, use

{{InlineImageAnnotations|inline=icon|thumb=icon}}

To not show notes on thumbnails at all, but to show them for inlined uses of the image, use

{{InlineImageAnnotations|thumb=hide}}