Template:Ru

From Safer nicotine wiki
Jump to navigation Jump to search
Русский⧼Colon⧽ abc

Adds "
Русский⧼Colon⧽
" in front of the text written in Russian. Also adds machine-readable tags identifying the text as being written in Russian.

The template automatically sets the following categories:

Usage

{{ru |1= }}

Template parameters

ParameterDescriptionDefaultStatus
1textText to be displayed. Please prepend "1=" to the text, otherwise any free "=" characters in the text will break the template.**error**required
inlineinlineOptional, default is empty string. When set to any value different from an empty string, 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)emptyoptional
Button text
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Adds "русский" in front of the text written in Russian. Also adds machine-readable tags identifying the text as being written in Russian.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
text1

Text to be displayed.

Default
<span style="color: red;">**error**</span>
Stringrequired
inlineinline

Optional, default is empty string. When set to any value different from an empty string, 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)

Lineoptional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Relies on:

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, no parameter #1 can be detected, and the error "parameter #1 is empty" is categorized.
  • As another error, a superflous pipe "|" character converts it to the contrary:
  • while e.g. {{en | some text | }} will be understood,
  • {{en |1=some text | }} causes the same error "parameter #1 is empty".

Required or necessary

When a parameter is required the template documentation expresses it with a line in the table, which left column shows the parameter name, then a textual description for the parameter value, and right the code (in this case) "required".

  • A named parameter needs to be specified by name=, 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 only when) the parameter value string contains a "free equal sign" (an equal sign outside of another template).
    The positional number is also necessary when positional parameters are specified outside of their positional order, e.g. |2= |1= |3=

Example

{{ru|Abcdefghijklmnopqrstuwxyz}}

renders as:

Русский⧼Colon⧽ Abcdefghijklmnopqrstuwxyz

⧼Seealso⧽

Localization

This template is not intended to be localized.

It relies on {{#language:...}} parser function for localization.

Other multi-lingual templates

Help for choosing the right template for your use case:
I18n templates: {{Multilingual description|lang=
|de,en,default=Deutsch/English
|fr=français
|...
}}
{{de|Deutsch}}
{{en|English}}
{{fr|français}}
...
{{LangSwitch|lang=
|de,en,default=Deutsch/English
|fr=français
|...
}}
{{Autotranslate}} {{tnt}}
Recommended use at Categories, galleries File description pages (deprecated, can be safely replaced by {{Multilingual description}}) Small templates, whenever the previous options are not suitable (removes the visual indication of the language before each translated text) Data tables with translated cells or larger templates, when used on pages that do not have language subpages (e.g. not having Main page/en, Main page/de) and where the language displayed will be automatically determined by the language set in user preferences Data tables with translated cells or larger templates, when used on pages that do have language subpages; most of the time these will be pages prepared with the Translate Extension
Requires JavaScript enabled for folding Yes No
Folding can be disabled by user Yes No
Folding is done server-side No Yes
Folding when at least n languages are provided 1 (all translations are shown without folding if the preferred language selected by the user has no matching translation) 4 1
Detection of duplicate, incorrect, or unsupported language codes Yes No Yes Duplicate language codes are impossible by design. Incorrect or unsupported codes are never displayed, but not reported. The Translate extension's interface (if it's used on the translation subpages) doesn't let the user create translations with invalid codes, but other methods (e.g. entering the translation's URL directly) allow it without any warning.
Allows the same translation to be used for several languages Yes No Yes
Supports language fallbacks No Yes No
Collation order of languages (when not folded) Consistent order by native language name, languages grouped by script:
  • LTR scripts: Latin, Latin or Cyrillic, Cyrillic, Greek, other simple LTR alphabets (Armenian, Georgian, etc.), abugidas (North Indian, South Indian, other South-East Asian, etc.), syllabaries (European, American, African, Asian), Korean alphabets (basic Jamos, Hangul including some sinograms), Japanese syllabaries (including some sinograms), sinograms (including some syllabaries)
  • RTL scripts: Hebrew, Arabic, other RTL abjads (Divehi, etc.), RTL syllabaries (N'ko)
As provided by the user in the wikitext (any inconsistent order may be difficult to lookup visually) N/A
Search indexing issues No (all translations are included on the same page, however search results may be less relevant with many languages mixed) Yes (may not index all languages depending on search engines, unless there's a list of links for visiting other languages) Partially (where used; language subpages of templates are indexed) No (translated pages should include a <languages/> navigation bar for visiting other languages)
Page size issues Yes (may exhaust size or time limits in the wiki parser if many languages are included; larger pages to download for all visitors; slower navigation for visitors with slow Internet access; may be costly for visitors with limited data plans) No (only the content for the selected language or a suitable fallback language is present in the generated page)
Contains expensive parser functions No Yes, checks for several translations along the fallback chain until finds a suitable Yes, 2–4 checks per call