Template:Sister project links/doc

This is a documentation subpage for Template:Sister project links.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 10,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

The {{Sister project links}} template provides one box with links to corresponding pages on various Wikimedia sister projects. The following pages are sought, in order:

An explicit page chosen by an editor (if provided)
A sitelink in Wikidata (if exists)
A search page on the sister project

Sending a reader to a search page can be an unpleasant experience, if there is no corresponding page for that subject. Editors have a choice between two methods to prevent this negative experience:

Manually check each project for a relevant page, if missing, then set argument to "no" (e.g., |wikt=n)
Use "automatic mode", which only displays a sister project by default if sitelink exists (e.g., |auto=yes)

Note that {{Sister project auto}} is equivalent to {{Sister project links|auto=yes}}.

Usage

{{Sister project links
<!-- Configuration parameters. -->
 |1= |display= |auto= |collapsible= |position= |style=

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

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

<!-- 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 -->
}}

Example with all parameters and all projects displayed (see right):

{{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
 |commonscat= |author= |cookbook=
}}

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 |auto=yes, default is either use wikidata (if present), or drop the link
- If |auto=no, if project is in the "yes" list above, either use wikidata or search. Otherwise drop the link.

Location

Generally:

Do not place this template in a section all by itself.

Do not place this template in a section containing columns.

Specifically:

In articles, this template should normally be placed at the top of the External links section, if it exists. Otherwise, place this template at the top of the last section in the article.
- See Wikipedia:Wikimedia sister projects#Where to place links for more information and alternatives.
In disambiguation pages, this template should be listed above other text, but below any cleanup templates, images, infoboxes or navboxes.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Sister project links

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.

Template parameters
Parameter		Description	Type	Status
Search term	`1`	Use if the ''search term'' differs from the pagename. Default {{PAGENAME}}	String	optional
Display name	`display`	Use if the ''display name'' is different from the search term. For example, the bear article would be 'Bears'. Default {{PAGENAME}}	String	optional
Use wikidata to fill defaults	`auto`	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	String	optional
Collapsible?	`collapsible`	Set to "yes" to make the template collapsible. Set to "collapsed" to make the template collapsible and initially collapsed. Default No	String	optional
Position	`position`	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.) Default right	String	optional
CSS style	`style`	Optional CSS style specifications. Use with caution. (And don't use for evil!)	String	optional
Wiktionary link	`wikt`	Wiktionary link to show. Acceptable values are a page name, "yes", and "no". Default Yes	String	optional
Commons link	`c` `commons`	Commons link to show. Acceptable values are a page name, "yes" and "no". Default Yes	String	optional
Commons category?	`commonscat`	Specifies whether a link to a category on Wikimedia Commons is shown. Can be "yes" or "no". Default No	String	optional
Wikinews link	`n`	Wikinews link to show. Acceptable values are a page name, "yes" and "no". Default Yes	String	optional
Wikiquote link	`q`	Wikiquote link to show. Acceptable values are a page name, "yes" and "no". Default Yes	String	optional
Wikisource link	`s`	Wikisource link to show. Acceptable values are a page name, "yes" and "no". Default Yes	String	optional
Wikisource author?	`author`	Use for articles about authors to force the Wikisource links to include the "Author:" prefix. Can be set to "yes" or "no". Default No	String	optional
Wikibooks link	`b`	Wikibooks link to show. Acceptable values are a page name, "yes" and "no". Default Yes	String	optional
Cookbook	`cookbook`	If yes, link to Cookbook at wikibooks. If string, use that string as article title in Cookbooks. Default No	String	optional
Wikiversity link	`v`	Wikiversity link to show. Acceptable values are a page name, "yes", and "no". Default Yes	String	optional
Wikivoyage link	`voy`	Wikivoyage link to show. Acceptable values are a page name, "yes" and "no". Default No	String	optional
Wikispecies taxon link	`species`	Wikispecies link to show. Acceptable values are a page name, "yes" and "no". Default No	String	optional
Wikispecies author link	`species_author`	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	String	optional
Interwiki link	`iw`	Link to other language edition. Acceptable values are a Wikipedia language code (e.g., "de"), "yes" and "no". Default No	String	optional
Wikidata link	`d`	Wikidata link to show. Acceptable values are a QID, "yes" and "no". Default No	String	optional
Meta link	`m`	Meta link to show. Acceptable values are a page name, "yes" and "no". Default No	String	optional
MediaWiki link	`mw`	MediaWiki link to show. Acceptable values are a page name, "yes" and "no". Default No	String	optional