Template:mention

The following documentation is located at Template:link/documentation. ^[edit]

Redirected from Template:mention/documentation (edit).

Useful links: subpage list • links • redirects • transclusions • errors (parser/module) • sandbox (diff)

Uses Lua:

• Module:links/templates

This template generates a link to an entry in a given language. It links to a specific language-section on the target page, and applies language-specific formatting. It can also show a number of annotations after the linked term.

There are several linking templates:

• {{link}} (shortcut {{l}}). Use this template outside running text, in sections that list entries, such as “Synonyms”, “Related terms”, and “Descendants”.
• {{mention}} (shortcut {{m}}). Use this template when a particular term is mentioned (not used) within running English text, particularly in “Etymology” and “Usage notes” sections, and occasionally in definitions.
• {{l-self}}. Use this template in inflection tables and other templates that list multiple terms. It works the same as {{link}}, but when it links to the same page it is placed on, the link turns bold rather than becoming a link. This mimics the MediaWiki software's behaviour when linking to the same page, but has the full language support of {{link}}.
• {{m-self}}. Use this template in templates that mention multiple terms in running text. It displays like {{mention}}, but works the same as {{l-self}} when linked to the current page.
• {{ll}}. This template creates a link, but does not add any additional formatting or annotations. There is at the moment no consensus on whether it should be used in entries or not.

All of these templates create a link to a language's section of an entry, or to a language-specific sense id created by the template {{senseid}} if the |id= parameter is used.

If the second parameter of {{l}}, {{m}}, {{l-self}}, or {{m-self}} contains a wikilink ([[entryname|text]] or [[entryname]]), then this link will be transformed into a link to the language's section of the entry. For instance, the [[word]] will be transformed into the [[word#English|word]] and these [[word|words]] will be transformed into these [[word#English|words]], if the language code supplied to the template is en.

The annotations – transliteration, translation, literal translation, and part of speech – are displayed by {{l}}, {{m}}, {{l-self}}, or {{m-self}} in parentheses after the link. {{ll}} does not support any of these annotations.

See also Wiktionary:Style guide#Styling templates for a list of all the various styling templates with examples.

This template uses Module:links as a back-end, so it supports all the features and bugs of that module. Please see its documentation for more details.

The template takes one required positional parameter and several optional parameters. Note that either the second or third positional parameter should be given, although technically neither is required.

|1= (required)

The language code (see Wiktionary:Languages) for the language that the term is in. All Wiktionary language codes are supported, including those for constructed and reconstructed languages.

|2= (optional)

The page name to be linked to. The template will automatically remove diacritics and punctuation from the page title, according to the entry_name setting in Module:languages, but will keep them in the displayed text.

• Add : in front of a page name to link to the page as-is, without any diacritic stripping.
• To link to a reconstructed term, such as Proto-Germanic *dagaz, add * in front of the term. This automatically converts the link to be in the Reconstruction namespace.
• To link to a mainspace term in a reconstructed language (i.e. a language that is unattested or mostly unattested and which is normally required to put its lemmas in the Reconstruction namespace), add !! in front of the term. An example of such a term is Proto-West Germanic ᚲᚨᛒᚨ (kaba /⁠kamba⁠/), which should be linked as {{l|gmw-pro|!!ᚲᚨᛒᚨ|tr=kaba|ts=kamba}} or similar. (Proto-West Germanic is a reconstructed language with a single attested term written in Runic script, normally used for the related Proto-Norse language.)
• For scripts which do not use capitalisation (e.g. Devanagari, Han, Mongolian, etc.), a letter of an automatic transliteration can be capitalised by putting ^ before the corresponding character in the term. For example, {{l|zh|^西方}} gives 西方 (Xīfāng). Please note that this should be used instead of giving a capitalised manual transliteration.
• Unsupported titles (see Special:PrefixIndex/Unsupported titles) can be linked to, by adding the displayed title, without the Unsupported titles/ prefix: for instance, {{m|mul|:}} → : links to Unsupported titles/Colon. This feature is made possible by the list found at Module:links/data. To add new unsupported titles, follow the directions in the module.

|3= (optional)

Alternative text to display as the link title, if different from the page name. Please do not use this only for adding diacritics or punctuation to the word, as the template can automatically remove these. See above.

|t= or |4= (optional)

A gloss or short translation of the word. The parameter |gloss= is deprecated for this purpose.

|sc= (optional)

The script code (see Wiktionary:Scripts) for the script that the term is written in. When no code is given, the template will try to detect the script based on the characters in the term and the scripts in the language's data table (see Module:languages § Language:findBestScript). In most cases, it will succeed. If it fails, the code None will be used.

|tr= (optional)

Transliteration for non-Latin-script words. When no transliteration is given, the template will try to add a default transliteration when possible. For certain languages, automated transliteration will override the value of this parameter. Use tr=- if you don't want a transliteration to be automatically generated (you shouldn't really ever do this in an entry).

|ts= (optional)

Transcription for non-Latin-script words whose transliteration is markedly different from the actual pronunciation. Should not be used for IPA pronunciations.

|pos= (optional)

A part of speech indication for the term.

• If the value is one of the abbreviations listed in Template:head#Part of speech (such as a or adj for adjective, n for noun, prepphr for prepositional phrase, etc.), it will be displayed in the expanded (canonical) form.
• If the value is those same abbreviations followed by an f (e.g. af or adjf for adjective form, or nf for noun form), it will be displayed in the expanded (canonical) form followed by the word form.
• If the value is a spelled-out part of speech followed by an f (e.g. nounf for noun form, verbf for verb form or proper nounf for proper noun form), it will be displayed as the part of speech followed by the word form. This only happens for recognized lemma parts of speech (specifically the singular equivalents of the plural lemma parts of speech listed in data.lemmas in Module:headword/data), not for arbitrary words ending in f.
• Anything else is displayed as-is.

