Template:Image label begin/doc

Template:Image label begin/doc (edit talk links history)

This template's documentation is transcluded from en:Template:Image label begin/doc [edit].

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

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

How to use

Consider this example, adapted from Template:Australia Labelled Map:

{{Image label begin|image=Australia location map recolored.png|width=400|float=none
  |alt=Australia map. Western Australia in the west third with capital Perth, Northern Territory in the north center with capital Darwin, Queensland in the northeast with capital Brisbane, South Australia in the south with capital Adelaide, New South Wales in the northern southeast with capital Sydney, and Victoria in the far southeast with capital Melbourne. Tasmania, with capital Hobart, is off the coast of Victoria, across the Bass Strait. The Indian Ocean is to the west and northwest, the South Pacific Ocean to the east, the Southern Ocean to the south, and the Tasman Sea to the southeast. The Great Australian Bight to the south and the Gulf of Carpentaria to the north are the major bays. The Timor and Arafura Seas are off the north coast, and the Great Barrier Reef guards the northeast coast from the Coral Sea.}}
{{Image label small|x=0.26|y=0.345|scale=400|text=[[Western Australia|Western<br/>Australia]]}}
{{Image label small|x=0.46|y=0.20|scale=400|text=[[Northern Territory|Northern<br/>Territory]]}}
{{Image label small|x=0.505|y=0.4025|scale=400|text=[[South Australia|South<br/>Australia]]}}
...
{{Image label end}}

Width/Scale

In this example, all widths must be set to the same number of 400 as the default width. They must all be the same number of 400 for the template to be functionally scalable. This means they can be displayed at a different size by supplying a width parameter to the template when in use. For example, {{Australia Labelled Map|width=500}} will display the labelled image as a larger one of 500 pixels in width instead of 400.

To change the default size, search and replace "{{{width|400}}}" with "{{{width|500}}}".

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 and Y values are always between 0 and 1. They represent the percentages of the width and height respectively 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 the image
x=0  |y=1   will place the top-left corner of the label at the bottom-left  of the image
x=1  |y=1   will place the top-left corner of the label at the bottom-right of the image
x=1  |y=0   will place the top-left corner of the label at the top-right    of the image
x=0.5|y=0.5 will place the top-left corner of the label at the centre       of the 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 by default
{{{float|left}}}  makes the image pushed to the left of the page  by default
{{{float|right}}} makes the image pushed to the right of the page by default

link

Specifies where the image should link to. If File: (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 File: 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 Wikipedia: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 begin|image=Example.png|width=400|float=right}}
  • {{Image label start}}
• {{Image label|x=0.25|y=0.75|scale=400|text=[[Wikipedia]]}}
• {{Image label small|x=0.25|y=0.75|scale=400|text=[[Wikipedia]]}}
• {{Image label end}}

Tool

• Labelled Image Editor