View source for Template:Annotation/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

{{annotated image/Extinction|caption=The Permian–Triassic extinction event, labelled "P-Tr" here, is the most significant extinction event in this plot for marine [[genus|genera]].}}
Creates an annotation for [[Template:Annotated image|annotated images]], for example in the diagram on the right the labels for the various extinctions are generated by Template:Annotation:
*You specify the position within the image at which each annotations is to appear.
*Annotations may be [[Hyperlink|links]], including [[Wikilink#Wikilinks| wikilinks]].

== Usage ==
{{Warning|This template will malfunction unless used within the templates {{tlbare|Annotated image}} or {{tlbare|Annotated image 4}}.}}

<code><nowiki>{{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}}</nowiki></code><br />where:
*There are no keywords for the ''top'', ''left'' and ''text'' parameters, which are mandatory and must appear in the order given above. The other parameters are optional, must be identified by their keywords (e.g. font-size=...), and may appear in any order.
*''left'' and ''top'' specify the annotation's position relative to the top left corner of the box that contains the image. i.e. the box' top left corner is 0,0. The box will usually be larger than the actual image, to make room for the annotations.
*''text'' is the text that will be displayed.
*''text-align'' can be set to left, center or right, and is only noticeable when the annotation spans multiple lines.
*''font-size'' is in px ([[pixel]]) units – [[Cascading Style Sheets | CSS]] relative sizes are not supported.
*''font-weight'' is '''bold''' or normal.
*''font-family'' is the CSS name for the [[font]], e.g. <span style="font-family: Times New Roman">Times New Roman</span> or <span style="font-family: Verdana">Verdana</span>
*''background-color'' defaults to transparent.
*''color'' is the color of the text and defaults to <span style="color:black">black</span>, which is the default text color in most Wikipedia style sheets. In particular, it's best to use blue only for links.

===Extended parameter names for use in other templates===
Some of the parameters have alternative names that are used by containing templates to call Template:Annotation. The alternative names are provided in case the containing templates call other templates that use similar parameters.

These alternative names are provided so that the containing templates can provide default values for the corresponding parameters in Template:Annotation, and should not be used for any other purpose.  Values specified using the basic parameter names listed above will over-ride the alternative names that are used by containing templates.

Here are the alternative names and the basic Template:Annotation parameters for which they set defaults:
{| class="wikitable"
! Alternative name !! Basic name 
|-
| annot-text-align  || text-align
|-
| annot-font-size   || font-size
|-
| annot-font-weight || font-weight
|-
| annot-font-family || font-family
|-
| annot-background-color || background-color
|-
| annot-color       || color
|}

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