Thiorosan: Create the documentation subpage

2026-08-27T12:19:46Z

Create the documentation subpage

New page

This is the documentation for [[Module:Auphen/sandbox/frame]], a working copy of [[Module:Auphen/frame]], the template-facing wrapper around the [[Module:Auphen|Auphen]] sound engine. It is a test rig rather than production code: no article, entry or template should depend on it, and its output is not evidence of what the live engine does.

It differs from the live frame in two places only — its header comment, and the <code>require</code>, which names [[Module:Auphen/sandbox]] in place of [[Module:Auphen]]. A candidate engine placed in the sandbox can therefore be driven through the same wrapper as the live one and the two compared side by side before the candidate is promoted. The per-language data pages it reads are the live ones at <code>Module:Auphen/<code></code>; there are no sandbox copies of those. When the live frame changes, this copy has to be brought back into step with it by hand.

[[Template:Auphen]] invokes the live frame, so <code><nowiki>{{auphen}}</nowiki></code> never reaches this module. It is called directly, and exports nothing beyond the two entry points below:

: <code><nowiki>{{#invoke:Auphen/sandbox/frame|auphen|word|code|ruleset}}</nowiki></code>
: <code><nowiki>{{#invoke:Auphen/sandbox/frame|raw|word|code|ruleset}}</nowiki></code>

<code>auphen</code> formats the result: an estimated pronunciation is wrapped in slashes and marked up as IPA, while a named ruleset returns plain text. <code>raw</code> returns the engine's output unformatted, which is what a comparison table wants.

== Parameters ==

{| class="wikitable"
! Parameter !! Purpose
|-
| <code>1</code> || The word, in the language's orthography. Required. It is passed to the engine unaltered; a <code>~</code> is a word boundary handled there rather than here, each part being run as its own word.
|-
| <code>2</code> || The language registry code, such as <code>YAQ-HE</code> or <code>YBS-PJ</code>. Required. It is upper-cased before the matching <code>Module:Auphen/<code></code> data page is loaded.
|-
| <code>3</code> || The name of a ruleset from that data page's <code>sets</code> table. Left empty, the module runs the page's <code>pronounce</code> ruleset instead and marks the result as an estimate.
|}

All three are trimmed of surrounding whitespace. For an estimate the engine is built from the data page's <code>ipacats</code> (falling back to <code>cats</code>) together with its <code>ipa_rules</code>; for a named ruleset it is built from <code>cats</code> (falling back to <code>ipacats</code>) and no spelling rules are applied.

A missing word, a missing code, a code with no data page, or a ruleset name absent from <code>sets</code> yields an error rather than a script failure. <code>auphen</code> shows the message as an error span prefixed <code>Auphen:</code> and files the calling page into [[:Category:Auphen errors]] — the live maintenance category, which a failing sandbox call will populate like any other; <code>raw</code> returns the message prefixed <code>ERROR:</code>.

Data pages are loaded 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>, which would hide the category members; the frame then copies the category tables into plain Lua tables before handing them to the engine. [[Template:Auphen/testcases]] holds the acceptance tests against the live frame, and the same rows can be pointed at this module to measure a candidate against them. The engine's design notes and behaviour log are on [[Module talk:Auphen]].

Module:Auphen/sandbox/frame/doc - Revision history

Thiorosan: Create the documentation subpage