Template:uxi/documentation

This is used to show inline usage examples (not quotations or collocations) following a definition line. For collocations, use. See WT:USEX for some general guidelines regarding usage examples.

The template call works identically to. 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

 * 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 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  (  is also accepted), where   is the source text as found in the example, and   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   and   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  and.


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

Examples
Wikitext (from 🇨🇬)

Output
 * 1) book

Wikitext (from 🇨🇬)

Output
 * 1) to indicate

TemplateData
{	"params": { "1": {			"label": "language code", "description": "The language code of the example to be shown", "example": "en", "type": "string", "required": true, "suggested": true },		"2": {			"label": "example", "description": "The example to be shown. Use bold to highlight the current term.", "example": "The quick brown fox jumps over the lazy dog.", "type": "string", "required": true, "suggested": true },		"3": {			"aliases": [ "t", "translation" ],			"label": "translation", "description": "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.", "type": "string" },		"tr": { "label": "transliteration", "type": "string", "description": "The Latin transliteration for examples in non-Latin script." },		"sc": { "label": "script code", "type": "string", "description": "The script code, required for certain languages with multiple possible scripts.", "example": "Latn" },		"q": { "label": "qualifier", "type": "string", "description": "To qualify an example with a region or register, or a type of usage.", "example": "informal" },		"ref": { "label": "reference", "description": "To include a reference or link to an originating external site.", "type": "url" },		"lit": { "label": "literal translation", "type": "string", "description": "A literal translation of an idiomatic expression in a foreign language.", "example": "to fly like plywood over Paris" },		"subst": { "label": "substitution", "type": "string", "description": "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": "шоссе́//шоссэ́" },		"noenum": { "label": "noenum", "description": "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.", "type": "boolean", "example": "true" }	},	"description": "This is used to show inline usage examples (not quotations) following a definition line. ", "format": "block" }