Template:Localized link/doc

hjhk1911@gmail.com

Purpose
This helper template can be used to link to translatable pages in the user's language. It uses the special page prefix, which checks if there is a translated version of a page in the user's language, and links to it if there is one, and links to a fallback language where available, or the default wiki language version (English in MediaWiki) if there isn't.

It should be used in translated pages, so that they link to the right page even if there is no translated page in that language.

Usage
{	"params": { "1": {			"label": { "en": "Page name", "fr": "Nom de la page" },			"type": "wiki-page-name", "required": true, "suggested": true, "description": { "en": "Linked page", "fr": "Page liée" }		},		"2": {			"type": "string", "label": { "en": "Displayed text", "fr": "Texte affiché" },			"description": { "en": "Display text for this link", "fr": "Texte affiché pour ce lien" },			"suggested": true },		"nsp": {} },	"description": { "en": "Link to translatable page in the user’s language. It uses the special page prefix \"Special:MyLanguage/\".", "fr": "Lien vers une page traduisible dans la langue de l’utilisateur. Le lien utilise la page spéciale \"Special:MyLanguage/\"." },	"format": "inline" }

If ' ' parameter is not defined, as link text displays the full pagename (including namespace); otherwise — if ' ' parameter is defined by any value — link text displays the short pagename, without namespace.

Usage in translatable pages
On pages prepared for translation with the Translate extension, this template may used in three ways.
 * 1) Should better be substitute this template, and then the wikilink target embedded in a , separately from the translatable displayed text of the link.
 * As example, instead, translation markup in translatable page will be.
 * 1) Alternatively, may be exclude this code from translatable section and
 * As example, for, translation markup in translatable page will be
 * This is useful for bulleted lists of links, e.g. in the "See also:" sections.
 * 1) If link text does not have to be different from the name of landing page, will be better to embed all this code into.
 * As example, instead, translation markup in translatable page will be.
 * As example, instead, translation markup in translatable page will be.