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-css=85% | font-weight=bold | font-family=Times New Roman | background-color=#ffcccee | color=blue |line-height=1}}</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; use ''font-size-css'' to comply with [[MOS:SMALL]] for accessibility.
*''font-size-css'' is compatible with sizes in % or other [[Cascading Style Sheets | CSS]] relative sizes. Example: {{para|font-size-css|85%}}. Keep in mind that {{tq|In no case should the resulting font size of any text drop below 85% of the page's default font size.}} (from [[MOS:SMALL]])
*''font-weight'' can be normal, '''bold''', <span style="font-weight:lighter">lighter</span> or <span style="font-weight:bolder">bolder</span>.
*''font-stretch'' can be able to alter text width via normal, <span style="font-stretch:semi-condensed">semi-condensed</span>, <span style="font-stretch:condensed">condensed</span>, <span style="font-stretch:extra-condensed">extra-condensed</span>, <span style="font-stretch:ultra-condensed">ultra-condensed</span>, <span style="font-stretch:semi-expanded">semi-expanded</span>, <span style="font-stretch:expanded">expanded</span>, <span style="font-stretch:extra-expanded">extra-expanded</span> or <span style="font-stretch:ultra-expanded">ultra-expanded</span> values, or alternatively a percentage number.
*''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.

*''line-height'' set the line height, e.g. 80% or 0.8, and is only noticeable when the annotation spans multiple lines.
===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
|}

==TemplateData==
{{templateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Left (in pixels)",
			"description": "Position of the annotation (in pixels) relative to the left of the box that contains the image.",
			"type": "number",
			"required": true
		},
		"2": {
			"label": "Top (in pixels)",
			"description": "Position of the annotation (in pixels) relative to the top of the box that contains the image.",
			"type": "number",
			"required": true
		},
		"3": {
			"label": "Text",
			"description": "Text that will be displayed.",
			"type": "content",
			"required": true
		},
		"font-family": {
			"label": "Font family",
			"description": "The CSS name for the font.",
			"example": "Times New Roman",
			"type": "string"
		},
		"font-size": {
			"label": "Font size (pixels)",
			"description": "Font size in pixel units. CSS relative sizes are not supported; use \"Font size (percentage)\" to comply with MOS:SMALL for accessibility.",
			"type": "number"
		},
		"font-size-css": {
			"label": "Font size (percentage)",
			"description": "Compatible with sizes in % or other CSS relative sizes. Keep in mind that \"In no case should the resulting font size of any text drop below 85% of the page's default font size.\" (from MOS:SMALL)",
			"example": "85%",
			"type": "string"
		},
		"font-weight": {
			"label": "Font weight",
			"type": "string",
			"suggestedvalues": [
				"normal",
				"bold",
				"lighter",
				"bolder"
			]
		},
		"font-stretch": {
			"label": "Font width",
			"description": "Alter text width with one of the pre-selected parameters, or alternatively a percentage number.",
			"suggestedvalues": [
				"normal",
				"semi-condensed",
				"condensed",
				"extra-condensed",
				"ultra-condensed",
				"semi-expanded",
				"expanded",
				"extra-expanded",
				"ultra-expanded"
			],
			"type": "string"
		},
		"line-height": {
			"label": "Line height",
			"description": "Set the line height. Only noticeable when the annotation spans multiple lines. ",
			"example": "80%",
			"type": "string"
		},
		"text-align": {
			"label": "Text alignment",
			"description": "This can be set to left, center or right, and is only noticeable when the annotation spans multiple lines. ",
			"type": "string",
			"suggestedvalues": [
				"left",
				"center",
				"right"
			]
		},
		"background-color": {
			"label": "Background color",
			"description": "Defaults to transparent if not specified.",
			"type": "string"
		},
		"color": {
			"label": "Color",
			"description": "Color of the text and defaults to black if not specified, which is the default text color in most Wikipedia style sheets. In particular, it's best to use blue only for links. ",
			"type": "string"
		}
	},
	"description": "Creates an annotation for annotated images. This template will malfunction unless used within the templates {{Annotated image}} or {{Annotated image 4}}.",
	"paramOrder": [
		"1",
		"2",
		"3",
		"text-align",
		"font-size",
		"font-size-css",
		"font-weight",
		"font-stretch",
		"font-family",
		"background-color",
		"color",
		"line-height"
	],
	"format": "inline"
}
</templatedata>

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