# Language data explorer

A single, self-contained, offline-capable HTML page that lets you browse
every registered `LanguageSpec` interactively: grapheme→IPA maps,
allophones, positional and post-lexical allophone rules, ancestry chains,
quality tiers, and: the part worth highlighting: the per-source academic
**citations** (author, year, title, pages, URL) behind each spec's
phonological decisions, plus its honest notes and input-contract warnings
(e.g. pinyin/jamo/tashkeel requirements).

Once CI has published it, the live page is reachable at the repository's
GitHub Pages URL (`https://tigregotico.github.io/orthography2ipa/`, once a
maintainer has enabled Pages under **Settings → Pages → gh-pages**: see
below).

## What it shows

- A searchable, filterable sidebar over all registered codes: filter by
  family, script, or quality tier.
- Per-language detail: name, code, family, script, quality badge.
- Gold benchmark rows (dataset, N, PER, 95% CI, provenance) where scored: joined from `benchmarks/results.json`.
- The ancestry chain (parent + weighted ancestors), rendered as clickable
  links to the referenced specs.
- The full grapheme table, allophone map, positional-grapheme overrides,
  and allophone rules, rendered as readable tables (not raw JSON).
- Sources, notes, and Wikipedia links.

The selected language is reflected in `location.hash` (e.g.
`#eu-x-zuberera`), so any language's view is a shareable URL.

## Generating it locally

```bash
python scripts/gen_explorer.py
```

This writes `docs/explorer.html`: a single file with no external network
requests, safe to open directly (`file://`) or serve statically. It is not
committed to `dev`; `docs/explorer.html` is a build artifact regenerated by
CI on every push to `dev` and published to the `gh-pages` branch (see
`.github/workflows/pages.yml`).

**Note for maintainers:** GitHub Pages must be enabled once, manually, for
the published site to be reachable (**Settings → Pages → Deploy from a
branch → gh-pages**). The workflow keeps `gh-pages` up to date regardless;
treat the deploy as best-effort given the org's known Actions billing
constraints.

Data quality caveat: gold benchmark data is a grain of salt: PER is
directional, not a certification. See [benchmarks.md](benchmarks.md) and
[scoreboard.md](scoreboard.md).

---
[← Esperanto](languages/eo.md) · [Home](index.md)
