ಟೆಂಪ್ಲೇಟ್:Sister project links/doc

This is a documentation subpage for ಟೆಂಪ್ಲೇಟ್:Sister project links.
It may contain usage information, categories and other content that is not part of the original ಟೆಂಪ್ಲೇಟ್ page.

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

This template uses TemplateStyles:

Module:Sister project links/styles.css

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":

|wikt=no or |wikt=n

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

|auto=yes or |auto=y

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

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

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 |f=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 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 (:) or a bullet (*) 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 |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 |iw=, |iw1=, and |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

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
ಪರಿಮಿತಿ		ಇವರೊ	ಇದೊ	ಸ್ತಿತಿ
Search term	`1`	Use if the ''search term'' differs from the pagename. E.g. to change the capitalization for Wiktionary links ಮೂಲೊಸ್ಥಿತಿ {{PAGENAME}}	ನೂಲು	ಐಚಿಕೊ
Display name	`display`	Use if the ''display name'' is different from the search term. For example, the bear article would be 'Bears'. ಮೂಲೊಸ್ಥಿತಿ {{PAGENAME}}	ನೂಲು	ಐಚಿಕೊ
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. ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Collapsible?	`collapsible`	Set to "yes" to make the template collapsible. Set to "collapsed" to make the template collapsible and initially collapsed. ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
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.) ಮೂಲೊಸ್ಥಿತಿ right	ನೂಲು	ಐಚಿಕೊ
CSS style	`style`	Optional CSS style specifications. Use with caution. (And don't use for evil!)	ನೂಲು	ಐಚಿಕೊ
Wiktionary link	`wikt`	Wiktionary link to show. Acceptable values are a page name, "yes", and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
Commons link	`c` `commons`	Commons link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
Commons category?	`commonscat`	Specifies whether a link to a category on Wikimedia Commons is shown. Can be "yes" or "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Wikinews link	`n`	Wikinews link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
Wikiquote link	`q`	Wikiquote link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
Wikisource link	`s`	Wikisource link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
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". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Wikibooks link	`b`	Wikibooks link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
Cookbook	`cookbook`	If yes, link to Cookbook at wikibooks. If string, use that string as article title in Cookbooks. ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Wikiversity link	`v`	Wikiversity link to show. Acceptable values are a page name, "yes", and "no". ಮೂಲೊಸ್ಥಿತಿ Yes	ನೂಲು	ಐಚಿಕೊ
Wikivoyage link	`voy`	Wikivoyage link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Wikispecies taxon link	`species`	Wikispecies link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
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" ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Interwiki link	`iw`	Link to other language edition. Acceptable values are a Wikipedia language code (e.g., "de"), "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Wikidata link	`d`	Wikidata link to show. Acceptable values are a QID, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Meta link	`m`	Meta link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
MediaWiki link	`mw`	MediaWiki link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ
Wikifunctions link	`f`	Wikifunctions link to show. Acceptable values are a page name, "yes" and "no". ಮೂಲೊಸ್ಥಿತಿ No	ನೂಲು	ಐಚಿಕೊ