ထႅမ်းပလဵတ်ႉ:uxi/documentation

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.

ပႃႇရႃႇမီႇတႃႇ

|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=

Substitutions to be applied to handle irregular transliterations in certain languages (e.g. Russian, Yiddish, Hindi). If specified, should be one or more substitution expressions separated by commas. Each substitution expression is of the form FROM//TO (FROM/TO is also accepted), where FROM is the source text as found in the example, and TO is the corresponding respelling in the source script (e.g. Cyrillic, Hebrew or Devanagari). The substitutions are applied in order and before transliteration. The idea is to phonetically respell words with irregular transliteration so that the transliteration comes out correctly, without the need to manually transliterate the entire example using |tr=. Note that FROM and TO are actually Lua patterns (see WT:LUA). This means, for example, that a hyphen in the source text needs to be "escaped" by writing it as %-. See below for an example of using this parameter. Other examples may be found in the documentation for {{usex}} and {{quote}}.

|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.

|sort=

Sortkey. Add this only when the sortkey cannot be generated from the entry name.

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

တူဝ်ယၢင်ႇ

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/>

Output

1. to indicate

   La forta vento indikas ke ŝtormo venas. ― The strong wind indicates that a storm is coming.

ၽိုၼ်ဢိင်

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 blanc ― blatantly 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 ― to flow

   fliessen ― to flow

တူၺ်းပႃး

• WT:USEX
• Module:usex
• Module:usex/templates
• {{ux}} – used for longer usage examples
• {{quote}} – used for quotations

ၶေႃႈမုၼ်းထႅမ်းပလဵၵ်ႉ

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.

Parameter		ၶေႃႈသပ်းလႅင်း	Type	Status
language code	1	The language code of the example to be shown Example en	String	required
example	2	The example to be shown. Use '''bold''' to highlight the current term. Example The quick brown '''fox''' jumps over the lazy dog.	String	required
translation	3 t translation	The English translation for examples on foreign entries. Use '''bold''' to highlight the current term's translation. Example Le rapide '''renard''' brun saute par dessus le chien paresseux.	String	optional
transliteration	tr	The Latin transliteration for examples in non-Latin script.	String	optional
script code	sc	The script code, required for certain languages with multiple possible scripts. Example Latn	String	optional
qualifier	q	To qualify an example with a region or register, or a type of usage. Example informal	String	optional
reference	ref	To include a reference or link to an originating external site.	URL	optional
literal translation	lit	A literal translation of an idiomatic expression in a foreign language. Example to fly like plywood over Paris	String	optional
substitution	subst	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 (FROM/TO is also accepted), 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). Example шоссе́//шоссэ́	String	optional
noenum	noenum	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. Example true	Boolean	optional