|ng= (optional)

Arbitrary non-gloss explanatory text. This is displayed as-is, in upright text, not inside of quotes. It is recommended to use this in preference to |pos= for any sort of explanatory text other than a grammatical description.

|g= (optional)

Gender/number specification(s) for the term, if necessary. Separate multiple specifications with a comma (with no space following). You can use inline modifiers <l:...>, <ll:...>, <q:...>, <qq:...> or <ref:...> to add labels, qualifiers and/or references to individual gender-number specifications. See examples below, and see Module:gender and number for the format used. Alternatively, additional gender/number specs can be given in |g2=, |g3=, etc., but this is deprecated.

|lit= (optional)

A literal translation for the term.

|id= (optional)

An etymology or sense id for the term, which links to anchors on the page set by the {{etymid}} or {{senseid}} templates.

|accel-form= (optional)

Specifies an accelerated creation tag to be used by the WT:ACCEL gadget, to automatically generate an entry for a non-lemma form when the link is clicked. For information about acceleration tags, see WT:ACCEL#Acceleration tags. You should only provide this parameter when using the linking template as part of a headword-line or inflection-table template. Don't use it directly in entries. If the acceleration tag contains a vertical bar |, use {{!}} instead.

|accel-translit= (optional)

Specifies a manual transliteration of the non-lemma form for use with accelerated creation of entries; see WT:ACCEL and |accel-form= above. The value of this parameter goes into param |tr= of the call to {{head}} in the accelerated entry. You only need to specify this for languages that use a non-Latin script, and only when the auto-generated transliteration is insufficient, incorrect or nonexistent.

|accel-lemma= (optional)

Specifies the lemma corresponding to the non-lemma form for use with accelerated creation of entries; see WT:ACCEL and |accel-form= above. The value of this parameter goes into param |2= of the call to {{inflection of}} in the accelerated entry. It defaults to the name of the current page, and only needs to be specified when the lemma contains additional diacritics that are stripped in order to generate the pagename (as in Latin, Russian, Ancient Greek, Old English, etc.).

|accel-lemma-translit= (optional)

Specifies a manual transliteration of the lemma corresponding to the non-lemma form for use with accelerated creation of entries; see WT:ACCEL and |accel-form= above. The value of this parameter goes into param |tr= of the call to {{inflection of}} in the accelerated entry. You only need to specify this for languages that use a non-Latin script, and only when the auto-generated transliteration is insufficient, incorrect or nonexistent.

|accel-gender= (optional)

Specifies the gender of the non-lemma form for use with accelerated creation of entries; see WT:ACCEL and |accel-form= above. The value of this parameter goes into param |g= of the call to {{head}} in the accelerated entry. You should only rarely specify this.

|accel-nostore=1

For use with accelerated creation of entries. Place this on links that appear in the collapsed state of collapsible tables; see WT:ACCEL.

{{l}}, {{m}}, {{l-self}}, or {{m-self}} all add HTML tags in addition to creating a link. {{l|en|word}} outputs the wikicode <span class="Latn" lang="en">[[word#English|word]]</span>, and {{m|en|word}} outputs <i class="Latn mention" lang="en">[[word#English|word]]</i>. {{l-self}} and {{m-self}} do the same, except they don't create a link if the page being linked to is the same as the current page. This HTML is applied by Module:script utilities; for more, see Module:script utilities/documentation#tag text.

The outcome of Wiktionary:Votes/2007-10/style for mentioned terms determined the default style for terms mentioned with the {{mention}}/{{m}} template. The preliminary default for Latin-script (i.e. Roman script, not just Latin-language) terms and phrases is italics. Readers can easily toggle the output from italics to bold by selecting “Show other Latin (Roman) script mentions in bold” from WT:PREFS. Alternatively, or for more advanced customization, readers can add styles to their style sheets as described in WT:CUSTOM:

• For plain format (e.g.: From mot + ...):

  .mention-Latn { font-style: normal }

• For bold format (e.g.: From mot + ...):

  .mention-Latn { font-weight: bold; font-style: normal }

• For italicized format (e.g.: From mot + ...):

  .mention-Latn { font-style: italic }

Further, the default style of the subsequent English translation glosses is in double quotes (pending a vote to approve this template). Readers can easily change the output to single quotes by selecting “Show English glosses for mentioned terms in single quotes” from WT:PREFS.

• {{m+}} – to create a link like {{m}} but with the language name
• {{user}} – for mentioning users
• {{mention-gloss}} ({{m-g}}) – to create quotation marks (for glosses or translations) that are formatted with the same HTML code as used by {{link}} or {{mention}}
• {{zh-l}} – a similar template specialized for Chinese
• {{ltc-l}} – a similar template specialized for Middle Chinese
• {{ja-l}} – a similar template specialized for Japanese
• {{ko-l}} – a similar template specialized for Korean
• {{fa-l}} – a similar template specialized for Persian
• {{th-l}} – a similar template specialized for Thai
• {{vi-l}} – a similar template specialized for Vietnamese
• {{section link}} – to link to a section of a page

There are high performance versions of this template for several languages. All of them take two parameters: the word and the alternative text. Some may support transliteration also, but they should not support any other parameters for speed reasons. Using any of these subtemplates is sometimes necessary for pages that have many links, since they are faster. For normal use, there is no need for this, and the regular {{l}} should be used instead.

• mention/documentation
• mention/sandbox