View source for Template:Sister project links/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{high-use}}
{{Lua|Module:Sister project links|Module:Commons link}}
{{Uses TemplateStyles|Module:Sister project links/styles.css}}
{{Sister project links{{\sandbox}}}}

The {{tl|Sister project links}} template provides '''one box with links''' to corresponding pages on various [[Wikipedia:Wikimedia sister projects|Wikimedia sister projects]]. The box looks for a page on the subject by checking for the following (in order of preference):
# A page specified by an editor
# A sitelink in Wikidata
# A page that matches the topic name (by searching the sister project)

If none of these three methods returns a page, then the link sends the reader to the search results page, which lists pages that contain matches (exact or partial) for the search string.

Leading a reader to a search results page may confuse or disappoint them. So, before you enable a link to a sister project, it's best to verify that it has a page on the topic. You can do this in one of two ways:
* Manually check each project for a relevant page. If none exists, set the argument to "no":
:*{{para|wikt|no}} or {{para|wikt|n}}
* Use "automatic mode", which only displays a sister project by default if a sitelink exists:
:*{{para|auto|yes}} or {{para|auto|y}}

To enable automatic mode for all links, set {{tlx|Sister project links|<nowiki>auto=yes</nowiki>}}, or use the template {{tl|Sister project auto}}.

==Usage{{anchor|Parameters}}==
<div id=spl>{{Sister project links
 |1= |display= |auto= |collapsible= |position= |style=
 |wikt= |c= |q= |s= |b= |v=
 |voy=yes |species=yes |species_author=John |iw=en |d=yes |m=yes |mw=yes |f=yes
 |commonscat= |author= |cookbook=
}}</div>
<syntaxhighlight lang="wikitext">
{{Sister project links
<!-- Configuration parameters. -->
 |1= |display= |auto= |collapsible= |position= |style=

<!-- Note: The order of the projects is how they appear in the navbox. -->
<!-- First part: Projects that default to "yes" when auto=no -->
 |wikt= |c= |q= |s= |b= |v=

<!-- Second part: Projects that default to "no" when auto=no -->
 |voy= |species= |species_author= |iw= |d= |m= |mw= |f=

<!-- The following parameters specifying search options for pages above. -->
 |commonscat= <!-- (relevant for c) force link to commons category -->
 |author= <!-- (relevant for s) force search for author name in wikisource -->
 |cookbook= <!-- (relevant for b) force link to cookbook at wikibooks -->
}}
</syntaxhighlight>
'''Example with all parameters and all projects displayed (like [[#spl|here]]):'''
<syntaxhighlight lang="wikitext">
{{Sister project links
 |1= |display= |auto= |collapsible= |position= |style=
 |wikt= |c= |n= |q= |s= |b= |v=
 |voy=yes |species=yes |species_author=John |iw=en |d=yes |m=yes |mw=yes |f=yes
 |commonscat= |author= |cookbook=
}}
</syntaxhighlight>

===Default display===
For any project parameter, there are four acceptable values:
* '''"yes"''' means find a reasonable link for the sister project (Wikidata, or default back to search)
* '''"no"''' means exclude this sister project: no link
* '''a string''' means link to the page with whose title is that string
* '''blank or missing''' means use the default
** If {{para|auto|yes}}, default is either use Wikidata (if present), or drop the link
** If {{para|auto|no}}, if project is in the "yes" list above, either use Wikidata or search. Otherwise drop the link.

===Location===
{{Commons templates location}}

