Template:Internationalization template doc - Revision history

Philip: Created page with "{{Protected}} {{TemplateBox |name = {{lc:{{PAGENAME}}}}En |desc-en = Adds "''{{{{PAGENAME}}En||inline=1}}''" in front of the text written in {{language|{{PAGENAME}}En}}. Also adds machine-readable tags identifying the text as being written in {{language|{{PAGENAME}}
2022-06-23T15:01:05Z

Created page with "<noinclude>{{Protected}}</noinclude> {{TemplateBox |name = <includeonly>{{lc:{{PAGENAME}}}}</includeonly><noinclude>En</noinclude> |desc-en = Adds "''{{<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>|<nowiki />|inline=1}}''" in front of the text written in {{language|<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>}}. Also adds machine-readable tags identifying the text as being written in {{language|<includeonly>{{PAGENAME}}</includeonly..."

New page
<noinclude>{{Protected}}</noinclude>
{{TemplateBox
|name = <includeonly>{{lc:{{PAGENAME}}}}</includeonly><noinclude>En</noinclude>
|desc-en = Adds "''{{<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>|<nowiki />|inline=1}}''" in front of the text written in {{language|<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>}}. Also adds machine-readable tags identifying the text as being written in {{language|<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>}}.
|desc-td-en = Adds "{{#language:<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>}}" in front of the text written in {{language|<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>}}. Also adds machine-readable tags identifying the text as being written in {{language|<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>}}.
|namespace = all
|usergroup = all
|docsub-override = <noinclude>true</noinclude>
|placement =
|mustbesubst =
|relieson =
* {{Tl|description}}

== Parameter #1 ==
* Existing "1=" shall not be removed, even if it is not necessary, see [[Special:Diff/592488152#removing_1=]].
* when no free "="-sign occurs in the text the "1=" is obsolete. Not-free equal signs (inside of template transclusions) don't count.
* without the "1=" but with one or more equal signs, <u>no parameter #1 can be detected</u>, and the error "parameter #1 is empty" is categorized.
* As another error, a ''superflous'' pipe "{{!}}" character converts it to the contrary:
:* while e.g. <code><nowiki>{{en | some text | }}</nowiki></code> will be understood,
:* <code><nowiki>{{en |1=some text | }}</nowiki></code> causes the same error "parameter #1 is empty".
=== Required or necessary ===
When a parameter is <u>required</u> the template documentation expresses it with a line in the table, which left column shows the <code>parameter name</code>, then a textual description for the <code>parameter value</code>, and right the code (in this case) "required".
A named parameter '''needs''' to be specified by <code>name=</code>, which may as well be an alias,
a positional parameter is specified either by its position '''or''' by the positional number (e.g. 1=, 2=, 3=...). With other words: the ''parameter value'' is '''''required''''', the ''parameter name'' (= the number) is ''optional''; it '''cannot be '' required''''' and not even ''suggested'' but it becomes ''necessary'' (another thing than the un/requiredness in the sense of template documentation!) when (and <u>only</u> when) the parameter value string contains a "free equal sign" (an equal sign ''outside'' of another template). <br>The positional number is also necessary when positional parameters are specified ''outside of their positional order'', e.g. {{!}}2= {{!}}1= {{!}}3=

|usage-notes =
|shorthand = {{{shorthand|}}}
|setscats = {{{setscats|}}}
* [[:Category:Language templates with no text displayed]] (if parameter #1 is [[#Parameter #1|empty]])
|seealso =
* [[Commons:Localization]]
* <code>{{[[mw:Help:Magic_words#Miscellaneous|#language]]}}</code> - Returns the local language name of a language code.
* {{tl|language}} - Returns the translated language name of a language code.
|type = formatting
|i18n-desc = It relies on [[mw:Help:Magic_words#Miscellaneous|<nowiki>{{#language:...}}</nowiki>]] parser function for localization.
|i18n-subpage =
|i18n-mediawiki-msg =
|i18n-method = -
|example = Abcdefghijklmnopqrstuwxyz
|example-value = {{<includeonly>{{PAGENAME}}</includeonly><noinclude>En</noinclude>|Abcdefghijklmnopqrstuwxyz}}
|print = one
|useTemplateData = 1

|1 = 1
|1label = text
|1d-en = Text to be displayed. Please prepend "1=" to the text, otherwise any free "=" characters in the text will [[#Parameter #1|break the template]].
|1d-td-en = Text to be displayed. 
|1type = string
|1default=<span class="error">(missing text)</span>
|1stat = required

|2 = inline
|2label = inline
|2d-en = Optional boolean flag, false by default. When set to "true" (or "1", "t", "yes", "y", "on", etc. ), forces the template to be displayed inline, so that it does not break the current paragraph (that makes possible to put several descriptions side by side on a single line). Set to "false" (or "0", "f", "no", "n", "off", etc. ) or omit or leave blank, and each language will be in a separate line.
|2type = line
|2stat = optional-

}}

== {{LangSwitch
|en=Other multi-lingual templates
|pl=Inne szablony multi-języczne
}} ==
{{I18n templates}}

<includeonly>
{{{localcat|{{#ifexist:Category:Commons-{{lc:{{BASEPAGENAME}}}}|[[Category:Commons-{{lc:{{BASEPAGENAME}}}}|{{PAGENAME}}]]}}}}}
{{#ifeq:{{lc:{{#titleparts:{{{{uc:{{{b|}}}}}PAGENAME}}|-{{{m|1}}}}}/sandbox}}|{{lc:{{{{uc:{{{b|}}}}}PAGENAME}}}}|[[Category:Language templates| ]]|{{#ifeq:{{PAGENAME}}|Unknown language|[[Category:Language templates| ]]|[[Category:Language templates|{{PAGENAME}}]]}}}}
</includeonly>
<noinclude>
[[Category:Template namespace templates|{{PAGENAME}}]]
[[Category:Internationalization templates|{{PAGENAME}}]]
[[Category:Multi-template documentation|{{PAGENAME}}]]
</noinclude>