Template:Lang-x/doc: Difference between revisions

Latest revision as of 04:42, 3 September 2020

This is a documentation subpage for multiple templates located in Category:Lang-x templates.
It may contain usage information, categories and other content that is not part of the original template page.

This template should not be substituted.

This template uses Lua:

Module:lang

Usage

Lua error in Module:Lang/documentor_tool at line 29: attempt to index local 'content' (a nil value). The language template {{lang-x}} identifies foreign language text. The term or phrase is the only mandatory parameter. The text is formatted according to recommendations in Wikipedia:Manual of Style/Text formatting § Foreign terms; italics for languages that use the Latin alphabet, normal for others.

The template should generally be placed after the English translation of the foreign term or phrase.

The parameter |links=no prevents the language name from being linked.

The parameter |translit= allows for a Romanization to be identified. The templates that have this parameter are listed here. (This parameter is not supported by lang-x templates for languages that are already written in Latin script.)

The parameter |lit= enables a literal translation (in English) to be given. It is being rolled out to these templates and so may be available for {{lang-x}}.

Parameters

Examples

The following examples show translations from German.

Edit

Weimar is located in the federal state of Thuringia ({{lang-de|Thüringen}}).
The Seafarers of Catan ({{lang-de|Die Seefahrer von Catan}}) is an expansion of the board game The Settlers of Catan.
Albert the Bear ({{lang-de|Albrecht der Bär|links=no}})
All Quiet on the Western Front ({{lang-de|Im Westen nichts Neues|lit=In the West Nothing New}}) is a novel by Erich Maria Remarque.

Resulting text

Weimar is located in the federal state of Thuringia (German: Thüringen).
The Seafarers of Catan (German: Die Seefahrer von Catan) is an expansion of the board game The Settlers of Catan.
Albert the Bear (German: Albrecht der Bär)
All Quiet on the Western Front (German: Im Westen nichts Neues, lit. 'In the West Nothing New') is a novel by Erich Maria Remarque.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Lang-x

Indicates to readers the original form of a term or phrase in a foreign language.

Template parameters
Parameter		Description	Type	Status
Text	`1`	The foreign text to display.	String	required
Display link	`links`	Set to 'no' to disable the link to the article's language.	Boolean	optional
Literal translation	`lit`	The literal translation of the foreign text.	String	optional
Transliteration	`translit`	The transliteration of the foreign text, for languages that do not use the Latin alphabet. This field is ignored for languages that do use the Latin alphabet.	String	optional
Language label	`label`	If 'none', suppresses language link and label. Other options may be available depending on the language. Example none	Line	optional

