Template:Sister project links/doc: Difference between revisions

Latest revision as of 08:02, 9 September 2026

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.

__EXPECTED_UNCONNECTED_PAGE__

This template is used on approximately 14,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:

Lua error in Module:TNT at line 159: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Uses TemplateStyles.tab. Lua error in Module:Sister_project_links at line 376: attempt to index field 'wikibase' (a nil value).

The {{Sister project links}} template provides one box with links to corresponding pages on various 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":

<syntaxhighlight lang="wikitext" inline style="display: none;" />|wikt=no or <syntaxhighlight lang="wikitext" inline style="display: none;" />|wikt=n

Use "automatic mode", which only displays a sister project by default if a sitelink exists:

<syntaxhighlight lang="wikitext" inline style="display: none;" />|auto=yes or <syntaxhighlight lang="wikitext" inline style="display: none;" />|auto=y

To enable automatic mode for all links, set {{Sister project links|auto=yes}}, or use the template {{Sister project auto}}.

Usage

Lua error in Module:Sister_project_links at line 376: attempt to index field 'wikibase' (a nil value).

<syntaxhighlight lang="wikitext"> Lua error in Module:Sister_project_links at line 376: attempt to index field 'wikibase' (a nil value). </syntaxhighlight> Example with all parameters and all projects displayed (like here): <syntaxhighlight lang="wikitext"> Lua error in Module:Sister_project_links at line 376: attempt to index field 'wikibase' (a nil value). </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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|auto=yes, default is either use Wikidata (if present), or drop the link
- If <syntaxhighlight lang="wikitext" inline style="display: none;" />|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 or any box-type template in a section all by itself.

Do not place this template in a section containing columns without floating left.

Do not indent this template with colon (<syntaxhighlight lang="text" class="" style="" inline="1">:</syntaxhighlight>) or a bullet (<syntaxhighlight lang="text" class="" style="" inline="1">*</syntaxhighlight>) markup.

Specifically:

In articles, this template should be placed at the top of the last section on the page so that it floats to the right of that section.
- See Wikipedia:Wikimedia sister projects#Where to place links for more information and alternatives.
In disambiguation pages, this template is usually placed at the top of the page.
In categories, this template should be grouped with other templates at the beginning of the category introduction. This avoids unnecessary white space as any text is floated around the template boxes.

Interwiki link

The <syntaxhighlight lang="wikitext" inline style="display: none;" />|iw= parameter is for use in articles about languages themselves. It is designed to be used instead of the {{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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|iw=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|iw1=, and <syntaxhighlight lang="wikitext" inline style="display: none;" />|iw2=.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Sister project links in articles based on its TemplateData.

TemplateData for Sister project links

<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": "Sister project links/doc" }, "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": "Sister project links/doc" }, "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>