Template:Image label begin

Template documentation[view] [edit] [history] [purge]

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

Usage

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

{{Image label begin|image=Australia location map recolored.png
                   |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.
                   |width={{{width|}}}
                   |font-size=85%}}
{{Image label|scale={{{width|}}}|x=0.26 |y=0.345 |text=[[w:Western Australia|Western<br/>Australia]]}}
{{Image label|scale={{{width|}}}|x=0.46 |y=0.20  |text=[[w:Northern Territory|Northern<br/>Territory]]}}
{{Image label|scale={{{width|}}}|x=0.505|y=0.4025|text=[[w:South Australia|South<br/>Australia]]}}
...
{{Image label end}}

Parameters

width/scale

A number of pixels. Default is 400. (Do not include "px" after the number.)

If |width= is given for {{image label begin}}, the same value must be given as |scale= for {{image label}}, 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, {{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

Four options:

• |float=none – makes the image sit on its own line of the page (default)
• |float=center – centers the image relative to the page
• |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, |font-size=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 {{image label}} to adjust the font size for that label.

font-stretch

Available only in {{image label}}. If given, alters text width for a label. The proper value could be normal, semi-condensed, condensed, extra-condensed, ultra-condensed, semi-expanded, expanded, extra-expanded or ultra-expanded, or alternatively a percentage number, for example: |font-stretch=75%.

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 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.

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}} (template redirect to {{Image label begin}})
• {{Image label|x=0.25|y=0.75|scale=400|text=[[Wikipedia]]}}
  • {{Image label small}} (deprecated, use |font-size=85% on {{Image label begin}} or {{Image label}} instead)
• {{Image label end}}

Tool

• Labelled Image Editor

Tracking categories

• Category:Pages using image label with a wide image (0)
• Category:Pages using image label with a tall image (0)

The above documentation is transcluded from Template:Image label begin/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.