Template:form of/fulldoc

From Wiktionary, the free dictionary
Jump to navigation Jump to search

BEGIN SAMPLE OUTPUT OF TEMPLATE:

This template creates a definition line for form of/fulldocs of primary entries.

This template is not meant to be used in etymology sections.

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: 

# {{form of/fulldoc|<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 form of/fulldoc). 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 form of/fulldoc). 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:

|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.
|id= (optional)
A sense id for the term, which links to anchors on the page set by the {{senseid}} template.

END SAMPLE OUTPUT OF TEMPLATE

The following documentation is located at Template:form of/fulldoc/documentation. [edit]
Useful links: root page • root page’s subpages • links • redirects • transclusions • errors (parser/module) • sandbox

This template should be used for displaying the documentation of a form-of template. Note that form-of templates that describe a non-lemma inflection of a lemma form should be documented using {{form of/infldoc}}.

This template is used on the documentation page usually as follows: 

{{form of/fulldoc|...}}
<includeonly>
[[Category:Form-of templates]]
</includeonly>

Examples and a see-also section can follow the {{form of/fulldoc}} declaration, and should be formatted for example like this: 

{{form of/fulldoc|withcap=1}}
===Examples===
On {{m|en|job centre}}:
 <pre># {{lb|en|business|UK}} {{synonym of|en|job center}}</pre>gives
# {{lb|en|business|UK}} {{synonym of|en|job center}}

==See also==
* {{section link|Wiktionary:Semantic relations#Synonymy}}
<includeonly>
[[Category:Form-of templates]]
</includeonly>

Additional categories you may want to add the template to are Category:Declension form-of templates, Category:Conjugation form-of templates and Category:Grammar form-of templates.

Parameters[edit]

All parameters are optional.

|lang=
If given, this is a language-specific template, which automatically assumes the specified language and does not take a language-code parameter.
|exlang=, |exlang2=, ...
For non-language-specific templates, language codes of example languages to which the template applies. Defaults to en for English.
|cat=, |cat2=, ...
Categories which the template categorizes the page into. They should be specified without any preceding language name, e.g. obsolete forms.
|shortcut=, |shortcut2=, ...
Shortcut names of this template. They should be specified with the preceding namespace tag (normally Template:), but without being linked.
|pldesc=
The plural description of this template, without any preceding article. Examples are alternative typographies or [[Appendix:Glossary#aphetic|aphetic]]. Defaults to the template name minus any trailing "of", and pluralized with an "s", e.g. for {{obsolete spelling of}}, this will have the default "obsolete spellings". Normally, use this for inserting links into the text or for irregular plurals.
|primaryentrytext=
By default, the literal text "of primary entries", which directly follows the text specified by |pldesc=.
|addlintrotext=
Any additional text to insert at the end of the first paragraph of the intro. This text normally specifies what the template does (using |pldesc=, |primaryentrytext=), the language it applies to (if |lang= is given), example languages it may apply to (if |exlang= is given), as well as any categories that the page is added to (of |cat= is given).
|withdot=
If true, specifies that the template adds a trailing period by default and takes |dot= and |nodot= parameters to override this.
|withcap=
If true, specifies that the template begins by default with an initial capital letter and takes a |nocap= parameter to override this.
|withfrom=
If true, specifies that the template takes optional parameters |from=, |from2=, etc. to specify regional context labels to appear in the definition line.
|sgdescof=
Singular form of the template description, with trailing "of"; should normally preceded by "a" or "an" as appropriate. By default this is derived from the template name with "an" prepended if the name starts with a vowel and "a" prepended otherwise. For example, for the template {{alternative case form of}}, the default value will be "an alternative case form of". This is used in the parameter descriptions of the second and third numbered parameters and normally does not need to be overridden. An example of a template that overrides this is {{short for}}.
|art=
As an alternative to specifying |sgdescof=, this parameter overrides only the auto-generated article at the beginning of the description.

See also[edit]


Retrieved from "https://en.wiktionary.org/w/index.php?title=Template:form_of/fulldoc&oldid=52120004"