interscript-maps 2.5.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38102d91406d94f24fad27e99a913ec8337194a7145c5a03d9d90e83086263fe
-  data.tar.gz: 26310c81e8f27250c74dbab39cb0b443db79a70dfbccea93523a96b6694cf2b6
+  metadata.gz: 58b284a0671ab532f07ededfc53f636b410bd25aa02ea76a8be178b4f7f7c3ce
+  data.tar.gz: ee1465e80068e422f4ee0ec75329193e9b33acee6827fb766bdff1240c1b9090
 SHA512:
-  metadata.gz: b6110940099fdd72a413d94301d7c1f199cf964de6b00c3ac2234c354acf5a11ee36f6c98d128eaff7e3133b4e82e6cefc7eb2d54fc12838e19d2af2d79ce221
-  data.tar.gz: cdb62bed4820a17daebb599d05db16694a08bed7024a34ea10843cfe89f8e88331f1d1fe6304ee4f0eb6575952e1c2beca809d05a06f6ca1300011e81729c54b
+  metadata.gz: '0791111363483233ff1848ac02ddcebcbbda9c5a71b729d0ea50301acf49ce4ac091d39ebce8e6f797b929066148e52110acc824bc50c2b7f3ae15347a543e75'
+  data.tar.gz: 01e47d47aad206e2d83e71a203e2df21d9fe6c63020489f890753e08e2abc094d515f04918babc833b4efc15780d6e204d012d7d10f528c986ee307a4c162f61

data/README.adoc

@@ -3,7 +3,18 @@ image:https://github.com/interscript/maps/actions/workflows/test.yml/badge.svg["
 
 == Introduction
 
-This repository contains all Interscript interoperable script conversion schemes.
+This repository is the single source of truth for Interscript's
+transliteration corpus: 300 authority-backed script conversion systems
+encoded in the "Interoperable Script Conversion" language (`.isc`).
+
+Interscript turns the world's transliteration standards from paper
+tables into executable, verifiable software: authority schemes
+(BGN/PCGN, ISO, UN/UNGEGN, ALA-LC, ICAO, ODNI, ...) are encoded once
+here, and every runtime —
+https://github.com/interscript/interscript-ruby[Ruby],
+https://github.com/interscript/interscript-ts[TypeScript],
+https://github.com/interscript/interscript-py[Python], the public API,
+and the website — produces provably identical output.
 
 == Contents
 
@@ -15,14 +26,74 @@ Systems from these authorities are included in this repository:
 * ISO
 * ODNI
 * UN (by UNGEGN)
-* and others systems that do not have a defined authority
+* and other systems that do not have a defined authority
 
 == Organization
 
-All maps are encoded in the "Interoperable Script Conversion" language syntax (extension: `.isc`).
+All maps are encoded in the "Interoperable Script Conversion" language
+syntax (extension: `.isc`).
+
+System file names adhere to the script conversion system code
+convention of ISO 24229.
+
+== Quality gates
+
+CI runs on every change:
+
+* ISC parse validation in Ruby and TypeScript;
+* each map's own embedded tests;
+* cross-runtime parity (byte-exact agreement between the Ruby
+  interpreter and the TypeScript runtime over the test corpus);
+* the published artifact (`interscript-maps` gem and the maps release
+  artifact) is built from this corpus by CI, never by hand.
+
+== Coverage and known gaps
+
+Every authority document the project holds has been audited against
+the corpus. The complete reference-to-corpus inventory — including
+which standard produced which map, and what remains — is
+link:docs/coverage/README.adoc[docs/coverage/README.adoc].
+
+=== Held standards not yet encoded
+
+Fifteen deterministic tables are held but not yet encoded. Each is a
+complete table with its own example rows; none needs training data to
+encode:
+
+* **ODNI / ICS 630-01** — Kurdish (Annex G: Perso-Arabic to Latin for
+  personal names, no diacritics) and Chinese (Annex D: not a
+  Han-character romanizer, but an IC standard for names already
+  written in Hanyu Pinyin, with Wade-Giles and Yale conversion
+  appendices).
+* **DIN** — 31635 (Arabic, Ottoman Turkish, Persian, Kurdish, Urdu),
+  31636 (Hebrew), 32706 (Armenian), 32708 (Japanese), and 1460-2
+  (non-Slavic Cyrillic).
+* **BSI** — BS 2979:1958 (Cyrillic and Greek) and PD 6505:1982
+  (Korean romanization).
+* **BGN/PCGN** — Burmese, Hebrew, Khmer, Lao, Shan, and Inuktitut.
+
+=== Not doing: neural models for five languages
+
+Burmese, Dzongkha, Inuktitut, Lao, and Shan have complete BGN/PCGN
+tables, but no gold script-to-romanization data exists to train a
+neural model. Interscript withholds a model rather than ship a
+bad-quality one; the deterministic maps are still in scope.
+
+=== Source documents not held
+
+Some verified maps have no archived source document in the project:
+most ALA-LC tables (one table document is held of the 78 in the
+catalogue), most ISO standards (only ISO 9, ISO 9984 and ISO/TR 11941
+are held), and the UN/UNGEGN schedules. These are archival gaps, not
+encoding gaps.
+
+== Contributing
 
-System file names adhere to the script conversion system code convention
-of ISO 24229.
+New or corrected systems are welcome as `.isc` changes — see
+CONTRIBUTING.md and the Map Editing Guide in the
+https://github.com/interscript/interscript[project monorepo].
+Alias/dependency declarations must be explicit; generated artifacts
+are never edited by hand.
 
 == Copyright and license
 

data/interscript-maps.gemspec

@@ -1,4 +1,4 @@
-INTERSCRIPT_MAPS_VERSION = "2.5.2"
+INTERSCRIPT_MAPS_VERSION = "3.0.0"
 
 Gem::Specification.new do |spec|
   spec.name          = "interscript-maps"