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.
No edit summary
(update doc with pin info)
Line 1: Line 1:
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.
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.


==Usage==
==Usage==
Line 7: Line 7:
{{Usage/Param|lng|Longitude of the target as defined in its {{Temlink|Pin}} template.|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. On the wiki, it is displayed as a simple wikilink to the article specified in the <code>text</code> parameter. If this isn't desired, hide it with <code><nowiki><includeonly></includeonly></nowiki></code>.
This is intended for use inside <code><nowiki><section></section></nowiki></code> tags.


==Example==
==Example==

Revision as of 19:54, March 10, 2017

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 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.

Usage

{{MapLink/Documentation| text | lat | lng }}

  • text — Display text that the user clicks. If lat and lng aren't supplied, this also doubles as the target id to link to.
  • lat — Latitude of the target as defined in its {{Pin}} template. (Optional.)
  • lng — Longitude of the target as defined in its {{Pin}} template. (Optional.)

This is intended for use inside <section></section> tags.

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)