View source for Template:Wikivoyage/doc

{{Documentation subpage}}
{{High-use}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

== Usage ==

As supported by [[Wikipedia:Wikimedia sister projects]], this template may be used to add a [[Wikivoyage]] link to a Wikipedia article. It generates an [[Help:Interwikimedia links|interwikimedia link]] – it is not intended to represent [[WP:SOURCES|sources]] for Wikipedia articles.

If usage of the template creates layout issues in an article, {{tl|Wikivoyage-inline}} should be used instead.

The Wikivoyage template can be used with one, two, three or no parameters as follows:
:'''<nowiki>{{Wikivoyage}}</nowiki>''' creates a link to the Wikivoyage page matching the Wikipedia page name.
:'''<nowiki>{{Wikivoyage|Boracay}}</nowiki>''' creates a link to the Wikivoyage page titled "Boracay".
:'''<nowiki>{{Wikivoyage|Boracay|Boracay Island}}</nowiki>''' creates a link to the Wikivoyage page titled "Boracay", but the link is worded "Boracay Island".
:'''<nowiki>{{Wikivoyage|Boracay|Boracay Island|an itinerary}}</nowiki>''' creates a link to the Wikivoyage page titled "Boracay", and the entire sentence reads "Wikivoyage has an itinerary for Boracay Island."

See also: {{tl|Sister project links}}

<nowiki>{{Sister project links|voy={{PAGENAME}}}}</nowiki> will create a similar box, but accommodates multiple siblings. It is not a direct-equivalent replacement for the individual sibling project boxes as the "sister project links" box by default creates various blind links to [[special:search]] on the destination wikis which are not search-engine friendly.

==TemplateData==
{{TemplateData header}} 
<templatedata>{
 "description": "Adds an interwiki link to [[Wikivoyage]], for example for use in external links section",
 "params": {
    "1": {
      "label": "Page",
      "description": "The name of the Wikivoyage page, if not the same as the Wikipedia article",
      "type": "string/line",
      "required": false,
      "default": "<Wikipedia page name>"
    },
    "2": {
      "label": "Label",
      "description": "The label for the link, if not the same as the Wikivoyage page name",
      "type": "string/line",
      "required": false,
      "default": "<Wikipedia page name>"
    },
    "3": {
      "label": "Type",
      "description": "Use if 'a travel guide' is not the best description of the Wikivoyage page.  The most common alternatives are 'an itinerary', 'a phrasebook', 'a travel topic', and 'an article'.",
      "type": "string/line",
      "required": false,
      "default": "'a travel guide'"
    }
 }
}
</templatedata>

== Links to listings ==
=== How to link ===
First the ''wikidata'' parameter must be set on the listing entry of the point of interest on Wikivoyage. (This is the Q number you see on page reached from the Wikidata item link on the Wikipedia page).
This creates an anchor on the page so that clinking the link on Wikipedia will take the reader to the part of the Wikivoyage article where the listing is.

Second add the Wikivoyage template on the Wikipedia page of the point of interest using the page name of the article on Wikivoyage where the listing is. The wikidata code for the page anchor is automatically added.

For example for the Eiffel Tower on the Wikipedia article add ''<nowiki>{{Wikivoyage|Paris/7th arrondissement}}</nowiki>'', or also use a second parameter such as ''<nowiki>{{Wikivoyage|St. Louis|Gateway Arch}}</nowiki>'' to get the correct description on the link.
=== When to link ===
When the listing on Wikivoyage has information not typically allowed on Wikipedia, such as opening times and prices. Preferably when the listing content is of reasonable length and useful to a visitor.

== See also ==
* [[Template:Wikivoyage-inline]]
* [[Template:Wikivoyage-listing]]
* [[Template:Wikivoyage redirect]]

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Interwiki link templates]]
[[Category:Wikivoyage templates|{{PAGENAME}}]]

<!-- fr:modèle:wikivoyage is not implemented as {{autres projets|wikivoyage=...pagename...}} provides a box and icons -->
}}</includeonly>