Thiorosan: Create the documentation subpage

2026-08-27T12:19:43Z

Create the documentation subpage

New page

This is the documentation for [[Module:Auphen/frame]], the template-facing wrapper around [[Module:Auphen]] for the Yezur wiki. It is not normally invoked by hand: [[Template:Auphen]] calls it as <code><nowiki>{{#invoke:Auphen/frame|auphen|{{{1|}}}|{{{2|}}}|{{{3|}}}}}</nowiki></code>, so that <code><nowiki>{{auphen|word|code}}</nowiki></code> estimates a pronunciation and <code><nowiki>{{auphen|word|code|ruleset}}</nowiki></code> runs a named derivation ruleset. The wrapper holds no linguistic data of its own; it loads the per-language sound data page for the code given, builds an engine from it, runs the requested ruleset and formats the result.

== Parameters ==

Both entry points take the same three positional parameters, each trimmed of surrounding whitespace.

{| class="wikitable"
! Parameter !! Purpose
|-
| <code>1</code> || The word, in the language's own orthography. Required.
|-
| <code>2</code> || The language registry code, e.g. <code>YBS-PJ</code> (see [[Module:Languages]]). Required. It is upper-cased and used to load the data page <code>Module:Auphen/</code>''CODE'', so <code>ybs-pj</code> resolves as well.
|-
| <code>3</code> || The name of a ruleset in that data page's <code>sets</code> table, matched exactly, case included. Left empty or omitted, the module estimates pronunciation instead.
|}

== Entry points ==

{| class="wikitable"
! Function !! Output
|-
| <code>auphen</code> || The formatted result: an estimate wrapped as <code><nowiki><span class="IPA">/…/</span></nowiki></code>, a ruleset result as plain text. On failure it emits a bold inline <code>Auphen:</code> error message and files the calling page into [[:Category:Auphen errors]].
|-
| <code>raw</code> || The engine's bare output, without slashes, markup or categorisation; on failure the plain text <code>ERROR: </code>''message'', again uncategorised. Used by [[Template:Auphen/testcases]] to compare output against hand-checked expectations, and by any caller that wants the segments alone.
|}

== Behaviour ==

The two modes read different halves of the data page. Without a ruleset the engine is built from <code>ipacats</code> (falling back to <code>cats</code>) together with <code>ipa_rules</code>, and the <code>pronounce</code> ruleset is run in the engine's sound mode: the word is lower-cased and converted through <code>ipa_rules</code> from spelling to sound before the rules apply, so the result is in sounds. A data page carrying no <code>pronounce</code> is not an error; an empty ruleset is run, leaving the output of <code>ipa_rules</code> alone. With a ruleset the engine is built from <code>cats</code> (falling back to <code>ipacats</code>) and no <code>ipa_rules</code>, and the named ruleset is run on the word as written, so the result stays in the orthography.

Data pages are pulled in with <code>require</code> rather than <code>mw.loadData</code>, because the read-only proxy <code>mw.loadData</code> returns does not enumerate nested tables under <code>pairs()</code> in Lua 5.1, which would hide the category members. Each category is copied into a plain table before it is handed to the engine.

Four conditions produce an error: an empty word, an empty code, a code whose <code>Module:Auphen/</code>''CODE'' page is missing or does not return a table, and a ruleset name absent from that page's <code>sets</code>. The word itself is passed through untouched, so a <code>~</code> word split is resolved by the engine, not here. The engine's rule syntax, design notes and divergence log live on [[Module talk:Auphen]]; [[Module:Auphen/sandbox/frame]] is the same wrapper pointed at [[Module:Auphen/sandbox]], for testing a candidate engine side by side with the live one.

Module:Auphen/frame/doc - Revision history

Thiorosan: Create the documentation subpage