===Interwiki link===
The {{para|iw}} parameter is for use in articles about languages themselves. It is designed to be used instead of the {{tl|InterWiki}} template: it links to the Main Page of Wikipedia that corresponds to the language code. See [[Template:InterWiki/doc]] for more information. Up to three sister Wikipedias can be linked, using {{para|iw}}, {{para|iw1}}, and {{para|iw2}}.

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "Displays a terminal window with a set of commands. If the titles in the individual sister projects differ, use the following parameters, which are taken from [[Help:Interwiki linking]]. The value \"Yes\" means that the page will be found automatically.",
	"params": {
		"1": {
			"label": "Search term",
			"type": "string",
			"required": false,
			"description": "Use if the ''search term'' differs from the pagename. E.g. to change the capitalization for Wiktionary links",
			"default": "{{PAGENAME}}"
		},
		"auto": {
			"label": "Use wikidata to fill defaults",
			"type": "string",
			"required": false,
			"description": "If auto=\"yes\", then sister projects with wikidata sitelinks are filled-in, others are off by default. Each project can be overridden with its own parameter.",
			"default": "No"
		},
		"collapsible": {
			"label": "Collapsible?",
			"description": "Set to \"yes\" to make the template collapsible. Set to \"collapsed\" to make the template collapsible and initially collapsed.",
			"type": "string",
			"default": "No"
		},
		"display": {
			"label": "Display name",
			"type": "string",
			"required": false,
			"description": "Use if the ''display name'' is different from the search term. For example, the bear article would be 'Bears'.",
			"default": "{{PAGENAME}}"
		},
		"author": {
			"label": "Wikisource author?",
			"type": "string",
			"required": false,
			"description": "Use for articles about authors to force the Wikisource links to include the \"Author:\" prefix. Can be set to \"yes\" or \"no\".",
			"default": "No"
		},
		"commonscat": {
			"label": "Commons category?",
			"type": "string",
			"required": false,
			"description": "Specifies whether a link to a category on Wikimedia Commons is shown. Can be \"yes\" or \"no\".",
			"default": "No"
		},
		"cookbook": {
			"label": "Cookbook",
			"type": "string",
			"required": false,
			"description": "If yes, link to Cookbook at wikibooks. If string, use that string as article title in Cookbooks.",
			"default": "No"
		},
		"wikt": {
			"label": "Wiktionary link",
			"type": "string",
			"required": false,
			"description": "Wiktionary link to show. Acceptable values are a page name, \"yes\", and \"no\".",
			"default": "Yes"
		},
		"c": {
			"label": "Commons link",
			"type": "string",
			"required": false,
			"description": "Commons link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"aliases": [
				"commons"
			],
			"default": "Yes"
		},
		"q": {
			"label": "Wikiquote link",
			"type": "string",
			"required": false,
			"description": "Wikiquote link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "Yes"
		},
		"s": {
			"label": "Wikisource link",
			"type": "string",
			"required": false,
			"description": "Wikisource link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "Yes"
		},
		"b": {
			"label": "Wikibooks link",
			"type": "string",
			"required": false,
			"description": "Wikibooks link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "Yes"
		},
		"voy": {
			"label": "Wikivoyage link",
			"type": "string",
			"required": false,
			"description": "Wikivoyage link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "No"
		},
		"v": {
			"label": "Wikiversity link",
			"type": "string",
			"required": false,
			"description": "Wikiversity link to show. Acceptable values are a page name, \"yes\", and \"no\".",
			"default": "Yes"
		},
		"d": {
			"label": "Wikidata link",
			"type": "string",
			"required": false,
			"description": "Wikidata link to show. Acceptable values are a QID, \"yes\" and \"no\".",
			"default": "No"
		},
		"species": {
			"label": "Wikispecies taxon link",
			"type": "string",
			"required": false,
			"description": "Wikispecies link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "No"
		},
		"species_author": {
			"label": "Wikispecies author link",
			"type": "string",
			"required": false,
			"description": "Wikispecies author link to show. Acceptable values are a page name, \"yes\" and \"no\". Even if \"yes\" it will be only displayed when species ≠ \"yes\" ",
			"default": "No"
		},
		"iw": {
			"label": "Interwiki link",
			"type": "string",
			"required": false,
			"description": "Link to other language edition. Acceptable values are a Wikipedia language code (e.g., \"de\"), \"yes\" and \"no\".",
			"default": "No"
		},
		"m": {
			"label": "Meta link",
			"type": "string",
			"required": false,
			"description": "Meta link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "No"
		},
		"mw": {
			"label": "MediaWiki link",
			"type": "string",
			"required": false,
			"description": "MediaWiki link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "No"
		},
		"f": {
			"label": "Wikifunctions link",
			"type": "string",
			"required": false,
			"description": "Wikifunctions link to show. Acceptable values are a page name, \"yes\" and \"no\".",
			"default": "No"
		},
		"position": {
			"label": "Position",
			"description": "Specifies whether the box floats to the left or right. The only acceptable value is \"left\" which causes the box to float to the left. Any other value (not specifying this parameter) activates the default. (Float to the right.)",
			"type": "string",
			"default": "right"
		},
		"style": {
			"label": "CSS style",
			"description": "Optional CSS style specifications. Use with caution. (And don't use for evil!)",
			"type": "string"
		}
	},
	"paramOrder": [
		"1",
		"display",
		"auto",
		"collapsible",
		"position",
		"style",
		"wikt",
		"c",
		"commonscat",
		"q",
		"s",
		"author",
		"b",
		"cookbook",
		"v",
		"voy",
		"species",
		"species_author",
		"iw",
		"d",
		"m",
		"mw",
		"f"
	]
}
</templatedata>

