View source for Template:surface analysis/documentation

{{documentation subpage}}
{{uses lua|Module:etymology}}
{{shortcut|Template:surf}}
This template shows the morphemes that make up a word, for use in etymology sections. Although it is called affix, it can be used for compounds too.

This template works the exact same as {{temp|affix}} but it can be used as a shorthand for surface analysis, providing a glossary-linked piece of text about this.

==Usage==
All you need to do is provide the language code and then as many constituent morphemes as you like.

 From {{tempn|inh|kil|lnk-pro|cajn-|cajnhacʼas|t=to write}}, {{tempn|surf|kil|šēn|-hē|pos2=infinitive|nocap=1}}.

Generates the following:

: From {{inh|kil|lnk-pro|cajn-|cajnhacʼas|t=to write|nocat=1}}, {{surf|kil|šēn|-hē|pos2=infinitive|nocap=1|nocat=1}}.

===Parameters===
; {{para|1|req=1}}
: Specifies the language code of the language that the etymology belongs to.

; {{para|2}}, {{para|3}}, etc.
: Specifies the constituent morphemes of the etymology. There can be as many of these as you'd like. They are considered to be numbered from 1 onwards.

; {{para|t<var>N</var>}}
: Specifies the gloss to be shown for one of the constituent morphemes, as specified by the number <var>N</var>. For example {{para|t2|write}} would set the gloss of the second constituent element to "write".

; {{para|alt<var>N</var>}}
: Specifies the text to be shown in place of the word itself for one of the constituent morphemes, as specified by the number <var>N</var>. For example {{para|alt2|abcd}} would set the displayed text in the link of the second constituent element to "abcd".

; {{para|l<var>N</var>}}
: Specifies the language code of the constituent morpheme, as specified by the number <var>N</var>. If this is given, the language name appears and a derivation category may be added.

; {{para|pos<var>N</var>}}
: Specifies the part of speech to be shown for one of the constituent morphemes, as specified by the number <var>N</var>.

; {{para|noaff<var>N</var>}}
: Indicates that a specific constituent morpheme is not an affix of any kind. This is useful for morphemes that include a delimiter such as -, common in proto-language roots, but are not affixing morphemes.

; {{para|nocap}}
: When provided with any value, e.g. {{para|nocap|1}}, ensures the prefixed text does not begin with a capital letter. This is useful when using this template in the middle of a sentence.

; {{para|notext}}
: When provided with any value, e.g. {{para|notext|1}}, stops the template from generating any text at all. Note that because no special categories are added for surface analysis, if you are suppressing the text in this way it might be worth just using the {{temp|affix}} template instead.

; {{para|nocat}}
: When provided with any value, e.g. {{para|nocat|1}}, stops the template from adding any categories to the page.

===Categories===
This template automatically adds derivation-related categories to the page according to the constituent morphemes given, unless the {{para|nocat}} parameter is set.

If prefixes (ending with a "-" or "·"), suffixes (beginning with a "-" or "·") or infixes (both beginning and ending with a "-" or "·") are detected, corresponding categories will be added.

For example, the following snippet would add the category "Kilitic terms prefixed with le-".

 {{tempn|affix|kil|le-|šēnhē}}

If there are no affixes found, but there are at least 2 constituent parts then it will be considered a compound and a category such as "Kilitic compound terms" will be added.

If one of the constituent morphemes is a different language (as specified by one of the {{para|l<var>N</var>}} parameters) then a category such as "Kilitic terms derived from Other Language" will be added.