Template:Image key/doc

This is a documentation subpage for Template:Image key.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:List

This template uses TemplateStyles:

Template:Image key/styles.css

The image key template is intended to help create lists of keys in images. These keys will display in 2 columns. The syntax is trivial: just add the list using the same syntax as Template:Unbulleted list!

Use

Note: This template may be used only within the caption parameter of an image. It won't work in a caption parameter of an infobox.

{{image key
|list type=
|
|
|
...
}}

Prefer the redirect {{legend-col}} when this template is being used to support the use of {{legend}}.

Parameters

|list type=: Defines a list type for the template. Can be one of the values ordered, bulleted, unbulleted (synonym plainlist). An ordered list is numbered, bulleted are basic lists, and unbulleted display nothing (i.e., are "plain lists").
|<N>=: A list item. If there is an equal sign in the list item, add it as the numbered item e.g. |1=list item with equals sign.
|thumb size=: Optional.; |thumb size=wide Adds a 3rd column. Use only for "wide" images.; |thumb size=narrow Removes one column to display 1 column only. Use only for "narrow" images.

Most thumbnails these days use |upright=, so these are qualitative rather than quantitative directions for use of |wide= and |narrow=.

Examples

Unordered list

[[File:Map of global minimum wages per hour in USD.svg|thumb|upright=2.1|alt=World map, countries colored in different shades of blue by minimum wage|Minimum wages per hour in U.S. dollars (as of '''2014'''):
{{legend-col
|{{legend|#e0e0e0|No data}}
|{{legend|#cccccc|No minimum wage}}
|{{legend|#d0d1e6|$0.00–$1.00}}
|{{legend|#a6bddb|$1.01–$2.00}}
|{{legend|#74a9cf|$2.01–$3.00}}
|{{legend|#3690c0|$3.01–$5.00}}
|{{legend|#0570b0|$5.01–$7.50}}
|{{legend|#045a8d|$7.51–$10.00}}
|{{legend|#023858|$10.00+}}
}}]]

Ordered list

[[File:Insect anatomy diagram.svg|right|upright=1.35|thumb|alt=Diagram of an insect with callouts for morphology|Insect morphology<br />
'''A'''- Head '''B'''- Thorax '''C'''- Abdomen <br />
{{image key
|list type=ordered
|[[Antenna (biology)|antenna]]
|[[Ocellus|ocelli]] (lower)
|ocelli (upper)
|[[compound eye]]
|brain (cerebral [[Ganglion|ganglia]])
|[[prothorax]]
|dorsal blood vessel
|[[invertebrate trachea|tracheal]] tubes (trunk with [[Spiracle (arthropods)|spiracle]])
|[[mesothorax]]
|[[metathorax]]
|[[insect wing|forewing]]
|[[insect wing|hindwing]]
|mid-gut (stomach)
|dorsal tube (Heart)
|ovary
|[[hind-gut]] (intestine, rectum & anus)
|anus
|oviduct
|nerve chord (abdominal ganglia)
|[[Malpighian tubule system|Malpighian tubes]]
|tarsal pads
|claws
|[[Arthropod leg|tarsus]]
|[[Arthropod leg|tibia]]
|[[Arthropod leg|femur]]
|[[Arthropod leg|trochanter]]
|fore-gut (crop, gizzard)
|thoracic ganglion
|[[Arthropod leg|coxa]]
|salivary gland
|[[subesophageal ganglion]]
|[[insect mouthparts|mouthparts]]
}}]]

Ordered list, narrow

[[File:Insect anatomy diagram.svg|right|upright=1.35|thumb|alt=Diagram of an insect with callouts for morphology|Insect morphology<br />
'''A'''- Head '''B'''- Thorax '''C'''- Abdomen <br />
{{image key
|list type=ordered
|thumb size=narrow
|[[Antenna (biology)|antenna]]
|[[Ocellus|ocelli]] (lower)
|ocelli (upper)
|[[compound eye]]
|brain (cerebral [[Ganglion|ganglia]])
|[[prothorax]]
|dorsal blood vessel
|[[invertebrate trachea|tracheal]] tubes (trunk with [[Spiracle (arthropods)|spiracle]])
|[[mesothorax]]
|[[metathorax]]
|[[insect wing|forewing]]
|[[insect wing|hindwing]]
|mid-gut (stomach)
|dorsal tube (Heart)
|ovary
|[[hind-gut]] (intestine, rectum & anus)
|anus
|oviduct
|nerve chord (abdominal ganglia)
|[[Malpighian tubule system|Malpighian tubes]]
|tarsal pads
|claws
|[[Arthropod leg|tarsus]]
|[[Arthropod leg|tibia]]
|[[Arthropod leg|femur]]
|[[Arthropod leg|trochanter]]
|fore-gut (crop, gizzard)
|thoracic ganglion
|[[Arthropod leg|coxa]]
|salivary gland
|[[subesophageal ganglion]]
|[[insect mouthparts|mouthparts]]
}}]]

Unordered list, wide

[[File:Map of global minimum wages per hour in USD.svg|thumb|upright=2.1|alt=World map, countries colored in different shades of blue by minimum wage|Minimum wages per hour in U.S. dollars (as of '''2014'''):
{{legend-col
|thumb size=wide
|{{legend|#e0e0e0|No data}}
|{{legend|#cccccc|No minimum wage}}
|{{legend|#d0d1e6|$0.00–$1.00}}
|{{legend|#a6bddb|$1.01–$2.00}}
|{{legend|#74a9cf|$2.01–$3.00}}
|{{legend|#3690c0|$3.01–$5.00}}
|{{legend|#0570b0|$5.01–$7.50}}
|{{legend|#045a8d|$7.51–$10.00}}
|{{legend|#023858|$10.00+}}
}}]]

TemplateData

Helps create lists of keys in images, especially using columns

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
List type	`list type`	Optional kind of list to display. Can be "ordered", "bulleted", or the default, which is "unbulleted". Default unbulleted	String	optional
Thumb size	`thumb size`	Optional size of the containing thumbnail. "narrow" will output only 1 column. "wide" will output 3 columns. Default is 2 columns.	String	optional
List element	`1`	Element in the list. Can be infinite elements.	Content	required
List element	`2`	Element in the list. Can be infinite elements.	Content	optional
List element	`3`	Element in the list. Can be infinite elements.	Content	optional
List element	`4`	Element in the list. Can be infinite elements.	Content	optional
List element	`5`	Element in the list. Can be infinite elements.	Content	optional
List element	`6`	Element in the list. Can be infinite elements.	Content	optional
List element	`7`	Element in the list. Can be infinite elements.	Content	optional
List element	`8`	Element in the list. Can be infinite elements.	Content	optional
List element	`9`	Element in the list. Can be infinite elements.	Content	optional
List element	`10`	Element in the list. Can be infinite elements.	Content	optional