Template:Localized link/doc - Revision history

Goraf: correct and rephrase usage cases

2018-04-06T21:48:38Z

correct and rephrase usage cases

← Older revision		Revision as of 00:48, 7 April 2018
Line 54:		Line 54:
	== Usage in translatable pages ==		== Usage in translatable pages ==

	On pages prepared for translation with the [[Extension:Translate\|Translate extension]], this template may used in three ways.		On pages prepared for translation with the [[mediawikiwiki:Extension:Translate\|Translate extension]], this template may be used in three ways.
	# ~~Should~~ better be ~~substitute this template,~~ and then ~~the wikilink~~ target ~~embedded in~~ a <code><tvar\|id>...</></code>~~, separately from the translatable displayed text of the link~~.		# Inside translation unit (inline with text), in case of custom label, better would be to use standard wikilink syntax and then embed link target into a <code><tvar\|id>...</></code>.
	#: 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>.		#: As example, instead of <code><nowiki>{{ll\|Communication\|About communication}}</nowiki></code>, better would be <code><nowiki>[[<tvar\|comm>Special:MyLanguage/Communication</>\|About communication]]</nowiki></code>.
	# ~~Alternatively~~, ~~may~~ be ~~exclude this code from translatable section and~~		# Outside of translation unit or in some other cases, when you have custom label, better would be to mark for translation only label.
	#: As example, for <code> some text <nowiki>{{ll\|Communication\|About communication}}</nowiki> some text </code>, translation markup in translatable page will be		#: As example, for <code> some text <nowiki>{{ll\|Communication\|About communication}}</nowiki> some text </code>, translation markup in translatable page will be:
	#: <code><translation>some text</translation> <nowiki>{{ll\|Communication\|<translation>About communication</translation>}}</nowiki> <translation>some text</translation></code>.		#: <code><translation>some text</translation> <nowiki>{{ll\|Communication\|<translation>About communication</translation>}}</nowiki> <translation>some text</translation></code>.
	#: This is useful for bulleted lists of links, e.g. in the "See also:" sections.		#: 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 <code><nowiki><tvar></nowiki></code>.		# If link text does not have to be different from the name of landing page, then better would be to embed the whole template call code into <code><nowiki><tvar></nowiki></code>.
	#: 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>.		#: As example, instead of <code><nowiki>{{ll\|Communication}}</nowiki></code> better would be <code><nowiki><tvar\|about-meta>{{ll\|Communication}}</></nowiki></code>.

	== Source ==		== Source ==

Goraf: +{{TemplateDataHeader}}

2017-12-11T19:53:36Z

+{{TemplateDataHeader}}

← Older revision		Revision as of 22:53, 11 December 2017
Line 8:		Line 8:

	== Usage ==		== Usage ==
			{{TemplateDataHeader}}
	<templatedata>		<templatedata>
	{		{

Goraf: +Category:I18n

2017-12-11T19:09:56Z

+Category:I18n

← Older revision		Revision as of 22:09, 11 December 2017
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
	{{Shortcut\|Template:Ll}}		{{Shortcut\|Template:Ll}}
	~~<includeonly>~~
	~~<!-- Add categories at the bottom and then remove this includeonly block -->~~
	~~{{Uncategorized}}~~
	~~</includeonly>~~

	== Purpose ==		== Purpose ==
Line 77:		Line 73:
	<includeonly>		<includeonly>
	<!-- Categories go here -->		<!-- Categories go here -->
			[[Category:I18n]]
	</includeonly>		</includeonly>

Goraf: +Shortcut; +source

2017-12-11T18:11:40Z

+Shortcut; +source

← Older revision		Revision as of 21:11, 11 December 2017
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
			{{Shortcut\|Template:Ll}}
	<includeonly>		<includeonly>
	<!-- Add categories at the bottom and then remove this includeonly block -->		<!-- Add categories at the bottom and then remove this includeonly block -->
Line 66:		Line 67:
	# If link text does not have to be different from the name of landing page, will be better to embed all this code into <code><nowiki><tvar></nowiki></code>.		# If link text does not have to be different from the name of landing page, will be better to embed all this code into <code><nowiki><tvar></nowiki></code>.
	#: 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>.		#: 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>.

			== Source ==
			Code taken from [https://www.mediawiki.org/wiki/Template:Localized_link Mediawiki - Template:Localized_link]

	== See also ==		== See also ==

Goraf: +{{Uncategorized}}

2017-12-11T18:05:59Z

+{{Uncategorized}}

← Older revision		Revision as of 21:05, 11 December 2017
Line 1:		Line 1:
	{{Documentation subpage}}		{{Documentation subpage}}
			<includeonly>
			<!-- Add categories at the bottom and then remove this includeonly block -->
			{{Uncategorized}}
			</includeonly>

	== Purpose ==		== Purpose ==

Goraf: initial copy

2017-12-11T18:05:43Z

initial copy

New page

{{Documentation subpage}}

== 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": "Page name",
"type": "wiki-page-name",
"required": true,
"suggested": true
},
"2": {
"aliases": [
"Custom label"
],
"type": "string",
"default": "Display title of linked page in the current page's language"
}
},
"description": "Link to translatable page in the user's language. It uses the special page prefix \"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><tvar|id>...</></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><translation>some text</translation> <nowiki>{{ll|Communication|<translation>About communication</translation>}}</nowiki> <translation>some text</translation></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 <code><nowiki><tvar></nowiki></code>.
#: 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}}
<includeonly>


</includeonly>