Template:Ux/documentation

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

Parameters

|1=

The language code of the example to be shown, e.g. en for English; see Project: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 Project:List of scripts for the full list.

|inline=

To include the translation in the same line as the example, separated from the example by em dash, assuming that the example, its translation and transliteration are short enough to fit in a single line. (Set it to 1 to choose inline mode. See also {{uxi}}.)

|q=, |qN= or |qualifier=, |qualifierN=

To include a qualifier for the example or quote. You can specify multiple qualifiers using q2=, q3=, etc.

|footer=

Additional information to include in a footer.

|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 Project: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 {{uxi}} 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.

|nocat=

Don't add categories.

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

Examples

Wikitext (from )

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

Output

1. book

Wikitext (from Esperanto indiki)

# to [[indicate]]
#: {{ux|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.

   The strong wind indicates that a storm is coming.

References

Wikitext (from Esperanto kiuj)

# ({{plural of|eo|kiu}}) [[which]] {{gloss|relative}}
#: {{ux|eo|La elementoj '''kiuj''' troviĝis sur piratflagoj estis skeletkapo, la simbolo por la morto, skeleto indikis turmentan morton,
sablohorloĝo indikis ke la tempo venis, sanganta koro malrapida kaj dolora morto kaj ponardo aŭ maĉeto signifis impulso por batali.
|The elements '''which''' were found on pirate flags were: skull, the symbol for death, skeleton indicated torturous death, hourglass
indicated that the time came, bleeding heart → slow and painful death and dagger or machete signified impulse for battle.
|ref=<sup>[//eo.wikipedia.org/wiki/Jolly_Roger]</sup>}}

Output

1. (plural of kiu) which (relative)

   La elementoj kiuj troviĝis sur piratflagoj estis skeletkapo, la simbolo por la morto, skeleto indikis turmentan morton, sablohorloĝo indikis ke la tempo venis, sanganta koro malrapida kaj dolora morto kaj ponardo aŭ maĉeto signifis impulso por batali.^[1]

   The elements which were found on pirate flags were: skull, the symbol for death, skeleton indicated torturous death, hourglass indicated that the time came, bleeding heart → slow and painful death and dagger or machete signified impulse for battle.

Wikitext (from Esperanto kelkaj)

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

Output

1. plural of kelka
   1. a few
   2. several

      Kelkaj el iliaj ovoj estas malbonaj. ― Several of their eggs are bad.

Wikitext

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

Output

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

Wikitext (with subst=)

#: {{ux|ru|Полице́йские огороди́ли середи́ну шоссе́ на гора́х, '''всле́дствие чего́''' бегле́ц был на во́ле.|Police officers blocked the middle of the highway '''as a consequence that''' a fugitive was on the loose.|subst=шоссе́//шоссэ́}}

Output (with subst=)

Wikitext

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

Output

1. fließen ― to flow

   fliessen ― to flow

See also

• Project:USEX
• Module:usex
• Module:usex/templates
• {{uxi}} – used for inline usage examples
• {{quote}} – used for quotations
• {{rfex}} – to request an example
• {{suffixusex}} – usage example for suffix entries
• {{prefixusex}} – usage example for prefix entries

TemplateData

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

TemplateData for Ux

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

Template parameters[Edit template data]

This template prefers block formatting of parameters.

Parameter		Description	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
inline	inline	To include the translation in the same line as the example, separated from the example by em dash, assuming that the example, its translation and transliteration are short enough to fit in a single line. (Set it to 1 to choose inline mode.) Example 1	Number	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 separated by commas, 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 (see [[Project: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). 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.	Boolean	optional