Difference between revisions of "Template:Lang-x/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
 
(55 intermediate revisions by 21 users not shown)
Line 1: Line 1:
{{Documentation subpage|[[:Category:Lang-x templates]]}}
+
__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}}
 
{{COinS safe|n}}
 +
{{No subst}}
 +
<noinclude>{{Lua|Module:Lang/documentor tool}}</noinclude>
 +
{{#if:{{#invoke:Lang/documentor tool|uses_module|template={{ROOTPAGENAME}}}}|{{Lua|Module:Lang}}}}
  
 
== Usage ==
 
== Usage ==
Template {{Tlf|'''{{lcfirst:{{BASEPAGENAME}}}}'''|nolink=yes}} indicates to readers the original form of a term or phrase in {{#ifeq:{{FULLPAGENAME}}|Template:Lang-x/doc|a foreign|[[{{ISO 639 name {{lcfirst:{{Str right|{{BASEPAGENAME}}|5}}}}}} language|{{ISO 639 name {{lcfirst:{{Str right|{{BASEPAGENAME}}|5}}}}}}]]}} language. 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 Latin-script languages, regular for others).
+
{{#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.
  
The template should generally be placed after the English translation of the foreign term or phrase.  
+
The template should generally be placed after the English translation of the foreign term or phrase.
  
 
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.
 
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.
  
The parameter {{Para|lit}} enables a literal translation 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}}.
+
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.)
 +
 
 +
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}}.
 +
{{#if:{{#invoke:Lang/documentor tool|uses_module|template={{ROOTPAGENAME}}}}|
 +
== Parameters ==
 +
{{#lst:Template:Lang-x/doc/parameters|lang_xx_parameters}}
 +
}}
  
 
== Examples ==
 
== Examples ==
Line 16: Line 25:
  
 
'''Edit'''
 
'''Edit'''
* Weimar is located in the federal state of Thuringia (<code><nowiki>{{lang-de|Thüringen}}</nowiki></code>).
+
* 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]]''.
+
* 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>)
+
* 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]].
+
*''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]].
  
 
'''Resulting text'''
 
'''Resulting text'''
* Weimar is located in the federal state of Thuringia ({{lang-de|Thüringen}}).
+
* 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]]''.
+
* 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}})
+
* 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]].
+
* ''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 {{Category link with count|{{{category}}}}}.|}}
 +
{{#if:{{{tracking-category|}}}|
 +
=== Tracking categories ===
 +
* {{Category link with count|{{{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 name and transliteration}}
 +
* {{Tl|Language family with name}}
 +
All of the above use {{Tl|Lang}}
 +
}}
  
== See also ==
+
== TemplateData ==
* {{Tl|lang}}, and its opposite, {{Tl|Language with name/for}}
+
{{TemplateData header}}
* {{Tl|link language}}
 
* {{Tl|{{#ifeq:0
 
|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{#ifeq:0|{{#ifexist:ISO 639:{{Str right|{{BASEPAGENAME}}|5}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|1}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|2}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|3}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|4}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|5}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|6}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|7}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|8}}}}|0|1}}
 
|{{Str right|{{BASEPAGENAME}}|5}}
 
|{{Str crop|{{Str right|{{BASEPAGENAME}}|5}}|9}}
 
}} icon}}
 
 
 
{{TemplateDataHeader}}
 
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 64: Line 65:
 
"links": {
 
"links": {
 
"label": "Display link",
 
"label": "Display link",
"description": "Set to no to disable the link to the article's language.",
+
"description": "Set to 'no' to disable the link to the article's language.",
 
"type": "boolean"
 
"type": "boolean"
 
},
 
},
 
"lit": {
 
"lit": {
"label": "Literal translation"
+
"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."
+
"description": "Indicates to readers the original form of a term or phrase in a foreign language.",
 +
"paramOrder": [
 +
"1",
 +
"links",
 +
"lit",
 +
"translit",
 +
"label"
 +
]
 
}
 
}
 
</templatedata>
 
</templatedata>
  
<includeonly>
+
== 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 -->
 
<!-- CATEGORIES (which are not already covered in the individual lang-x templates) HERE, THANKS -->
 
{{#ifeq:0
 
{{#ifeq:0
 
|{{#ifexist:ISO 639:{{Str right|{{BASEPAGENAME}}|5}}|0|1}}
 
|{{#ifexist:ISO 639:{{Str right|{{BASEPAGENAME}}|5}}|0|1}}
|[[Category:Lang-x templates]]
+
|[[Category:Lang-x templates|{{#invoke:String|match|{{FULLPAGENAME}}|Template:Lang%-([a-z%-]+)$|nomatch=}}]]
|[[Category:Lang-x templates with other than ISO 639]]
+
|{{#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>
+
}}</includeonly>  
<noinclude>[[Category:Documentation shared content templates]]</noinclude>
+
<noinclude>{{sandbox other||[[Category:Documentation shared content templates]]}}</noinclude>

Latest revision as of 11:13, 20 February 2021

Template:No subst


Usage

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 Script error: No such module "Section link".; 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}}.


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.

Supporting templates

This template may use one of the following templates:

All of the above use {{Lang}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Lang-x

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

Template parameters

ParameterDescriptionTypeStatus
Text1

The foreign text to display.

Stringrequired
Display linklinks

Set to 'no' to disable the link to the article's language.

Booleanoptional
Literal translationlit

The literal translation of the foreign text.

Stringoptional
Transliterationtranslit

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.

Stringoptional
Language labellabel

If 'none', suppresses language link and label. Other options may be available depending on the language.

Example
none
Lineoptional

See also