@@ Line 1: / Line 1: @@
-{{Documentation subpage}}
+__NOEDITSECTION__{{Documentation subpage|multiple templates located in [[:Category:Lang-x templates]]}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+{{COinS safe|n}}
+{{No subst}}
+{{#if:{{#invoke:Lang/documentor tool|uses_module|template={{ROOTPAGENAME}}}}|{{lua|Module:lang}}}}
+<!--NOTE: This template is also used as documentation for multiple Language-x templates in Category:Language icon templates-->
-=== Usage ===
+== Usage ==
-{{tl|{{PAGENAME}}}} is a template usually used to indicate to readers that the previous term or phrase is ''translated from'' a foreign language; one parameter is available and necessary, that being the ''English translation'' of the foreign language.
+{{#invoke:Lang/documentor tool|lang_xx_settings|template={{ROOTPAGENAME}}}}
+The language template {{Tlf|'''{{lcfirst:{{BASEPAGENAME}}}}'''|nolink=yes}} identifies {{#ifeq:{{FULLPAGENAME}}|Template:Lang-x/doc|foreign language|{{#invoke:Lang|name_from_tag|link=yes|{{#invoke:String|sub|{{ROOTPAGENAME}}|6}}}}}} text. The term or phrase is the only mandatory parameter. The text is formatted according to recommendations in {{section link|Wikipedia:Manual of Style/Text formatting#Foreign terms}}; italics for languages that use the [[Latin alphabet]]<!-- Not the same thing as Romance languages and Latinate languages-->, normal for others.
-It should generally be placed after the English translation of the foreign term or phrase, and contain the foreign term or phrase.
+The template should generally be placed after the English translation of the foreign term or phrase.
-=== Example ===
+The parameter <!--Not implemented in all templates yet! {{Para|link|no}} (or {{Para|links|no}})--> {{Para|links|no}} prevents the language name from being linked.
-;Edit
+The parameter {{Para|translit}} allows for a [[Romanization]] to be identified. The templates that have this parameter are <span class="plainlinks">[//en.wikipedia.org/w/index.php?title=Special:WhatLinksHere/Template:Language_with_name_and_transliteration&namespace=10&limit=500&hidelinks=1 listed here]</span>. (This parameter is not supported by <code>lang-{{var|x}}</code> templates for languages that are already written in Latin script.)
-* <nowiki>Weimar is located in the federal state of Thuringia ({{lang-de|Thüringen}})</nowiki>
-* <nowiki>The Seafarers of Catan ({{lang-de|Die Seefahrer von Catan}}) is an expansion of the board game ''[[The Settlers of Catan]]''</nowiki>.
-;Resulting text
+The parameter {{Para|lit}} enables a literal translation (in English) to be given. It [[Template talk:Language with name#Suggestion: An optional literal translation|is being rolled out]] to these templates and so may be available for {{Tlf|{{lcfirst:{{BASEPAGENAME}}}}|nolink=yes}}.
-*Weimar is located in the federal state of Thuringia ({{lang-de|Thüringen}})
+{{#if:{{#invoke:Lang/documentor tool|uses_module|template={{ROOTPAGENAME}}}}|
-*The Seafarers of Catan ({{lang-de|Die Seefahrer von Catan}}) is an expansion of the board game ''[[The Settlers of Catan]]''.
+== Parameters ==
+{{#lst:Template:Lang-x/doc/parameters|lang_xx_parameters}}
+}}
-=== See also ===
+== Examples ==
-* {{tl|X icon}}
+The following examples show translations from German.
-<includeonly>
+'''Edit'''
-<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+* Weimar is located in the federal state of Thuringia (<code><nowiki>{{lang-de|Thüringen}}</nowiki></code>).
+* The Seafarers of Catan (<code><nowiki>{{lang-de|Die Seefahrer von Catan}}</nowiki></code>) is an expansion of the board game ''[[The Settlers of Catan]]''.
+* Albert the Bear (<code><nowiki>{{lang-de|Albrecht der Bär|links=no}}</nowiki></code>)
+*''All Quiet on the Western Front'' (<code><nowiki>{{lang-de|Im Westen nichts Neues|lit=In the West Nothing New}}</nowiki></code>) is a novel by [[Erich Maria Remarque]].
-</includeonly>
+'''Resulting text'''
+* Weimar is located in the federal state of Thuringia ({{lang-de|Thüringen}}).
+* The Seafarers of Catan ({{lang-de|Die Seefahrer von Catan}}) is an expansion of the board game ''[[The Settlers of Catan]]''.
+* Albert the Bear ({{lang-de|Albrecht der Bär|links=no}})
+* ''All Quiet on the Western Front'' ({{lang-de|Im Westen nichts Neues|lit=In the West Nothing New}}) is a novel by [[Erich Maria Remarque]].
+{{#if:{{{category|}}}{{{tracking-category|}}}|
+== Category ==
+{{#if:{{{category|}}}|Articles using this template are automatically placed in {{Clc|{{{category}}}}}.|}}
+{{#if:{{{tracking-category|}}}|
+=== Tracking categories ===
+* {{Clc|{{{tracking-category}}}}}
+|}}<!-- /tracking-category -->
+|}}<!-- /category OR tracking-category -->
+{{#if:{{#invoke:Lang/documentor tool|uses_module|template={{ROOTPAGENAME}}}}||
+== Supporting templates ==<!-- render 'Supporting template' section only for those {{tld|lang-??}} templates that do not use [[Module:lang]] -->
+This template may use one of the following templates:
+* {{Tl|Language with name}}
+* {{Tl|Language with name2}}
+* {{Tl|Language with name and transliteration}}
+* {{Tl|Language family with name}}
+All of the above use {{Tl|Lang}}
+}}
+== TemplateData ==
+{{TemplateData header}}
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Text",
+			"description": "The foreign text to display.",
+			"type": "string",
+			"required": true
+		},
+		"links": {
+			"label": "Display link",
+			"description": "Set to 'no' to disable the link to the article's language.",
+			"type": "boolean"
+		},
+		"lit": {
+			"label": "Literal translation",
+			"description": "The literal translation of the foreign text.",
+			"type": "string"
+		},
+		"translit": {
+			"label": "Transliteration",
+			"description": "The transliteration of the foreign text, for languages that do not use the Latin alphabet. This field is ignored for languages that do use the Latin alphabet.",
+			"type": "string"
+		},
+		"label": {
+			"label": "Language label",
+			"description": "If 'none', suppresses language link and label. Other options may be available depending on the language.",
+			"example": "none",
+			"type": "line"
+		}
+	},
+	"description": "Indicates to readers the original form of a term or phrase in a foreign language.",
+	"paramOrder": [
+		"1",
+		"links",
+		"lit",
+		"translit",
+		"label"
+	]
+}
+</templatedata>
+== See also ==
+* {{Tl|Lang}}
+* {{Tl|Language with name/for}}
+* [[List of ISO 639-1 codes]] (language codes)
+<includeonly>{{Sandbox other||
+<!-- CATEGORIES (which are not already covered in the individual lang-x templates) HERE, THANKS -->
+{{#ifeq:0
+|{{#ifexist:ISO 639:{{Str right|{{BASEPAGENAME}}|5}}|0|1}}
+|[[Category:Lang-x templates|{{#invoke:String|match|{{FULLPAGENAME}}|Template:Lang%-([a-z%-]+)$|nomatch=}}]]
+|{{#if:{{#invoke:Lang/documentor tool|uses_module|template={{ROOTPAGENAME}}}}|[[Category:Lang-x templates|{{#invoke:String|match|{{FULLPAGENAME}}|Template:Lang%-([a-z%-]+)$|nomatch=}}]]|[[Category:Lang-x templates with other than ISO 639]]}}
+}}
+}}</includeonly>
+<noinclude>[[Category:Documentation shared content templates]]</noinclude>

Template:Lang-x/doc: Difference between revisions

Latest revision as of 04:42, 3 September 2020

Contents

Usage

Parameters

Examples

TemplateData

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages