MikeB: Created page with "== Description == This template generates an annoted map by overlaying numbered markers on an image and displaying a corresponding legend underneath. It requires the Lua modul..."

2020-04-26T11:20:31Z

Created page with "== Description == This template generates an annoted map by overlaying numbered markers on an image and displaying a corresponding legend underneath. It requires the Lua modul..."

New page

== 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 ==
<pre>
{{Overlay
|Image =
|Title =
|Width =
|Height =
|Columns =
|Grid =
|Link =
|Legendbox =
|Float =
|Overlay =
|Border =
|Windrose =


|Legend1Title =
|Legend1Start =
|Legend1End =



|Overlay1Form =
|Overlay1 =
|Overlay1Color =
|Overlay1Tip =
|Overlay1Link =
|Overlay1Left =
|Overlay1Top =

|Overlay1Left2 =
|Overlay1Top2 =

}}
</pre>

== Parameters ==
<table class="wikitable">
<tr><th>Name</th><th>Required</th><th>Description</th><th>Values</th></tr>
<tr><td>Image</td><td>No</td><td>The image. If not set then only the legend is presented.</td><td>image name (including file extension)</td></tr>
<tr><td>Title</td><td>No</td><td>Title displayed in the upper left corner of the image.</td><td>arbitrary text</td></tr>
<tr><td>Width</td><td>No</td><td>Width of the image in pixels.</td><td>positive number (defaults to 500)</td></tr>
<tr><td>Height</td><td>No</td><td>Height of the image in pixels.</td><td>positive number (defaults to 500)</td></tr>
<tr><td>Columns</td><td>No</td><td>The number of columns to display the legend in. Set to 0 to not display any legend.</td><td>non-negative number (defaults to 3)</td></tr>
<tr><td>Grid</td><td>No</td><td>Set to "yes" to turn on the coordinate grid to allow easier determination of overlay coordinates while editing.</td><td>"yes" / "no" (defaults to "no"; all values other than "yes" are equivalent to "no")</td></tr>
<tr><td>Link</td><td>No</td><td>Set to "yes" to turn on default linking of overlay and legend entry.</td><td>"yes" / "no" (defaults to "no"; all values other than "yes" are equivalent to "no")</td></tr>
<tr><td>Legendbox</td><td>No</td><td>Set to "no" to turn off the box/border around each section of the legend.</td><td>"yes" / "no" (defaults to "yes"; all values other than "no" are equivalent to "yes")</td></tr>
<tr><td>Float</td><td>No</td><td>Determines how image and legend or positioned on the page.</td><td>CCS float value ("none", "left", "right") or "center" (defaults to "center")</td></tr>
<tr><td>Overlay</td><td>No</td><td>Determines whether or not the overlays are presented when an image is available.</td><td>"yes" / "no" (defaults to "yes"; all values other than "no" are equivalent to "yes")</td></tr>
<tr><td>Border</td><td>No</td><td>Determines whether or not a border is placed around the whole presentation.</td><td>"yes" / "no" (defaults to "yes"; all values other than "no" are equivalent to "yes")</td></tr>
<tr><td>Windrose</td><td>No</td><td>Set to "yes" to display a windrose in the lower right corner of the image.</td><td>"yes" / "no" (defaults to "no"; all values other than "yes" are equivalent to "no")</td></tr>

<tr><th colspan="4" style="text-align:left">''Legend''</th></tr>
<tr><td>Legend1Title</td><td>No</td><td>The title of Legend1.</td><td>arbitrary text</td></tr>
<tr><td>Legend1Start</td><td>No</td><td>The number of the first overlay to appear in Legend1.</td><td>positive number (defaults to the first overlay set, otherwise to the previous legend end plus 1 if there is a previous legend)</td></tr>
<tr><td>Legend1End</td><td>No</td><td>The number of the last overlay to appear in Legend1.</td><td>positive number (defaults to the next legend start less 1 if there is a next legend, otherwise to the last set overlay)</td></tr>
<tr><td colspan="4" style="text-align:center">''... repeat this pattern for up to 6 separate sections of the legend ...''</td></tr>

<tr><th colspan="4" style="text-align:left">''Overlays''</th></tr>
<tr><td>Overlay1Form</td><td>No</td><td>The form of the overlays, either as numbered icon (e.g. {{#invoke:Overlay|Icon|1|red|Form=icon}}), colored text (e.g. {{#invoke:Overlay|Icon|1|red|Form=text}}), or bare color (e.g. {{#invoke:Overlay|Icon|1|red|Form=color}}).</td><td>"icon" / "text" / "color" (defaults to the previous overlay form, or to "icon" if there is no previous overlay form)</td></tr>
<tr><td>Overlay1</td><td>No</td><td>Text of Overlay1 to be displayed in the legend.</td><td>arbitrary text (defaults to the value of Overlay1Tip if any)</td></tr>
<tr><td>Overlay1Color</td><td>No</td><td>The color of Overlay1.</td><td>arbitrary color or one of the color tags defined in [[Module:Overlay/colors]]: {{ListFormat|access; enemy; npc; secret; site|Bullets}} (defaults to the previous overlay color, or to "red" if there is no previous overlay color)</td></tr>
<tr><td>Overlay1Tip</td><td>No</td><td>Pop up tool tip text to appear when the screen pointer is over Overlay1.</td><td>arbitrary text (defaults to the value of Overlay1)</td></tr>
<tr><td>Overlay1Link</td><td>No</td><td>Text to be used as a link for the overlay legend text.</td><td>arbitrary text (defaults to the value of Overlay1 if Link is not set to "no")</td></tr>
<tr><td>Overlay1Left</td><td>No</td><td>Distance in pixels of the left edge of Overlay1 from the left side of the image.</td><td>non-negative number</td></tr>
<tr><td>Overlay1Top</td><td>No</td><td>Distance in pixels of the top edge of Overlay1 from the top side of the image.</td><td>non-negative number</td></tr>
<tr><td>Overlay1Left2</td><td>No</td><td>The left ordinate for a second position of Overlay1.</td><td>non-negative number</td></tr>
<tr><td>Overlay1Top2</td><td>No</td><td>The top ordinate for a second position of Overlay1.</td><td>non-negative number</td></tr>
<tr><td colspan="4" style="text-align:center">''... repeat this pattern for up to 30 different overlays, with up to 12 different positions per overlay ...''</td></tr>
</table>

Template:Overlay/doc - Revision history

MikeB: Created page with "== Description == This template generates an annoted map by overlaying numbered markers on an image and displaying a corresponding legend underneath. It requires the Lua modul..."