Template:Image label begin/doc

This template is a self-reference and thus is part of the Wikipedia project rather than the encyclopaedic content.

This template will automatically categorise the current template into: Category:Labelled map templates.

; === How to use === Consider this example, adapted from Template:Australia Labelled Map: 

...

 === width/scale ===  

A number of pixels. Default is 400.

If width is given for, the same value must be given as scale for  , or the labels will become misaligned if the image is resized. When used in a template, the simplest way to ensure this is by passing through the same parameter, as in the example. For example, &#123;{Australia Labelled Map|width=500}} displays the labelled image as a larger one of 500 pixels in width instead of the default, 400.

For earthly geographic maps, conforming to these specifications can allow easier conversion to for any other purposes such as for the use of Location map+.

 === x/y ===  

X values are always between 0 and 1. For square images, Y values are also between 0 and 1. The maximum Y value is higher for tall images, lower for wide images. The X and Y values represent the fraction of the width where the label will be placed. The exact point is the top-left corner of the image label. x=0 |y=0   will place the top-left corner of the label at the top-left     of a square image x=0 |y=1   will place the top-left corner of the label at the bottom-left  of a square image x=1 |y=1   will place the top-left corner of the label at the bottom-right of a square image x=1 |y=0   will place the top-left corner of the label at the top-right    of a square image x=0.5|y=0.5 will place the top-left corner of the label at the centre      of a square image

 === image ===  

The title of the wiki page of the image without the "Image:" prefix.

 === text ===  

The text label to display as wiki markup.

 === float ===  

Three options: float=none makes the image sit on its own line of the page (default) float=left makes the image pushed to the left of the page float=right makes the image pushed to the right of the page

 === font-size ===  

Optional. If given, specifies a font size for the labels. For example, 85% displays labels in a smaller font size. If omitted, font size will inherit from surrounding content.

font-size can also be set on each individual to adjust the font size for that label.

 === text-align ===  

Optional. If given, affects the line-by-line alignment within labels with line breaks. If omitted, the default text alignment is centered.

 === link ===  

Specifies where the image should link to. If  (the default), the image links to its file page. If empty, the image does not link to anything; this is appropriate for purely decorative images.

 === alt ===  

Specifies text to be used in the image's "alt" attribute. If link is empty, this should be empty; if link is  or is not given, this should describe the image; if link points to some other page this should describe the action that will be taken if you click on the image. See Alternative text for images.

 === caption ===  

Specifies text to be used in the image's "title" attribute. In certain browsers, this text will appear in a tooltip when the mouse pointer is rolled over it.

 == Template set ==  
 * Image label start (template redirect to )
 * Image label small (deprecated, use 85% on or  instead)
 * Image label small (deprecated, use 85% on or  instead)
 * Image label small (deprecated, use 85% on or  instead)

 == Tool ==  
 * Labelled Image Editor

 == Sample labelled images ==  


 * Africa Labelled Map
 * Armenia Labelled Map
 * Asia Labelled Map
 * Australia Labelled Map
 * Australian Capitals Labelled Map
 * Australian domestic cricket Labelled Map
 * Bulgaria Provinces
 * Brazil Labelled Map
 * Brunei Labelled Map
 * Colombia Labelled Map
 * Dhaka City Labelled Map
 * Earth Labelled Map
 * England Labelled Map
 * Cornwall Labelled Map
 * England Ceremonial Counties Labelled Map
 * European Union Labelled Map (blue)
 * European Union Labelled Map (brown)
 * Eurozone labelled map
 * France Regions Labelled Map
 * Gaza Strip labelled map
 * Georgia Labelled Map
 * IBL
 * India States and Territories Labelled Map
 * Indonesia provinces labelled map
 * Iran football labelled map
 * Israel Labelled Map
 * Israel Geographical Map
 * Jericho TV series map
 * Lebanon Labelled Map
 * Malaysia Labelled Map
 * Johor Labelled Map
 * Pahang Labelled Map
 * Sabah Labelled Map
 * Sarawak Labelled Map
 * Terengganu Labelled Map
 * Nepal province labelled map
 * Peru Labelled Area Map
 * Poland Labelled Map Small
 * Provinces of Iran Labelled Map
 * Mazandaran labelled map
 * Hamedan Labelled Map
 * Chahar Mahal and Bakhtiari Labelled Map
 * Neighborhoods of Tehran metropolis Labelled Map
 * Persian Gulf Cup 2007-08 Labelled Map
 * Iran Ethnic Groups Labelled Map
 * Schengen Agreement Labelled Map
 * Shanghai Labelled Map
 * Singapore Planning Areas Labelled Map
 * Switzerland Cantons Labelled Map
 * Syria Labelled Map
 * Al-Hasakah Labelled Map
 * Aleppo Labelled Map
 * Raqqa Labelled Map
 * Al-Suwayda Labelled Map
 * Daraa Labelled Map
 * Deir ez-Zor Labelled Map
 * Hama Labelled Map
 * Homs Labelled Map
 * Idlib Labelled Map
 * Latakia Labelled Map
 * Quneitra Labelled Map
 * Rif Dimashq Labelled Map
 * Tartus Labelled Map
 * Turkey Labelled Map
 * Ukraine Labelled Map
 * Crimea Labelled Map
 * United States Labelled Map
 * West Bank Labelled Map
 * World Labelled Map