CLDF word forms

Substrate types for word-level data, aligned with the Wordlist module of the Cross-Linguistic Data Formats ([forkel-etal-2018]), version 1.3 ([forkel-etal-2024]): a Form is a row of the FormTable (a form of a language expressing a concept, with its segmentation), and a Parameter is a row of the ParameterTable (the concept). The sentence-level LinguisticExample of Data/Examples/ is the Examples component; this is its counterpart for morphology, where the datum is a word and its parts rather than an utterance and its gloss.

Per-paper data lives in Linglib/Data/Forms/{AuthorYear}.json, an object whose keys are CLDF table names holding arrays of rows under the CLDF column names, and is compiled by scripts/gen_forms.py into Linglib/Data/Forms/{AuthorYear}.lean, declaring namespace {AuthorYear}.Forms.

FormRelation is a linglib extension table, FormRelationTable, for the paradigmatic pairs a paper asserts between forms (a stem and its past, an adjective and its comparative, a base and its reduplicant); CLDF has no standard component for these and permits custom tables.

Implementation notes

• Language_ID is a Glottocode rather than a foreign key into a LanguageTable, as in Data/Examples/. Source follows the CLDF reference syntax bibkey[label] in JSON and is parsed into SourceRef values.
• Segments is the paper's own tokenization of the form, which may be coarser than a phonemic segmentation: a long vowel as one segment, or a residue the paper treats as one variable. Form.slots reads the segments as a slot-indexed item on the flat carrier, the shape the schema substrate consumes.
• CLDF lets any table carry custom columns. A form's are kept as columns, name-value pairs under the column names of the JSON and read by Form.column?, for the per-form codes a paper assigns (a canonicity judgment, a tone class).
• Identifiers follow the CLDF id format [a-zA-Z0-9_-]+, enforced by the generator.

References

• [forkel-etal-2018]
• [forkel-etal-2024]

structure Data.Forms.Form : Type

A row of a CLDF FormTable: a word form of a language expressing a concept, with its segmentation.

• id : String

  ID: a stable, paper-keyed identifier.

• languageId : Examples.Glottocode

  Language_ID: the Glottocode of the language.

• parameterId : String

  Parameter_ID: the concept the form expresses.

• form : String

  Form: the written form.

• segments : List String

  Segments: the form's segmentation.

• comment : String

  Comment.

• source : List Examples.SourceRef

  Source: the references, each a bibkey with a locator.

• columns : List (String × String)

  The custom columns of the table, by column name.

@[instance_reducible]

instance Data.Forms.instDecidableEqForm : DecidableEq Form

Equations

• Data.Forms.instDecidableEqForm = Data.Forms.instDecidableEqForm.decEq

def Data.Forms.instDecidableEqForm.decEq (x✝ x✝¹ : Form) : Decidable (x✝ = x✝¹)

Equations

• One or more equations did not get rendered due to their size.

@[instance_reducible]

instance Data.Forms.instReprForm : Repr Form

Equations

• Data.Forms.instReprForm = { reprPrec := Data.Forms.instReprForm.repr }

def Data.Forms.instReprForm.repr : Form → ℕ → Std.Format

Equations

• One or more equations did not get rendered due to their size.

def Data.Forms.Form.slots (f : Form) (i : Fin f.segments.length) : Flat String

The segments of a form as a slot-indexed item on the flat carrier.

Equations

• f.slots i = ↑(f.segments.get i)

def Data.Forms.Form.column? (f : Form) (name : String) : Option String

The value of a custom column, if the form has one.

Equations

• f.column? name = List.lookup name f.columns

structure Data.Forms.Parameter : Type

A row of a CLDF ParameterTable: a concept forms express.

• id : String

  ID.

• name : String

  Name.

• description : String

  Description.

@[instance_reducible]

instance Data.Forms.instDecidableEqParameter : DecidableEq Parameter

Equations

• Data.Forms.instDecidableEqParameter = Data.Forms.instDecidableEqParameter.decEq

def Data.Forms.instDecidableEqParameter.decEq (x✝ x✝¹ : Parameter) : Decidable (x✝ = x✝¹)

Equations

• One or more equations did not get rendered due to their size.

@[instance_reducible]

instance Data.Forms.instReprParameter : Repr Parameter

Equations

• Data.Forms.instReprParameter = { reprPrec := Data.Forms.instReprParameter.repr }

def Data.Forms.instReprParameter.repr : Parameter → ℕ → Std.Format

Equations

• One or more equations did not get rendered due to their size.

structure Data.Forms.FormRelation : Type

A row of the FormRelationTable: a paradigmatic relation a paper asserts from one form to another, named by the paper's term for it.

• id : String

  ID.

• formId : String

  Form_ID: the first form.

• targetId : String

  Target_ID: the second form.

• relation : String

  Relation: the paper's name for the relation.

• source : List Examples.SourceRef

  Source.

def Data.Forms.instDecidableEqFormRelation.decEq (x✝ x✝¹ : FormRelation) : Decidable (x✝ = x✝¹)

Equations

• One or more equations did not get rendered due to their size.

@[instance_reducible]

instance Data.Forms.instDecidableEqFormRelation : DecidableEq FormRelation

Equations

• Data.Forms.instDecidableEqFormRelation = Data.Forms.instDecidableEqFormRelation.decEq

@[instance_reducible]

instance Data.Forms.instReprFormRelation : Repr FormRelation

Equations

• Data.Forms.instReprFormRelation = { reprPrec := Data.Forms.instReprFormRelation.repr }

def Data.Forms.instReprFormRelation.repr : FormRelation → ℕ → Std.Format

Equations

• One or more equations did not get rendered due to their size.