View source for Template:Localized link/doc

<noinclude>{{Documentation subpage}}</noinclude> 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->

== Purpose ==
This helper template can be used to link to [[Special:LanguageStats|translatable pages]] in the user's language. It uses the special page prefix <code>Special:MyLanguage/</code>, 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 ==

<templatedata>
{
	"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"
}
</templatedata>

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

=== Examples of simple usage ===
{| class="wikitable"
|-
! Use
! Becomes
|-
| <code><nowiki>{{ll|Communication}}</nowiki></code>
| {{ll|Communication}}
|-
| <code><nowiki>{{ll|Communication|コミュニケーション}}</nowiki></code>
| {{ll|Communication|コミュニケーション}}
|-
| <code><nowiki>{{ll|Project:About}}</nowiki></code>
| {{ll|Project:About}}
|-
| <code><nowiki>{{ll|Project:About|nsp=0}}</nowiki></code>
| {{ll|Project:About|nsp=0}}
|}

== Usage in translatable pages ==

On pages prepared for translation with the [[Extension:Translate|Translate extension]], this template may used in three ways. 
# Should better be substitute this template, and then the wikilink target embedded in a <code><nowiki><tvar|id>...</></nowiki></code>, separately from the translatable displayed text of the link. 
#: As example, instead <code><nowiki>{{ll|Communication|About communication}}</nowiki></code>, translation markup in translatable page will be <code><nowiki>[[<tvar|comm>Special:MyLanguage/Communication</>|About communication]]</nowiki></code>. 
# Alternatively, may be exclude this code from translatable section and 
#: As example, for <code> some text <nowiki>{{ll|Communication|About communication}}</nowiki> some text </code>, translation markup in translatable page will be 
#: <code>&lt;translate>some text&lt;/translate> <nowiki>{{ll|Communication|&lt;translate>About communication&lt;/translate>}}</nowiki> &lt;translate>some text&lt;/translate></code>.
#: This is useful for bulleted lists of links, e.g. in the "See also:" sections.
# If link text does not have to be different from the name of landing page, will be better to embed all this code into {{tag|tvar|open}}.
#: As example, instead <code><nowiki>{{ll|Communication}}</nowiki></code>, translation markup in translatable page will be <code><nowiki><tvar|about-meta>{{ll|Communication}}</></nowiki></code>.

== See also ==
* [[Template:Localized link/messagedoc]] – should be used for message documentation in translatable pages that use this template.
* {{tl|Translatable template}}
* {{tl|Translatable template name}}, alias {{tl|TNTN}} or {{tl|tntn}}
{{Languages|Template:Localized link/doc}}
<includeonly>
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, INSIDE INCLUDEONLY TAGS. -->
[[Category:Internationalization templates]]
</includeonly>