Text

Validate against: http://json-schema.org/draft-07/schema#

Schema ID: http://schemas.digitallinguistics.io/Text-5.2.0.json

Type: object

Description

A text is the fundamental unit of documentation. It represents a linguistic performance of a stretch of discourse in context. This may include a wide variety of linguistic genres: an elicitation session, a conversation, a narrative, a song, etc. In technical terms, a text is an interlinearized set of utterances with one or more transcriptions, translations, and optionally Leipzig-style glosses.

Developer Notes

This is a top-level database object

Required Properties

  • title
  • utterances

Properties

The following properties are defined for this object:

  • Type: type

    Type: string

    Read-only: true

    Description

    The type of object. Must be set to Text.

    This item must have the following value:

    "Text"
  • ID: id

    Description

    A unique database identifier for this Text

  • Abbreviation: abbreviation

    Type: string

    Description

    An abbreviation for this Text

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Abbreviation.json

  • Access Rights: access

    Type: object

    Description

    An object describing the acess rights to this Text

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Access.json

  • Annotations: annotations

    Type: array

    Description

    A collection of annotations on this text

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Annotation: annotations

    Type: object

    Description

    An annotation on this text

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Annotation.json

  • Contributors (People): contributors

    Type: array

    Description

    A collection of people who contributed to the creation or analysis of this text in some way. This should miniimally include the speaker(s) who produced the text.

    Items

    Each item in this array must adhere to the following schema:

    Contributor (Person - DatabaseReference): contributors

    Type: object

    Description

    A database reference to a Person object that describes this contributor.

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • Date Created: dateCreated

    Type: string

    Description

    The date and optionally time that this Text was created in the database (not the date it was recorded; see the dateRecorded property instead)

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • Date Modified: dateModified

    Type: string

    Description

    The date and optionally time that this Text object was last modified (not the date that the recording of the text was modified)

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • Date Recorded: dateRecorded

    Type: string

    Description

    The date and optionally time that this text was recorded

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • Discourse Type: discourseType

    Type: string

    Description

    The type of discourse event, e.g. monologue, dialogue, or song

  • Genre: genre

    Type: string

    Description

    The genre of the text, e.g. folktale, personal narrative, or expository

  • Link: link

    Type: string

    Description

    A URL where a presentational format for this resource may be viewed

    Format: uri

  • Location: location

    Type: object

    Description

    A database reference to the location where this text was recorded

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • Media: media

    Type: array

    Description

    An array of objects containing information about the media files associated with this Text. Usually this will include the WAV or video file that was originally recorded for the text, but can also include any derivative media files (such as MP3) as well. Media associated with a text are automatically considered to be part of the same database bundle as the Text.

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Media Items (Database Reference): media

    Type: object

    Description

    A database reference to an object describing a media file

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • Notes: notes

    Type: array

    Description

    A collection of notes about this Text

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Note: notes

    Type: object

    Description

    A Note object

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Note.json

  • References: references

    Type: array

    Description

    A list of any bibliographic references concerning or relating to this Text

    Items

    Each item in this array must adhere to the following schema:

    Reference: references

    Type: object

    Description

    A bibliographic reference about this text

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/BibliographicReference.json

  • Tags: tags

    Type: object

    Description

    A set of tags associated with this Text

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Tags.json

  • Title: title

    Description

    A title is a human-readable prose description of the content of the Text. The title object contains all the titles of the text, in one or more languages (at least one must be provided). Each attribute in the title object should be the abbreviation of a language, and its value should be the title of the text in that language.

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/MultiLangString.json

  • URL: url

    Type: string

    Description

    The URL where this data can be retrieved in JSON format

    Format: uri

  • Utterance: utterances

    Type: array

    Description

    A collection of all the Utterances contained in this Text. The DLx specification imposes no requirements regarding how the linguist should segment the text into Utterances. The linguist may decide to segment their text based on intonation units, turns, or any other appropriate linguistic subdivision. The order of Utterances in the collection must reflect their actual order in the Text. Utterances do not have to be JSON unique - an Utterance may be repeated in a text. However, utterances are conceptually unique: each utterance represents a different token of speech.

    Minimum number of items: 1

    Items

    Each item in this array must adhere to the following schema:

    Utterance: utterances

    Type: object

    Description

    An Utterance object

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Utterance.json

Additional Properties

Any additional properties must adhere to the following schema:

This schema imposes no restrictions. All values are valid.

Examples

The following are example values for this schema:

  • {
      "abbreviation": "A1",
      "access": {
        "notes": "This text may be disseminated publicly, provided proper attribution is given to Chief Benjamin Paul and the Chitimacha Tribe."
      },
      "annotations": [],
      "contributors": [
        {
          "familyName": "Paul",
          "givenName": "Benjamin",
          "roles": [
            "speaker"
          ]
        },
        {
          "familyName": "Swadesh",
          "givenName": "Morris",
          "roles": [
            "researcher"
          ]
        }
      ],
      "dateCreated": "2018-10-05T15:26:23.070Z",
      "dateModified": "2018-10-05T15:26:23.070Z",
      "discourseType": "monologue",
      "genre": "folktale",
      "id": "5790c2b7-579c-4bb5-aa5e-537ae1ac06ca",
      "link": "https://explorer.digitallinguistics.io/languages/Chitimacha/texts/A1",
      "location": {
        "abbreviation": "Charenton",
        "address": {
          "locality": "Charenton",
          "region": "Louisiana",
          "country": "United States"
        },
        "name": "Charenton"
      },
      "title": {
        "eng": "How the Indian came (first telling)",
        "ctm": "Qaxt Panx Pinikankx qap cuyi (1)"
      },
      "type": "Text",
      "utterances": [
        {
          "transcription": {
            "Mod": "waxdungu qasi"
          },
          "translation": {
            "eng": "One day a man,"
          },
          "transcript": {
            "Mod": "Waxdungu qasi,"
          },
          "words": []
        }
      ],
      "url": "https://data.digitallinguistics.io/languages/Chitimacha/texts/A1"
    }