Template:MapLink/Documentation: Difference between revisions

From Zelda Dungeon Wiki
Jump to navigation Jump to search
Want an adless experience? Log in or Create an account.
(update doc with pin info)
mNo edit summary
 
(3 intermediate revisions by one other user not shown)
Line 1: Line 1:
This template has two behaviors depending on whether it's displayed on a page or called by the API. On a page, it generates a simple wikilink with a pin icon linking to the [[Zelda Dungeon:Breath of the Wild Map|Breath of the Wild Map]]. Called by the API (i.e. from the map), it creates an element that is understood by the map as an internal link to another location. Clicking on this link will pan the map (or jump if far away) to the given location.
This template creates an element that is understood by the [[Zelda Dungeon:Breath of the Wild Map|Breath of the Wild Map]] as an internal link to another location. Clicking on this link will pan the map (or jump if far away) to the given location.


==Usage==
==Usage==
{{Usage|text|lat|lng}}
{{Usage|text|id}}
{{Usage/Param|text|Display text that the user clicks. If lat and lng aren't supplied, this also doubles as the target id to link to.}}
{{Usage/Param|text|Display text that the user clicks. If lat and lng aren't supplied, this also doubles as the target id to link to.}}
{{Usage/Param|lat|Latitude of the target as defined in its {{Temlink|Pin}} template.|optional}}
{{Usage/Param|id|ID for the target to link to.|optional}}
{{Usage/Param|lng|Longitude of the target as defined in its {{Temlink|Pin}} template.|optional}}
 
This is intended for use inside <code><nowiki><section></section></nowiki></code> tags.


==Example==
==Example==
Line 14: Line 11:
<section begin=summary />'''Shrine Quest:''' {{MapLink|The Stolen Heirloom}}<section end=summary />
<section begin=summary />'''Shrine Quest:''' {{MapLink|The Stolen Heirloom}}<section end=summary />


(visit the map to see example output in map format)
(visit the map to see example output in map format)<noinclude>{{cat|Template Documentation}}</noinclude>

Latest revision as of 01:40, July 21, 2020

This template creates an element that is understood by the Breath of the Wild Map as an internal link to another location. Clicking on this link will pan the map (or jump if far away) to the given location.

Usage

{{MapLink/Documentation| text | id }}

  • text — Display text that the user clicks. If lat and lng aren't supplied, this also doubles as the target id to link to.
  • id — ID for the target to link to. (Optional.)

Example

<section begin=summary />'''Shrine Quest:''' {{MapLink|The Stolen Heirloom}}<section end=summary />

Shrine Quest: The Stolen Heirloom

(visit the map to see example output in map format)