Template:uxi/documentation

Definition from Wiktionary, the free dictionary
Jump to navigation Jump to search
Edit-copy green.svg Documentation for Template:uxi. [edit]
This page contains usage information, categories, interwiki links and other content describing the template.

This is used to show inline usage examples (not quotations) following a definition line. The actual work is delegated to Module:usex/templates and Module:usex. See WT:USEX for some general guidelines regarding usage examples.

The template call {{uxi|...}} works identically to {{ux|....|inline=1}}. It is intended for usage examples that are short enough that the example, its transliteration (if needed) and any idiomatic or literal translations can all fit on a single line, separated by em dashes.

Parameters[edit]

|1=
The language code of the example to be shown, e.g. en for English; see WT:LANGLIST for the full list.
|2=
The example to be shown. It should not contain wikilinks.
|3=, |translation= or |t=
The English translation for examples on foreign entries.
|tr= or |transliteration=
The Latin transliteration for examples in non-Latin script.
|sc=
The script code, required for certain languages with multiple possible scripts; see Wiktionary:List of scripts for the full list.
|q=, |qN= or |qualifier=, |qualifierN=
To include a qualifier for the example. You can specify multiple qualifiers using q2=, q3=, etc.
|ref=
To include a reference or link to an originating external site.
|lit=
A literal translation.
|subst=, |substN=
Substitutions to be applied to handle irregular transliterations in certain languages (e.g. Russian and Yiddish; see example below). You can specify multiple substitutions to be applied using subst2=, subst3=, etc. Each substitution expression is of the form FROM/TO, where FROM is a Lua pattern and TO is the corresponding replacement expression (see WT:LUA). The substitutions are applied in order and before transliteration; hence both FROM and TO should be in the source script (e.g. Cyrillic or Hebrew).
|noenum=
To use in unnumbered sections (not following a definition). It may start the line following the definition or may be prefixed by "#:" for visual aesthetics.

Usage examples are normally preceded by "#:", or by "#*" or "#*:" to hide the usage example (normally used for direct quotes).

Examples[edit]

Wikitext (from Tajik китоб (kitob))

# [[book]]
#: {{uxi|tg|Ин '''китобро''' хондам.|I read this '''book'''.}}

Output

  1. book
    Ин китобро хондам.In kitobro xondam.I read this book.


Wikitext (from Esperanto indiki)

# to [[indicate]]
#: {{uxi|eo|La forta vento '''indikas''' ke ŝtormo venas.|The strong wind '''indicates''' that 
a storm is coming.|ref=<ref>http://tatoeba.org/eng/sentences/show/454290</ref>}}

===References===
<references/>

Output

  1. to indicate
    La forta vento indikas ke ŝtormo venas. [1]The strong wind indicates that a storm is coming.

References[edit]


Wikitext (from Esperanto kelkaj)

# {{inflection of|kelka||p|lang=eo}}
## [[a few]]
## [[several]]
##: {{uxi|eo|'''Kelkaj''' el iliaj ovoj estas malbonaj.|'''Several''' of their eggs are bad.}}

Output

  1. plural of kelka
    1. a few
    2. several
      Kelkaj el iliaj ovoj estas malbonaj.Several of their eggs are bad.


Wikitext

#: {{uxi|fr|cousu de fil blanc|blatantly obvious|lit=sewn with white thread}}

Output

  1. cousu de fil blancblatantly obvious (literally, “sewn with white thread”)


Wikitext

#: {{uxi|ru|Полицейские огородили середину шоссе́ на гора́х.|Police officers blocked the middle of the highway.|subst=шоссе́/шоссэ́}}

Output

  1. Полицейские огородили середину шоссе́ на гора́х.Policejskije ogorodili seredinu šossɛ́ na goráx.Police officers blocked the middle of the highway.


Wikitext

#: {{uxi|de|fließen|to flow|q=Germany}}
#: {{uxi|de|fliessen|to flow|q=Switzerland|q2=Liechtenstein}}

Output

  1. fließen (Germany)to flow
    fliessen (Switzerland, Liechtenstein)to flow

See also[edit]

TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for uxi

This is used to show inline usage examples (not quotations) following a definition line.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
language code1

The language code of the example to be shown

Default
empty
Example
en
Auto value
empty
Stringrequired
example2

The example to be shown. Use '''bold''' to highlight the current term.

Default
empty
Example
The quick brown '''fox''' jumps over the lazy dog.
Auto value
empty
Stringrequired
translation3ttranslation

The English translation for examples on foreign entries. Use '''bold''' to highlight the current term's translation.

Default
empty
Example
Le rapide '''renard''' brun saute par dessus le chien paresseux.
Auto value
empty
Stringoptional
transliterationtr

The Latin transliteration for examples in non-Latin script.

Default
empty
Example
empty
Auto value
empty
Stringoptional
script codesc

The script code, required for certain languages with multiple possible scripts.

Default
empty
Example
Latn
Auto value
empty
Stringoptional
qualifierq

To qualify an example with a region or register, or a type of usage.

Default
empty
Example
informal
Auto value
empty
Stringoptional
referenceref

To include a reference or link to an originating external site.

Default
empty
Example
empty
Auto value
empty
URLoptional
literal translationlit

A literal translation of an idiomatic expression in a foreign language.

Default
empty
Example
to fly like plywood over Paris
Auto value
empty
Stringoptional
substitutionsubst

Substitutions to be applied to handle irregular transliterations in certain languages (e.g. Russian and Yiddish; see example above). If specified, should be one or more substitution expressions, where each substitution expression is of the form FROM/TO, where FROM is a Lua pattern and TO is the corresponding replacement expression. The substitutions are applied in order and before transliteration; hence both FROM and TO should be in the source script (e.g. Cyrillic or Hebrew).

Default
empty
Example
шоссе́/шоссэ́
Auto value
empty
Stringoptional
noenumnoenum

To use in unnumbered sections (not following a definition). It may start the line following the definition or may be prefixed by "<code>#:</code>" for visual aesthetics.

Default
empty
Example
empty
Auto value
empty
Booleanoptional