Thiorosan: Create the documentation subpage

2026-08-27T12:19:53Z

Create the documentation subpage

New page

This is the documentation for [[Module:Translations]], the translations-box renderer for the Yezur wiki. It is not called directly: [[Template:Translations]] invokes it with <code><nowiki>{{#invoke:Translations|render}}</nowiki></code> and the module reads the parameters given to that template. One box covers one English sense and lists the words the world's languages use for it, grouped by macro-family; boxes sit under a <code><nowiki>====Translations====</nowiki></code> heading following that sense's definitions, inside the English section of a Dictionary entry. Worked examples are at [[Template:Translations/testcases]].

== Parameters ==

{| class="wikitable"
! Parameter !! Purpose
|-
| <code>gloss</code> || The sense being translated, shown in italics after ''Translations'' and an em dash in the box heading. Required: a headword with several senses carries one box per sense, and the gloss is what keeps them apart. When it is omitted the heading reads <code>no gloss given</code> in the error style instead.
|-
| ''CODE'' || A registry code from [[Module:Languages]] used as the parameter name — <code>YAQ-HE</code>, <code>YBS-PJ</code>, <code>YCQ-BE</code> — with that language's word for the sense as the value. Any number may be given. A single value may hold several synonyms separated by commas, each of which is linked separately.
|}

Every named parameter other than <code>gloss</code> is read as a language code; codes are matched case-insensitively. Parameters with an empty value are skipped, as are positional parameters. A gloss given on its own still renders the heading and an otherwise empty box; the module returns nothing at all when it is given neither a gloss nor any language parameter.

== Grouping and order ==

Each word is linked to its Dictionary entry through [[Module:Languages]], which anchors the link to the language's section heading and prefixes an asterisk for reconstructed languages — the star comes from the registry, not from the wikitext. Group headings are the registry's <code>family</code> field; known codes carrying no family are gathered under ''Isolates''.

Rows are sorted by the second letter of the code, which is the family, then by the third, which is the era (<code>P</code> proto, <code>Q</code> ancient, <code>R</code> medieval, <code>S</code> modern, so alphabetical order is also chronological), then by language name, then by the code itself. The second letter likewise picks the colour class, <code>tfam-</code> followed by that letter. Colours and layout come from [[Template:Translations/styles.css]], which the module loads through TemplateStyles; it defines <code>tfam-A</code> to <code>tfam-E</code> for the five families and <code>tfam-X</code> for the isolate codes.

A code the registry does not know is not silently dropped. Its words are left unlinked and printed after all the family groups as <code>unrecognized code ''CODE'': ''word''</code> in red, so that a typo or a language missing from the registry shows on the page.

The box is display-only: it stores nothing and is hand-curated per sense, in the same way as the family Members tables.

Module:Translations/doc - Revision history

Thiorosan: Create the documentation subpage