Difference between revisions of "Template:Lang-en-XX usage"

From blackwiki
Jump to navigation Jump to search
imported>SMcCandlish
m (link fix)
imported>Trappist the monk
(lua doc;)
Line 1: Line 1:
<div style="float:right; padding:0 1em;">{{navbar|Lang-en-XX usage|plain=y}}</div>
+
{{#invoke:Lang/documentor tool|lang_xx_settings|template={{ROOTPAGENAME}}}}<div style="float:right; padding:0 1em;">{{navbar|Lang-en-XX usage|plain=y}}</div>
 
This template is used to identify (in HTML metadata) that the text enclosed within the template is written in a specific national [[Dialects of the English language|English-language dialect]], and to preface it with a link to the article on that variety.  It is most commonly used:
 
This template is used to identify (in HTML metadata) that the text enclosed within the template is written in a specific national [[Dialects of the English language|English-language dialect]], and to preface it with a link to the article on that variety.  It is most commonly used:
 
*In [[MOS:GLOSSARIES|glossaries]], when presenting two regional variations of a term sharing the same definition (e.g. ''tire'' vs. ''tyre'', ''aluminium'' vs. ''aluminum'')
 
*In [[MOS:GLOSSARIES|glossaries]], when presenting two regional variations of a term sharing the same definition (e.g. ''tire'' vs. ''tyre'', ''aluminium'' vs. ''aluminum'')
Line 10: Line 10:
  
 
Do not use it to indicate a general English example among other-language examples.
 
Do not use it to indicate a general English example among other-language examples.
 +
 +
== Parameters ==
 +
{{#lst:Template:Lang-x/doc/parameters|lang_xx_parameters}}
  
 
===Parameters and examples===
 
===Parameters and examples===
Line 17: Line 20:
 
*{{<includeonly>{{BASEPAGENAME}}</includeonly><noinclude>Lang-en-IE</noinclude>|1={{{1|Sample text.}}} }}
 
*{{<includeonly>{{BASEPAGENAME}}</includeonly><noinclude>Lang-en-IE</noinclude>|1={{{1|Sample text.}}} }}
  
To not link the name again (i.e., because it's already been linked in the same article or same long-article section), use {{para|links|no}} or {{para|links|n}}:
+
To not link the name again (i.e., because it's already been linked in the same article or same long-article section), use {{para|links|no}} or {{para|link|no}}:
  
*{{tlx|<includeonly>{{BASEPAGENAME}}</includeonly><noinclude>Lang-en-IE</noinclude>|1{{=}}{{{1|Sample text.}}}&nbsp;|'''links{{=}}n'''}}<br />
+
*{{tlx|<includeonly>{{BASEPAGENAME}}</includeonly><noinclude>Lang-en-IE</noinclude>|1{{=}}{{{1|Sample text.}}}&nbsp;|'''link{{=}}no'''}}<br />
*{{<includeonly>{{BASEPAGENAME}}</includeonly><noinclude>Lang-en-IE</noinclude>|{{{1|Sample text.}}} |links=n}}<noinclude>
+
*{{<includeonly>{{BASEPAGENAME}}</includeonly><noinclude>Lang-en-IE</noinclude>|{{{1|Sample text.}}} |link=no}}<noinclude>
  
 
{{Documentation}}
 
{{Documentation}}

Revision as of 18:17, 9 December 2017

This template is used to identify (in HTML metadata) that the text enclosed within the template is written in a specific national English-language dialect, and to preface it with a link to the article on that variety. It is most commonly used:

  • In glossaries, when presenting two regional variations of a term sharing the same definition (e.g. tire vs. tyre, aluminium vs. aluminum)
  • When giving alternative names for an article's topic, in the lead section
  • When demonstrating differences between dialectal usages in language articles.

This template does not italicize the output, since English dialects are not foreign languages.

It is never used to mark entire articles or sections of articles as being written in a particular variety of English.

Do not use it to indicate a general English example among other-language examples.

Parameters

{{#lst:Template:Lang-x/doc/parameters|lang_xx_parameters}}

Parameters and examples

Basic usage:

To not link the name again (i.e., because it's already been linked in the same article or same long-article section), use |links=no or |link=no:

  • {{Lang-en-IE|1=Sample text. |link=no}}
  • Irish English: Sample text.
Template documentation[view] [edit] [history] [purge]

Usage

This documentation sub-template is for transclusion in the "Usage" sections of the main templates of Category:English dialect multilingual support templates.

There is one required parameter, the text to use in the examples.

=== Usage ===
{{Lang-en-XX usage|1=Sample of illustratively colloquial text here.}}

Any template-specific further instructions go here.