This page is protected against editing.

Template:ImageNote

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:ImageNote/doc.

Used by Help:Gadget-ImageAnnotator to store embedded notes for an image.

The template automatically sets the following categories:

Usage

{{ImageNote |id= |x= |y= |w= |h= |dimx= |dimy= |style= }}

This should not be used manually, but should be added by Help:Gadget-ImageAnnotator. The note consists of all the text between this image node and the closing {{ImageNoteEnd}} with the same id.

Template parameters

ParameterDescriptionDefaultStatus
id
1
IDAn identifier to unique identify this ImageNote on a particular pageemptyrequired
x
2
X coordinateThe X coordinate of the annotationemptyrequired
y
3
Y coordinateThe Y coordinate of the annotationemptyrequired
w
4
annotation widthThe width of the annotationemptyrequired
h
5
annotation heightThe height of the annotationemptyrequired
dimx
6
image widthThe width of the entire imageemptyrequired
dimy
7
image heightThe height of the entire imageemptyrequired
stylestyleI don't know what this does, but it seems to be requiredemptyrequired
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

Used by ImageAnnotator gadget to store embedded notes for an image, should not be used manually.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
image widthdimx 6

The width of the entire image

Numberrequired
image heightdimy 7

The height of the entire image

Numberrequired
annotation heighth 5

The height of the annotation

Numberrequired
IDid 1

An identifier to unique identify this ImageNote on a particular page

Numberrequired
stylestyle

I don't know what this does, but it seems to be required

Linerequired
annotation widthw 4

The width of the annotation

Numberrequired
X coordinatex 2

The X coordinate of the annotation

Numberrequired
Y coordinatey 3

The Y coordinate of the annotation

Numberrequired

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

Placement: At the bottom of the page

Relies on:
{{Iffile}}

See also

Localization

This template is not intended to be localized.