Template:Localized link/doc
This is a documentation subpage for Template:Localized link. It contains usage information, categories, and other content that is not part of the original template page. |
Purpose
editThis helper template can be used to link to translatable pages in the user's language. It uses the special page prefix Special:MyLanguage/
, 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 Meta-Wiki) 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.
Simple usage
editIt is used in the same way normal wikilinks are used: One parameter to use the same link text as the page name, two parameters for different page name and link text.
If second parameter is not defined, link text will display the name of the target page in the language corresponding to the language of the current page (if exist; otherwise — English name).
Examples of simple using
editUse | Becomes |
---|---|
{{ll|Meta:About}} | Meta:About |
{{ll|Meta:About|{{int:about}}}} | About |
Usage in translatable pages
editOn pages prepared for translation with the Translate extension, this template may be used in three ways.
- 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
{{ll|Meta:About|About Meta-Wiki}}
, translation markup in translatable page will be[[Special:MyLanguage/Meta:About|About Meta-Wiki]]
.
- As example, instead
- Alternatively, may be exclude this code from translatable section and
- As example, for
some text {{ll|Meta:About|About Meta-Wiki}} some text
, translation markup in translatable page will be <translation>some text</translation> {{ll|Meta:About|2=<translation>About Meta-Wiki</translation>}} <translation>some text</translation>
.- This is useful for bulleted lists of links, e.g. in the "See also:" sections.
- As example, for
- If link text does not have to be different from the name of landing page, will be better to embed all this code into
<tvar>
.- As example, instead
{{ll|Meta:About}}
, translation markup in translatable page will be{{ll|Meta:About}}
. - This is also very useful for bulleted lists of links, e.g. in the "See also:" sections.
- As example, instead
TemplateData
editTemplateData for Localized link
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Page Name | 1 | Linked page name. | Page name | required |
Display Text | 2 | Displayed link text.
| Line | suggested |
Interwiki Prefix | iw | The Interwiki prefix. See [[Special:Interwiki]] for a list of valid values. Note that the target wiki must use MediaWiki-style page names and support “Special:MyLanguage”. | String | optional |
Show Namespace Prefix? | nsp | Whether to include the namespace prefix, ignored if parameter 2 is passed.
| Boolean | optional |
Edit parameter translations
See also
edit- Template:Localized link/messagedoc – should be used for message documentation in translatable pages that use this template.