Template:contraction of/documentation

Uses Lua:

• Module:form of/templates

This template creates a definition line for contractions of primary entries. It also categorizes the page into the proper language-specific subcategory of Category:Contractions by language (e.g. Category:English contractions).

By default, this template displays its output as a full sentence, with an initial capital letter and a trailing period (full stop). This can be overridden using |nocap=1 and/or |nodot=1 (see below).

This template is not meant to be used in etymology sections. For those sections, use {{contraction}} instead.

Note that users can customize how the output of this template displays by modifying their Custom CSS files. See “Form of” templates for details.

Usage

Use in the definition line, most commonly as follows:

# {{contraction of|<langcode>|<primary entry goes here>}}

where <langcode> is the language code, e.g. en for English, de for German, or ja for Japanese.

Parameters

Positional (unnamed) parameters:

|1= (required)

The language code of the term linked to (which this page is a contraction of). See Wiktionary:List of languages. The parameter |lang= is a deprecated synonym; please do not use. If this is used, all numbered parameters move down by one.

|2= (required)

The term to link to (which this page is a contraction of). This should include diacritics as appropriate to the language (e.g. accents in Russian to mark the stress, vowel diacritics in Arabic, macrons in Latin to indicate vowel length, etc.). These diacritics will automatically be stripped out in a language-specific fashion in order to create the link to the page.

|3= (optional)

The text to be shown in the link to the term. If empty or omitted, the term specified by the second parameter will be used. This parameter is normally not necessary, and should not be used solely to indicate diacritics; instead, put the diacritics in the second parameter.

Named parameters:

|mandatory= (optional)

If |mandatory=1, indicates that the contraction is mandatory.

|optional= (optional)

If |optional=1, indicates that the contraction is optional.

|t= or |4= (optional)

A gloss or short translation of the term linked to. The parameter |gloss= is a deprecated synonym; please do not use.

|tr= (optional)

Transliteration for non-Latin-script terms, if different from the automatically-generated one.

|ts= (optional)

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

|sc= (optional)

Script code to use, if script detection does not work. See Wiktionary:Scripts.

|dot= (optional)

A character to replace the final dot that is normally shown automatically.

|nodot= (optional)

If |nodot=1, then no automatic dot will be shown.

|nocap= (optional)

If |nocap=1, then the first letter will be in lowercase.

|id= (optional)

A sense id for the term, which links to anchors on the page set by the {{senseid}} template.