Template:Overlay

Description

This template generates an annoted map by overlaying numbered markers on an image and displaying a corresponding legend underneath. It requires the Lua module Module:Overlay.

Usage

{{Overlay
|Image = 
|Title = 
|Width = 
|Height = 
|Columns = 
|Grid = 
|Link = 
|Legendbox = 
|Float = 
|Overlay = 
|Border = 
|Windrose = 

<!-- Legend -->
|Legend1Title = 
|Legend1Start = 
|Legend1End = 
<!-- ...up to 6... -->

<!-- Overlays -->
|Overlay1Form = 
|Overlay1 = 
|Overlay1Color = 
|Overlay1Tip = 
|Overlay1Link = 
|Overlay1Left = 
|Overlay1Top = 
<!-- ...up to 30... -->
|Overlay1Left2 = 
|Overlay1Top2 = 
<!-- ...up to 12... -->
}}

Parameters

Name	Required	Description	Values
Image	No	The image. If not set then only the legend is presented.	image name (including file extension)
Title	No	Title displayed in the upper left corner of the image.	arbitrary text
Width	No	Width of the image in pixels.	positive number (defaults to 500)
Height	No	Height of the image in pixels.	positive number (defaults to 500)
Columns	No	The number of columns to display the legend in. Set to 0 to not display any legend.	non-negative number (defaults to 3)
Grid	No	Set to "yes" to turn on the coordinate grid to allow easier determination of overlay coordinates while editing.	"yes" / "no" (defaults to "no"; all values other than "yes" are equivalent to "no")
Link	No	Set to "yes" to turn on default linking of overlay and legend entry.	"yes" / "no" (defaults to "no"; all values other than "yes" are equivalent to "no")
Legendbox	No	Set to "no" to turn off the box/border around each section of the legend.	"yes" / "no" (defaults to "yes"; all values other than "no" are equivalent to "yes")
Float	No	Determines how image and legend or positioned on the page.	CCS float value ("none", "left", "right") or "center" (defaults to "center")
Overlay	No	Determines whether or not the overlays are presented when an image is available.	"yes" / "no" (defaults to "yes"; all values other than "no" are equivalent to "yes")
Border	No	Determines whether or not a border is placed around the whole presentation.	"yes" / "no" (defaults to "yes"; all values other than "no" are equivalent to "yes")
Windrose	No	Set to "yes" to display a windrose in the lower right corner of the image.	"yes" / "no" (defaults to "no"; all values other than "yes" are equivalent to "no")
Legend
Legend1Title	No	The title of Legend1.	arbitrary text
Legend1Start	No	The number of the first overlay to appear in Legend1.	positive number (defaults to the first overlay set, otherwise to the previous legend end plus 1 if there is a previous legend)
Legend1End	No	The number of the last overlay to appear in Legend1.	positive number (defaults to the next legend start less 1 if there is a next legend, otherwise to the last set overlay)
... repeat this pattern for up to 6 separate sections of the legend ...
Overlays
Overlay1Form	No	The form of the overlays, either as numbered icon (e.g. 1 ), colored text (e.g. 1 ), or bare color (e.g.    ).	"icon" / "text" / "color" (defaults to the previous overlay form, or to "icon" if there is no previous overlay form)
Overlay1	No	Text of Overlay1 to be displayed in the legend.	arbitrary text (defaults to the value of Overlay1Tip if any)
Overlay1Color	No	The color of Overlay1.	arbitrary color or one of the color tags defined in Module:Overlay/colors: access • enemy • npc • secret • site (defaults to the previous overlay color, or to "red" if there is no previous overlay color)
Overlay1Tip	No	Pop up tool tip text to appear when the screen pointer is over Overlay1.	arbitrary text (defaults to the value of Overlay1)
Overlay1Link	No	Text to be used as a link for the overlay legend text.	arbitrary text (defaults to the value of Overlay1 if Link is not set to "no")
Overlay1Left	No	Distance in pixels of the left edge of Overlay1 from the left side of the image.	non-negative number
Overlay1Top	No	Distance in pixels of the top edge of Overlay1 from the top side of the image.	non-negative number
Overlay1Left2	No	The left ordinate for a second position of Overlay1.	non-negative number
Overlay1Top2	No	The top ordinate for a second position of Overlay1.	non-negative number
... repeat this pattern for up to 30 different overlays, with up to 12 different positions per overlay ...

---

View/Edit documentation page