Template:Interlinear/doc

Basic usage
This template formats a linguistic interlinear glossed text: Nginda-rni ngaja-mi jurliji-rdarra diyim ka-rdu

DEM(M)-FOC see-IRR bird-PL fly 3SG-go

'Look at all the birds flying!'

Te ni-kekoo te̱e ún
 * On lines to be interlinearised, any wiki markup or templates should not span word boundaries. Мarkup or templates that apply to a sequence of words must be repeated for each word: (It is also possible to apply formatting to an entire line, see below)

And past-arrived.PL man he

"The men arrived"

The characters <, > and = should not be used directly. They can be substituted as follows:

To let a multi-word expression be treated as a single word, surround it in {curly brackets}. Similarly, use {} for an empty word: Dit is een voorbeeldje in het Nederlands

This is a {little example} in {} Dutch.

The template can be invoked with any number of unnamed parameters, which are interpreted as lines of text. If there is only one unnamed parameter, then it will be rendered in-line and treated as a gloss line:  gives: house-ATTR master-ABS. If they are more than one, then all will be interlinearised except the last one, which is assumed to be the free translation. To force the interlinearisation of all lines, supply an empty last unnamed parameter: Ù-dììny 	Juáàny 	bèʔcw.

COMPL-hit 	Juan 	dog

Layout
A line of text to be displayed above the interlinear block is given using top, one to be displayed immediately below the free translation is set using bottom. Example numbering can be set using number. The parameter consists in one or more characters to be displayed in the left margin. The size of the resulting indentation of the interlinear block (measured in ems) can be modified using indent. kʼetʼu-q ɣˤay ħaƛu-ł-xo

cat-POSS:ESS milk:ABS drink-POT-PRS

"The cat can drink milk."

The spacing between consecutive word stacks can be adjusted using spacing; it is measured in ems and its default value is 1. To visually set off the interlinear display from surrounding text, the yes parameter can be used. It surrounds the whole interlinear text in a box with a wikitable-like background colour. Nyama-baji imimikin-bili-rni-rni ardalakbi-wurru-ju

DEM-PL old.woman-ANIM.DU-F-ERG hot-3PL-do

'The two old women feel hot.'

To add a comment after a given line, use cN (where N is the sequence of the line: the content of c1 will be appended at the end of first line, c2 – at the end of the second line etc.): Shte da e vidiyal

FUT COMPL AUX see.PTC.M.SG

'He must have seen it.'

Line formatting
Formatting can be set for an entire line using the styleN parameter, which applies CSS style properties to line N (style1 for the first line, style2 for the second one, etc): Įxę̀ę eya ı̨-lè

yesterday sick/painful PFV.3.SBJ-COP.PFV

'Yesterday he was sick.'

Similarly, CSS classes can be specified for line N using classN. Classes should be given without any quotation marks.

Italics are by default applied to the first line, unless disabled by no. Any line can be italicised using yes (where N is the number of the line). On italicised lines, tone numbers will be formatted as superscripts, unless tone-superscripting is set to no. To turn off italics for a particular word within an italicised line, use noitalic.

To specify the language of a given line, you can use langN (with N being 1 for the first line, 2 for the second one etc.). The parameter should be the ISO code of the language, as in the familiar Template:Lang. If the unnumbered lang is given, then it is applied to the first line. If line N employs IPA, then the effect of Template:IPA can be mimicked by setting yes. If transliteration has been used, then the transliteration scheme can be specified with the translN parameter (similarly to Template:Transl).

Glossing abbreviations
Linguistic glosses typically abbreviate grammatical category labels, like this: ACC, instead of the full name 'accusative'. The line containing such glosses is specified using yes (where N is the number of the line within the interlinear text). If no line is specified, then it is assumed such glosses are found in the second line (this can be bypassed with no). Within the lines so specified, any sequence of upper case letters will be interpreted as a grammar gloss and formatted in.

Additionally, the template will attempt to recognise the meaning of each abbreviation: it is looked up in the table of abbreviations, and if found there, it will be formatted with a dotted underline and the "label" of this abbreviation will be displayed in a tooltip, like this: DAT. Alternatively, the abbreviation can be turned into a link to the wikipedia article about the corresponding grammatical category, like this: DAT. To choose the latter behvaiour, use the following parameter: link. It is possible for separate lines to employ different styles, in this case the parameters used will be glossing2, glossing3, etc.

If a particular glossing abbreviation is to be treated differently from the rest, then gcl can be used: ngagun-yi nga-nanda-yi nung

1sg.NOM-ERG 1sgA.3sgO-see-PST 3sg.ACC

'I saw him/her.' ngagun-yi nga-nanda-yi nung

1sg.NOM-ERG 1sgA.3sgO-see-PST 3sg.acc

'I saw him/her.' In this example, marks up acc as a glossing abbreviation (it wouldn't have otherwise been interpreted as such because it is lower-case). is used to define the meaning of the unusual abbreviation 1sgA, which wouldn't be recognised even in upper case. displays the abbreviation as a link to the Wikipedia article. applies formatting to a part of a glossing abbreviation; if weren't used here then the wikimarkup would have forced P to be treated as a separate abbreviation from ST.

If the grammatical category labels are not abbreviated but written out in full (like that: ACCUSATIVE) then glossing should be set to no abbr, which will only apply small-caps formatting: wǒ yǐjing jiàn-guò {Zhāng Sān} le.

I already see-EXPERIENTIAL {Zhang San} RESULTATIVE.

Additional style parameters can be applied to all gloss abbreviations using glossing-style. The default formatting using small caps can be disabled with no, and the default underlining can be turned off using no. To exempt a particular abbreviation from being treated as a grammatical gloss, use no gloss.

The pesky boxes with glossing messages that are shown in preview mode can be turned off with no.

Custom abbreviations
When an individual abbreviation is not recognised, or it is necessary to use it with a meaning different from the standard one, then one way is to format each instance with gcl, as seen above. A second option is to supply a list of custom glossing abbreviations using abbreviations (or ablist). These will be applied to all (upper-case) glossing abbreviations detected by the template. The list of custom abbreviations takes the format: ABBREVIATION1:meaning1:wikipedia_article1; ABBREVIATION2:meaning2:wikipedia_article2... (specifying a Wikipedia article is optional and has no effect unless link): wǒ yǐjing jiàn-guò {Zhāng Sān} le.

I already see-EXP {Zhang San} RES. If an abbreviation is commonly used and umabiguous, then the template can be set up to recognise it natively by the addition of an entry to the module's data page.

Troubleshooting
This is a list of problems that are likely to be encountered:
 * One of the lines went missing.
 * Does this line contain anywhere an equals sign? If yes, then all instances of the equals sign should be replaced with.


 * I've applied bolding/italics to a phrase and now the formatting is all over the place.
 * Any formatting should be applied separately to each word.


 * I receive the error "Mismatch in the number of words".
 * Interlinearised lines don't contain the same number of words. If this is intended, then consider filling the empty slots with {}. If this is not intended, then the following points might help track down the cause:
 * if formatting or a template is applied to a piece of text then this text is treated as a single word:
 * non-breaking spaces are not treated as word separators;
 * if a sequence of words is enclosed in {curly brackets} then it's treated as a single word.


 * I receive the error "Unknown glossing abbreviation(s)".
 * See above for details, but in short:
 * If this was not intended as a glossing abbreviation, enclose it in no gloss.
 * To set the meaning of one instance of a glossing abbreviation, format that instance with gcl, for example.
 * If the abbreviation occurs several times within the same example then it might be easier to use the abbreviations parameter, for example: PF:perfective aspect.