Template:Native name/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
meta>CsDix
corrected/updated annotated code
Ookami (talk | contribs)
1,664 edits
m 61 revisions imported
 
(40 intermediate revisions by 15 users not shown)
Line 1: Line 1:
<noinclude>{{documentation subpage}}</noinclude>
<noinclude>{{Documentation subpage}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<!----EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE---->
Convenience template to indicate what language a native name of a place (like that of a country or town) belongs to, appending the language name in an icon. Uses {{tl|lang}} and {{tl|language icon}}. It makes the native name appear in italics by default, although this can be overridden, as can the language icon be excluded. Therefore, the template may make no visible changes to the text, but it does add a ''[[Span and div|span]]'' tag with ''language attributes'' around the native name to the page's source code, which can help web browsers choose the right font, screen readers use the right pronunciation and more.
{{lua|Module:Lang}}
An inline formatting template, based on {{tl|lang}}, for indicating the language in which a native name has been given. By default, the native name is displayed in italics, followed by the language's name in parentheses. For example:
: {{native name{{\sandbox}}|de|Deutschland}}


==Usage==
The template's defaults can be overridden and the parenthesis excluded, in which case there may be no visible changes to the text where it's used. An [[HTML]] ''[[Span and div|span]]'', however, still identifies the native name as a linguistic element, meaning that web browsers and [[screen reader]]s can select a particular font, formatting, pronunciation, etc., for it.
{{Pre|{{((}}native name{{!}}''language tag''{{!}}''text''[{{!}}icon{{=}}''no''][{{!}}italic{{=}}''no'']{{))}}}}
:('<tt>[...]</tt>' means 'optional', do not include the square brackets when using this template)
where
*''language tag'' is the code for the native language (see the [[list of ISO 639 codes]]);
*''text'' is the native name;
*<tt>icon</tt> is an optional parameter to exclude the language icon by setting the value to "no";
*<tt>italic</tt> is an optional parameter to prevent the name from appearing in italics by setting the value to "no".


==Examples==
== Syntax ==
{{Pre|{{((}}Infobox settlement<br />
&nbsp;{{!}}name{{=}}The Hague<br />
&nbsp;{{!}}native_name{{=}}'''{{((}}native name{{!}}nl{{!}}Den Haag{{))}}'''<br />
{{))}}}}


results in
; Common
: {{tc|native name|<{{var|[[IETF language tag]]}}>|<{{var|the native name}}>}}


<table class="infobox geography vcard" style="width:23em; text-align:left; float:left; clear:both;">
The code for the example at the start of this documentation would, therefore, be:
<tr>
: <code><nowiki>{{native name|de|Deutschland}}</nowiki></code>
<th colspan="2" style="width:100%; text-align:center; font-size:1.25em; white-space:nowrap"><span class="fn org">The Hague</span><br />
<span class="nickname">{{native name|nl|Den Haag}}</span></th>
</tr>
</table>


<p style="clear:both">while</p>
== Parameters ==


{{Pre|{{((}}Infobox settlement<br />
Required parameters shown in '''''bold italics'''''.
&nbsp;{{!}}name{{=}}French Republic<br />
&nbsp;{{!}}native_name{{=}}'''{{((}}native name{{!}}fr{{!}}République française{{!}}icon{{=}}no{{))}}'''<br />
{{))}}}}


results in
{| class="wikitable sortable" style="cellpadding:0.2em;text-align:left;line-height:1.3em;"
! Parameter name
! Description and example/s
|-
| '''''[first unnamed]'''''
| The [[IETF language tag]] code for the native language. French, for instance, is "fr"; Spanish is "es"; Arabic is "ar"; etc.
|-
|style="white-space:nowrap;"| '''''[second unnamed]'''''
| The native name, in the native language (with accents, etc.).
|-
| ''italics''<br/>{{smaller|(or ''italic'')}}
| Set to "off" or "no" to disable displaying the native name in italics.
: {{para|italics|off}}
|-
| ''paren''<br/>{{smaller|(or ''icon'')}}
| Set to "omit", "off" or "no" to suppress the appearance of the native language's name in a parenthesis after the native name.
: {{para|paren|omit}}
|-
| ''nbsp''
| Set to "omit" or "no" to suppress the addition of a second space between the native name and the native language's name in brackets.<br/>Generally works in tandem with the ''italics'' or ''italic'' and/or ''paren'' or ''icon'' switches, as the automatic addition of the second<br/>space prevents the native name in italics from appearing to lean into the following bracket.
: {{para|nbsp|omit}}
|-
| ''parensize''<br/>{{smaller|(previously ''fontsize'')}}
| Use to specify a font-size for the parenthesis. Per [[MOS:FONTSIZE]], do not make this text smaller in infoboxes, since the text is already at 88% of normal.
: {{para|parensize|90%}}
|-
| ''nolink''
| Set to anything (e.g. "on") to suppress the appearance of the native language's name as a link.
|-
| ''script'' (deprecated)
| when needed, include [[ISO 15924]] in <code><nowiki>{{{1}}}</nowiki></code> IETF language tag; e.g. 'sr-Cyrl' <s>Specifies the [[ISO 15924]] script. E.g. "Cyrl", "Arab", "Hans"...</s>
|}


<table class="infobox geography vcard" style="width: 22em; font-size: 88%; float: left; clear: both;">
; More complex examples
<tr class="adr">
Code and result for the same name "Deutschland" above but with ''italics'' and ''nbsp'' switched off, ''nolink'' switched on and a ''parensize'' of 90%:
<th colspan="3" align="center" class="mergedtoprow" style="line-height:1.2em; padding:0.25em 0.33em 0.33em; font-size:1.25em;"><span class="fn org country-name">French Republic</span>
: <code><nowiki>{{native name|de|Deutschland|italics=off|nbsp=omit|nolink=on|parensize=90%}}</nowiki></code>
<div style="padding-top:0.25em;">{{native name|fr|République française|icon=no}}</div>
: {{native name{{\sandbox}}|de|Deutschland|italics=off|nbsp=omit|nolink=on|parensize=90%}}
</th>
</tr>
</table>


<p style="clear:both">&nbsp;</p>
Retaining no italics but suppressing the parenthesis:
: <code><nowiki>{{native name|de|Deutschland|italics=off|paren=omit}}</nowiki></code>
: {{native name{{\sandbox}}|de|Deutschland|italics=off|paren=omit}}
This result is the same as if the {{tl|lang}} template had been used.


===Note===
== Other examples ==
When both the <tt>icon</tt> and <tt>italic</tt> parameters are set to "no" this template is equivalent to the {{tl|lang}} template.


== Annotated code ==
{| class="wikitable"
 
! Code !! Result
<pre style="overflow:auto;">
|-
                              width 80 characters
| <pre>
--------------------------------------------------------------------------------
{{Infobox settlement
 
| name = The Hague
{{lang |{{{1}}}                                                      <!--[a]-->
| native_name = {{native name|nl|Den Haag}}
|<!---->{{#ifeq:{{{italics|{{{italic|}}}}}}|no||''}}<!--
}}
      -->{{{2}}}<!--                                                  <!--[b]-->
</pre>
      -->{{#ifeq:{{{italics|{{{italic|}}}}}}|no||''}}
|style="vertical-align:middle;"|
}}<!--
{{Infobox settlement
-->{{#ifeq:{{{paren|{{{icon|}}}}}}|no |                              <!--[c]-->
| name = The Hague
    |&#38;nbsp;{{#ifeq:{{{italic|}}}|no |                                <!--[d]-->
| native_name = {{native name{{\sandbox}}|nl|Den Haag}}
            |{{#ifeq:{{{nbsp|}}}|no |                                <!--[e]-->
}}
              |&#38;nbsp;}}<!--
|-
          -->}}<!--
| <pre>
  --><span class="languageicon"
{{Infobox country
          style="font-size:{{{fontsize|90%}}};font-weight:normal;"><!--
| conventional_long_name = French Republic
    -->{{#if:{{{nolink|}}} |({{ISO 639 name|{{{1}}}}})                <!--[f]-->
| native_name = {{native name|fr|République française|paren=omit}}
        | {{#ifexist:Template:ISO 639 name {{{1}}}                    <!--[g]-->
}}
          |([[{{ISO 639 name|{{{1}}}}} language|{{ISO 639 name|{{{1}}}}}]])
          |(language?)<!--                                          <!--[h]-->
      -->}}<!--
    -->}}<!--
  --></span><!--
-->}}
 
 
--------------------------------------------------------------------------------
Legend
[a] {{{1}}} = ISO 639 language code.
[b] {{{2}}} = the foreign-language placename. Displayed in italics unless
                                                        italics or italic = no.
[c] If icon or paren=no, omit following linked language name (in brackets).
[d] If placename in italics,
[e] then, unless nbsp=no, add an extra space after it (to stop the italics
                                    leaning into the parenthesis that follows).
[f] If nolink set, display unlinked language name,
[g] else if a link for this language name exists, display it as
            "[[(name) language|(name)]]" (e.g. "([[French language|French]])"),
[h] else return the error query "(language?)".
</pre>
</pre>
|style="vertical-align:topmiddle;"|
{{Infobox country
| conventional_long_name = French Republic
| native_name = {{native name{{\sandbox}}|fr|République française|paren=omit}}
}}
|}


<includeonly>{{Sandbox other||
[[Category:Wikipedia formatting and function templates]]


<includeonly>
[[bn:টেমপ্লেট:Native name]]
[[Category:Wikipedia formatting and function templates|{{PAGENAME}}]]
[[mk:Шаблон:Изворно име]]
 
}}</includeonly>
</includeonly>

Latest revision as of 22:54, 3 September 2020

An inline formatting template, based on {{lang}}, for indicating the language in which a native name has been given. By default, the native name is displayed in italics, followed by the language's name in parentheses. For example:

Deutschland  (German)

The template's defaults can be overridden and the parenthesis excluded, in which case there may be no visible changes to the text where it's used. An HTML span, however, still identifies the native name as a linguistic element, meaning that web browsers and screen readers can select a particular font, formatting, pronunciation, etc., for it.

Syntax

Common
{{native name|<IETF language tag>|<the native name>}}

The code for the example at the start of this documentation would, therefore, be:

{{native name|de|Deutschland}}

Parameters

Required parameters shown in bold italics.

Parameter name Description and example/s
[first unnamed] The IETF language tag code for the native language. French, for instance, is "fr"; Spanish is "es"; Arabic is "ar"; etc.
[second unnamed] The native name, in the native language (with accents, etc.).
italics
(or italic) 		Set to "off" or "no" to disable displaying the native name in italics.
|italics=off
paren
(or icon) 		Set to "omit", "off" or "no" to suppress the appearance of the native language's name in a parenthesis after the native name.
|paren=omit
nbsp Set to "omit" or "no" to suppress the addition of a second space between the native name and the native language's name in brackets.
Generally works in tandem with the italics or italic and/or paren or icon switches, as the automatic addition of the second
space prevents the native name in italics from appearing to lean into the following bracket.
|nbsp=omit
parensize
(previously fontsize) 		Use to specify a font-size for the parenthesis. Per MOS:FONTSIZE, do not make this text smaller in infoboxes, since the text is already at 88% of normal.
|parensize=90%
nolink Set to anything (e.g. "on") to suppress the appearance of the native language's name as a link.
script (deprecated) when needed, include ISO 15924 in {{{1}}} IETF language tag; e.g. 'sr-Cyrl' Specifies the ISO 15924 script. E.g. "Cyrl", "Arab", "Hans"...
More complex examples

Code and result for the same name "Deutschland" above but with italics and nbsp switched off, nolink switched on and a parensize of 90%:

{{native name|de|Deutschland|italics=off|nbsp=omit|nolink=on|parensize=90%}}
Deutschland (German)

Retaining no italics but suppressing the parenthesis:

{{native name|de|Deutschland|italics=off|paren=omit}}
Deutschland

This result is the same as if the {{lang}} template had been used.

Other examples

Code Result 
{{Infobox settlement
| name = The Hague
| native_name = {{native name|nl|Den Haag}}
}}
Script error: No such module "Settlement short description".
The Hague

Den Haag  (Dutch)
{{Infobox country
| conventional_long_name = French Republic
| native_name = {{native name|fr|République française|paren=omit}}
}}
République française
French Republic


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Native_name/doc&oldid=117092"