View source for Template:Annotated image/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->

This template allows the addition of explanatory notes to images in the form of actual text  (which can also contain links), which is usually more legible than text  built into the image –  especially if the image is reduced to thumbnail size.

Other uses include cropping an image to exclude unimportant parts and perhaps enlarge  important parts, and internationalisation, as the annotations can be changed without changing the image.

This template and {{tl|annotated image 4}} are the only two annotated image templates that utilize {{tl|annotation}} to superimpose [[wikitext]] onto images. 

===Syntax===
<pre style="overflow:auto;">
{{Annotated image
| image = 
| image-width = 
| image-left = 
| image-top = 
| width = 
| height = 
| float = 
| annotations = 
{{Annotation | left (in px)| top (in px) | text | text-align=left | font-size=12 | font-weight=bold | font-family=Times New Roman | background-color=#ffcccee | color=blue}}
| caption = 
}}
</pre>

===Parameters===
All parameters have names; there are no nameless "numbered" parameters.

Two of the parameters, ''image'' and ''imagemap'', are mutually exclusive: use one of them, not both.

In the following list, those parameters required by the template are shown in '''bold'''.

{| class="wikitable sortable" 
! Parameter&nbsp;
! Allowed&nbsp;values&nbsp;
! Default&nbsp;value&nbsp;
! Function and notes&nbsp;
|-
 | '''caption''' || [[Wikipedia:Cheatsheet|wikitext]] || 
 | Caption accompanying image.
|-
 | alt || text || empty
 | Alt text for people whose vision of the image is impaired (see [[WP:ALT]]).
|-
 | ''Either''&nbsp; {{mono|image}}<br/>''or''&nbsp; {{mono|imagemap}}
 | valid image filename{{sup|a}} ''or''<br/>valid X/HTML [[Image map|imagemap]] || 
 | Specify either {{mono|image}} or {{mono|imagemap}}, but not both.
|-
 | width || positive integer || –
 | Total width (in pixels) of the box containing the image and annotations. Must be at least as large as the image's displayed width (which can be set using ''image-width'').
|-
 | height || positive integer || –
 | Total height (in pixels) of the box containing the image and annotations. Must be at least as large as the image's displayed height. If the displayed width of the image is changed by specifying ''image-width'', the image's displayed height and any additional "margins" for annotations will need to be calculated.
|-
 | image-left || integer || ''(zero)''
 | X-coordinate of the image's top left corner (in pixels), relative to the top left corner of the box containing the image and annotations. Negative values crop the image.
|-
 | image-top || integer || ''(zero)''
 | Y-coordinate of the image's top left corner (in pixels), relative to the top left corner of the box containing the image and annotations. Negative values crop the image.
|-
 | '''image-width''' || positive integer || 
 | Width of the image (in pixels).
|-
 | '''annotations''' ||  || 
 | Annotations for the image. May be left empty (i.e. {{mono|<nowiki>|... |annotations= |...</nowiki>}}) to crop an image only.
|-
 | float || {{hlist|right|left|center|none}} || right
 | To specify whether or not the template floats to the right or left of adjacent content.
|-
 | outer-css || any valid [[Cascading Stylesheets|CSS]] || –
 | Additional CSS applied to the outermost box. Does not override any other parameters specified for the outer box (i.e. best used only as "a last resort").
|-
 | image-bg-color || any valid CSS color || white
 | Background of the box in which the image is displayed. For example, a dark background for a relatively dark image on which relatively lightly colored annotations are placed.
|-
 | image-css || any valid CSS || –
 | Additional CSS applied to the (inner box carrying the) image. Does not override any other parameters specified for this box (i.e. best used only as "a last resort").
|-
 | annot-text-align || {{hlist|left|right|center}} || left
 | Sets a default text-alignment for all the contained annotations. Can be overridden per annotation.
|-
 | annot-background-color || any valid CSS color || transparent
 | Sets a default background-color for all the contained annotations. Can be overridden per annotation.
|-
 | annot-font-family || any valid CSS [[Font family (HTML)|font-family]] || –
 | Sets a default font-family for all the contained annotations. Can be overridden per annotation.
|-
 | annot-font-size || positive integer || –
 | Sets a default font-size (in pixels) for all the contained annotations. Can be overridden per annotation.
|-
 | annot-font-weight || any valid CSS font-weight || –
 | Sets a default font-weight for all the contained annotations. Can be overridden per annotation.
|-
 | annot-font-style || any valid CSS font-style || –
 | Sets a default font-style (e.g. "italic") for all the contained annotations. Can be overridden per annotation.
|-
 | annot-line-height || any valid CSS line-height || –
 | Sets a default line-height (line spacing) for all the contained annotations. <!--Only useful for multi-line annotations.--> Can be overridden per annotation.
|-
 | annot-color || any valid CSS color || –
 | Sets a default color for all the contained annotations. Can be overridden per annotation.
|}<span style="font-size:95%;padding-left:0.7em;">{{sup|a}} [[Scalable Vector Graphics|SVG]] images allowed.</span>

===Internationalisation===
This template makes internationalisation easy; the text is already separate from the image, so it is easy to translate the text and, if necessary, move pieces of text, as the lengths of the same text in different languages can vary a lot. For example, [[:nl:Sjabloon:Zijbalk mariene extincties]], the Dutch version of [[Template:Annotated image/Extinction]], is widely used.

===Pitfall===
There is [//en.wikipedia.org/w/index.php?title=Talk:Fossils_of_the_Burgess_Shale/GA1&oldid=325208222#Other_minor_stuff_no_longer_under_consideration one pitfall], although it is mainly about using one browser in the correct way (Microsoft Internet Explorer, of course). Internet Explorer has two ways of scaling up text to ease readability:
* Text resizing, which appears in Internet Explorer's View menu, affects text but not images. This method can disrupt annotated images, as the text is scaled up but the image content and frame are not. Firefox and Opera do not use this mechanism.
* Zoom also scales the image as well as text annotations, and thus does not disrupt the relative sizes and locations of annotations in annotated images. Netscape and its Mozilla derivatives, Firefox and Opera have had zoom for years, and it is more useful, as it also scales text implemented as part of an image, ''e.g.'', as in the Wikipedia logo. The zoom control sequences (CTRL&nbsp;+ to increase, CTRL&nbsp;- to decrease) are the same in Firefox, Opera and Internet Explorer. In Firefox and Opera, there also menu items for zoom, which show the control sequences. In Internet Explorer 7 only text resizing appears in the menu; in order to learn zoom, users must look up some external source.

===Examples===
[[Template:Annotated image/Extinction]]

====Adding explanatory notes====
See [[Template:Annotated image/doc/Samples]].

====Cropping====
You have an image like [[:commons:File:Mona Lisa color restoration2.jpg]]. But you want to show only a part of the image, say a part of the nose and mouth:
[[File:Mona Lisa color restoration2.jpg|thumb|left|300px|This image has a factual width of 300 pixels (as stored in commons), but this is irrelevant by the use of the template.]]
[[File:Monalisa.svg|thumb|right|300px|All measures related to image-width, the virtual width you have given to the image (in the example: 2000px)]]
{{Clear}}
You can do it with following code:

<pre style="overflow:auto;">
{{Annotated image
| image = Mona Lisa color restoration2.jpg
| image-width = 2000  <!-- choose any width, as you like it. It doesn't matter the factual width of the image-->
| image-left = -850   <!-- crop the left part. Be aware of the "-" minus symbol  --> 
| image-top = -800    <!-- crop the upper part. Be aware of the "-" minus symbol  -->
| width =  250        <!-- crop the right part. That will be the width of the image in the article -->
| height =  250       <!-- crop the below part. That will be the height of the image in the article -->
| float = left
| annotations =       <!-- empty or not, this parameter must be included -->
| caption = Cropped Mona Lisa from a 2000 pixel image
}}
</pre>
{{clear}}
The result is a 250pixels x 250pixels area from the 2000 pixels width image (the factual width of the image doesn't matter). The upper 800 pixels and the 850 pixels at the left side of the 2000-image are "discarded" as well as the "rest" at the right side after the 250 pixels and at the bottom after the 250 pixels:
<div style="clear: all;"></div>
{{Annotated image
| image = Mona Lisa color restoration2.jpg
| image-width = 2000
| image-left = -850
| image-top = -800
| width =  250
| height =  250
| float = left
| annotations = 
| caption = Cropped Mona Lisa from a 2000 pixel image
}}
<div style="clear: all;"></div>

{{clear}}

===Subpages (templates based on this template)===
This list is automatically generated and updated.  Redirects are shown in ''italics''.
{{Special:Prefixindex/Template:Annotated image/}}

===See also===
* {{tl|Annotation}}, for creating annotations.
* {{tl|Annotated image 4}}, for annotating left/right/center-aligned images with a normal caption background color.
* {{tl|Image label}}, an alternative to this template.
* {{tl|Overlay}}, which labels an image, automatically constructs a column-balanced legend, with, if desired, sub-legends; allows separate control of labels' pop-up tips; assists in determining corordinates for labels' position; etc.
* {{tl|Location map+}}, for maps featuring "pin"-style location icons.
* {{tl|Superimpose}} to superimpose images.
* [https://www.mediawiki.org/wiki/Extension:ImageMap ImageMap (MediaWiki extension) - adding links to areas of an image]

<includeonly>{{Sandbox other|
| <!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Annotated image templates]]
}}</includeonly>