Template:Localized link/sandbox/doc
 | This is a documentation subpage for Template:Localized link/sandbox. 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 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
editThis is the TemplateData documentation for this template used by VisualEditor and other tools.
Localized link/sandbox
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
If "nsp" parameter is not defined, as link text displays the full pagename (including namespace); otherwise — if "nsp" parameter is defined by any value — link text displays the short pagename, without namespace.
Examples of simple usage
edit| Use | Becomes |
|---|---|
| {{ll/s|Communication}} | Template:Ll/s |
| {{ll/s|Communication|コミュニケーション}} | Template:Ll/s |
| {{ll/s|Project:About}} | Template:Ll/s |
| {{ll/s|Project:About|nsp=0}} | Template:Ll/s |
| {{ll/s|iw=m|Project:About}} | Template:Ll/s |
| {{ll/s|iw=m|Project:About|nsp=0}} | Template:Ll/s |
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
<tvar name=id>...</tvar>, separately from the translatable displayed text of the link.- As example, instead
{{ll|Communication|About communication}}, translation markup in translatable page will be[[<tvar name=1>Special:MyLanguage/Communication</tvar>|About communication]].
- As example, instead
- Alternatively, may be exclude this code from translatable section.
- As example, for
some text {{ll|Communication|About communication}} some text, translation markup in translatable page will be: <translate>some text</translate> {{ll|Communication|2=<translate>About communication</translate>}} <translate>some text</translate>- 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|Communication}}, translation markup in translatable page will be
<tvar name=1>{{ll|Communication}}</tvar>.
- As example, instead {{ll|Communication}}, translation markup in translatable page will be
See also
edit- Template:Localized link/messagedoc — should be used for message documentation in translatable pages that use this template.
- {{Translatable template}} - alias {{TNT}} or {{Tnt}}
- {{Translatable template name}} - alias {{TNTN}} or {{Tntn}}
- {{Page language link}} - alias {{Pll}} - add a link from a translatable page to another translatable page in the same language