Template:Overlay/doc
From Exiled Kingdoms Wiki
Skeleton
{{overlay | image = | title = | width = | height = | columns = | grid = | link = | legendbox = | float = | overlay = | border = | windrose = | legend1title = | legend1start = | legend1end = <!-- ...up to 6... --> | overlay1form = | overlay1 = | overlay1colour = | overlay1tip = | overlay1left = | overlay1top = | overlay1link = <!-- ...up to 30... --> }}
Template parameters
Parameter Name | Required | Description | Values |
---|---|---|---|
image | no | The image. If not set then only the legend is presented. | Image file name. |
title | no | Title displayed in the upper left corner of the image. | Text. |
width | no | Width of the image in pixels. Defaults to 500. | Number. |
height | no | Height of the image in pixels. Defaults to 500. | Number. |
columns | no | The number of columns to display the legend in. Defaults to 3. Set to 0 to not display any legend. | Number == 0, 1, 2, 3, . . . |
grid | no | Set to 'yes' to turn on the coordinate grid to allow easier determination of overlay coorindates while editing. Defaults to 'no'. All values other than 'yes' are equivalent to 'no'. | Text == yes. |
link | no | Set to 'yes' to turn on default linking of overlay and legend entry. Defaults to 'no'. All values other than 'yes' are equivalent to 'no'. | Text == yes. |
legendbox | no | Set to 'no' to turn off a box / border around each legend group set of overlays. Defaults to 'yes'. All other values other than 'no' are equivalent to 'yes'. | Text == no. |
float | no | Floats the image and legend. Defaults to centering the image and legend on the page. | Text == right, left. |
overlay | no | Determines whether or not the overlays are presented when an image is available. Defaults to 'yes'. All values other than 'no' are equivalent to 'yes'. | Text == no. |
border | no | Determines whether or not a border is placed around the whole presentation. Defaults to 'yes'. All values other than 'no' are equivalent to 'yes'. | Text == no. |
windrose | no | Set to 'yes' to display the EK windrose in the lower right corner of the image. Defaults to 'no'. All values other than 'yes' are equivalent to 'no'. | Text == yes. |
legend1title | no | Text for legend1 title. | Optionally linked text. |
legend1start | no | The number of the first overlay to appear in legend1. Defaults to the first overlay set, otherwise to the previous legend end plus 1 if there is a previous legend. | Number == 1, . ., 30. |
legend1end | no | The number of the last overlay to appear in legend1. Defaults to the next legend start less 1 if there is a next legend, otherwise to the last set overlay. | Number == 1, . ., 30. |
Both legend starts and legend ends do not need to be provided. Legend starts only, or, legend ends only, for each legend may be provided. | |||
overlay1form | no | The form of the overlays. The default form is an image number, for example, 1 |
Text == image, text, colour/color. |
overlay1 | no | Text for overlay1 for the legend. Defaults to overlay1tip if any. | Text. Do not link. The template will link. |
overlay1colour | no | Colour of overlay1. Defaults to the previous overlay colour, or to 'red' if no previous overlay colour. Predefined colours may be used (access, enemy, npc, secret, site) and can be altered in Module:Overlay/colors. | Text == red, green, blue. |
overlay1tip | no | Pop up tool tip text to appear when the screen pointer is over overlay1. Defaults to overlay1. | Text. |
overlay1left | no | Distance in pixels of the left edge of overlay1 from the left side of the image. | Number. |
overlay1top | no | Distance in pixels of the top edge of overlay1 from the top side of the image. | Number. |
overlay1link | no | Text to be used as a link for the overlay legend text. Defaults to overlay1 if link is not set to no. | Text. Do not link. |
overlay1left1 | no | The same as overlay1left. | As per overlay1left. |
overlay1top1 | no | The same as overlay1top. | As per overlay1top. |
overlay1left2 | no | The left ordinate for a second position of overlay1. | As per overlay1left. |
overlay1top2 | no | The top ordinate for a second position of overlay1. | As per overlay1top. |
overlay1left3 | no | The left ordinate for a third position of overlay1. | As per overlay1left. |
overlay1top3 | no | The top ordinate for a third position of overlay1. | As per overlay1top. |