==Images used==
This template potentially displays the following images:<br/>
:[[File:Wiktionary-logo-v2.svg|27x27px|link=|alt=]] [[:File:Wiktionary-logo-v2.svg|Wiktionary logo]] <code>wikt</code><br/>
:[[File:Commons-logo.svg|27x27px|link=|alt=]] [[:File:Commons-logo.svg|Wikimedia Commons logo]] <code>c</code> or <code>commons</code><br/>
:[[File:Wikinews-logo.svg|27x27px|link=|alt=]] [[:File:Wikinews-logo.svg|Wikinews logo]] <code>n</code><br/>
:[[File:Wikiquote-logo.svg|27x27px|link=|alt=]] [[:File:Wikiquote-logo.svg|Wikiquote logo]] <code>q</code><br/>
:[[File:Wikisource-logo.svg|27x27px|link=|alt=]] [[:File:Wikisource-logo.svg|Wikisource logo]] <code>s</code><br/>
:[[File:Wikibooks-logo.svg|27x27px|link=|alt=]] [[:File:Wikibooks-logo.svg|Wikibooks logo]] <code>b</code><br/>
:[[File:Wikivoyage-Logo-v3-icon.svg|27x27px|link=|alt=]] [[:File:Wikivoyage-Logo-v3-icon.svg|Wikivoyage logo]] <code>voy</code><br/>
:[[File:Wikiversity logo 2017.svg|27x27px|link=|alt=]] [[:File:Wikiversity logo 2017.svg|Wikiversity logo]] <code>v</code><br/>
:[[File:Wikispecies-logo.svg|27x27px|link=|alt=]] [[:File:Wikispecies-logo.svg|Wikispecies logo]] <code>species</code> or <code>species_author</code><br/>
:[[File:Wikipedia-v2-logo.svg|27x27px|link=|alt=]] [[:File:Wikipedia-v2-logo.svg|Wikipedia logo]] <code>iw</code>
:[[File:Wikidata-logo.svg|27x27px|link=|alt=]] [[:File:Wikidata-logo.svg|Wikidata logo]] <code>d</code><br/>
:[[File:Wikimedia Community Logo.svg|27x27px|link=|alt=]] [[:File:Wikimedia Community Logo.svg|Meta-Wiki logo]] <code>m</code><br/>
:[[File:MediaWiki-2020-icon.svg|27x27px|link=|alt=]] [[:File:MediaWiki-2020-icon.svg|MediaWiki logo]] <code>mw</code>
:[[File:Wikifunctions-logo-en.svg|27x27px|link=|alt=]] [[:File:Wikifunctions-logo-en.svg|Wikifunctions logo]] <code>f</code>

==Tracking categories==
* {{clc|Pages using Sister project links with unknown parameters}}
* {{clc|Pages using Sister project links with default search}}
* {{clc|Pages using Sister project links with hidden wikidata}}
* {{clc|Pages using Sister project links with wikidata namespace mismatch}}
* {{clc|Pages using Sister project links with wikidata mismatch}}
* {{clc|Pages with empty sister project links}}

==See also==
* [[Template:Sister project]] – used on more than one million pages
* [[Template:Sister bar]] – a horizontal version
* [[Template:Subject bar]] – a horizontal version that includes optional portals
* [[Template:Commons]]
* [[Wikipedia:Template index/Sister projects]]
* [[Help:Interwiki linking]]

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Interwiki link sidebar templates| ]]
}}</includeonly>