Thiorosan: Create the documentation subpage

2026-08-27T12:19:44Z

Create the documentation subpage

New page

This is the documentation for [[Module:Auphen/sandbox]], a working copy of [[Module:Auphen]], the sound-change engine of the Yezur wiki. It is a test rig rather than a live component: no article, dictionary entry or template renders through it, and it should not be relied on. It holds whatever candidate engine was last placed here, which may be ahead of the live module, behind it, or at odds with it.

An engine change is drafted on this page, run beside the live version over the languages it touches, and only then copied to [[Module:Auphen]]. The candidate placed here on 2026-08-26 — category-wide numbering of <code>@</code> instances, and backtracking in local context matching — was promoted the same day. The two pages are not kept in step automatically, so compare their histories before treating this one as current.

== Invocation ==

The sandbox is not called from wikitext directly: it returns a plain Lua table with no frame-taking functions. [[Module:Auphen/sandbox/frame]] is a copy of [[Module:Auphen/frame]] whose <code>require</code> points here, and it carries the same <code>auphen</code> and <code>raw</code> entry points, so the same call can be put to the candidate and to the live engine and the two outputs compared:

: <code><nowiki>{{#invoke:Auphen/sandbox/frame|raw|word|YAQ-HE}}</nowiki></code>
: <code><nowiki>{{#invoke:Auphen/frame|raw|word|YAQ-HE}}</nowiki></code>

Sound data is shared, not copied: the sandbox frame loads the same per-language pages ([[Module:Auphen/YAQ-HE]] and its siblings) as the live frame, so the engine is the only difference between the two results. Cases that have been accepted belong on [[Template:Auphen/testcases]], which calls the live frame.

== Interface ==

The Lua interface is that of the live module.

{| class="wikitable"
! Name !! Purpose
|-
| <code>Auphen.new(categories, ipa_rules, opts)</code> || Builds an engine. <code>categories</code> maps bracketed names such as <code>[C]</code> to their members in declaration order; <code>ipa_rules</code> is the spelling-to-sound text, one <code>spelling/sound</code> pair to a line; <code>opts</code> is optional.
|-
| <code>eng:run(ruleset, input, toIpa)</code> || Runs <code>ruleset</code> over <code>input</code> and returns the result. With <code>toIpa</code> set, the input is lower-cased, its punctuation normalised and <code>ipa_rules</code> applied first. Spaces and <code>~</code> divide the input into words, each derived with its own word edges.
|-
| <code>eng:run_word(ruleset, word)</code> || Runs the ruleset over a single word; the result takes the capitalisation of the input — all lower case, all upper case, or an initial capital. Returns the derived word and a trace giving, for each rule line, the rule, the output after it and whether it fired.
|-
| <code>eng.warnings</code> || The warnings raised while loading categories and while expanding and resolving rules.
|-
| <code>opts.explodeCap</code> || The ceiling on the number of alternatives a rule segment's categories may expand to, 5,000,000 by default. A segment above it is dropped with a warning, so the rule matches nothing.
|-
| <code>opts.dashToSpace</code> || When set, every <code>-</code> left in the finished word is rendered as a space.
|}

Neither option is set by the two frames, so calls made from wikitext run at the defaults. The rule notation the engine reads is summarised in the header comment of the module itself. Design notes, the behaviour log and the record of divergences are on [[Module talk:Auphen]] and are not repeated here.

Module:Auphen/sandbox/doc - Revision history

Thiorosan: Create the documentation subpage