Template:Lang links cheap

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:Lang links cheap/doc.

This template provides a cheaper version of {{Lang links}}, using Special:PrefixIndex instead of individually checking each translation. Its advantage is that it doesn’t use hundreds of expensive parser functions. However, it has several disadvantages:

  • The special page is not expensive because it provides less guarantees for up-to-date output and/or it disables caching (which means slower page loading).
  • It lists all subpages, not only translations. For MediaWiki messages and templates’ /i18n subpages it shouldn’t be a problem, as non-translation subpages are unlikely to exist, but for example templates with translations on direct subpages would show the /doc subpage as well.
  • Language codes are used instead of language names, which is not very user-friendly.

Use this only if you absolutely need to.

Usage

{{Lang links cheap |1= }}

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

This template provides a cheaper version of {{lang links}}, using Special:PrefixIndex instead of individually checking each translation. Its advantage is that it doesn’t use hundreds of expensive parser functions. However, it has several disadvantages:

  • The special page is not expensive because it provides less guarantees for up-to-date output and/or it disables caching (which means slower page loading).
  • It lists all subpages, not only translations. For MediaWiki messages and templates’ /i18n subpages it shouldn’t be a problem, as non-translation subpages are unlikely to exist, but for example templates with translations on direct subpages would show the /doc subpage as well.
  • Language codes are used instead of language names, which is not very user-friendly.
Use this only if you absolutely need to.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
base title1

Title of the page whose translations should be listed, with namespace

Page namerequired

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Example

{{Lang links cheap|Template:Welcome/i18n}}

renders as:

Localization

This template is not intended to be localized.