Guidelines

OCTRA enables to define transcription guidelines. The guideline files can be found in ./config/localmode/guidelines/. For each language set in the projectconfig.json file you need to create one guidelines_[lang].json file. For example, if "languages" in projectconfig is set to ["de", "en"] you need to create one guidelines_de.json and one guidelines_en.json.

To create a new guidelines_.json file you can duplicate one of the files that already exist and change it to your wish.

Structure of guidelines

Example structure:

{
  "meta": {
    "object_language": "deu",
    "language": "de",
    "project": "Sprecherinnen",
    "authors": "Test Person (testperson@email.de)",
    "version": "1.0",
    "date": "2017-04-10",
    "encoding": "UTF-8",
    "validation_url": "config/localmode/functions.js"
  },
  "instructions": [
    {
      "group": "Rechtschreibung",
      "entries": [
        {
            "code": "R02",
            "priority": 100,
            "title": "verschliffene Formen",
            "description": "verschliffene oder verkürzte Formen in der langen Form schreiben.",
            "examples": [
                {
                    "annotation": "\"gibt es\" für \"gibt's\" \"haben wir\" für \"hammwa\" usw.",
                    "url": ""
                }
            ]
        }
      ]
    },
    {
      "group": "Marker",
      "entries": [
        {
          "code": "M01",
          "priority": 100,
          "title": "Marker sparsam verwenden!",
          "description": "Marker nur setzen, wenn sie den Sprachfluss stark beeinträchtigen.",
          "examples": []
        },
        {
          "code": "M02",
          "priority": 100,
          "title": "Nonverbale Sprechergeräusche",
          "description": "Nonverbale Sprechergeräusche wie Husten, Lachen, Schmatzen usw. werden mit <usb> und Leerzeichen vor jedem betroffenen Wort markiert. ",
          "examples": []
        }
      ]
    }
  ],
  "markers": [
    {
      "id": 1,
      "name": "truncation marker start",
      "code": "[~abc]",
      "type": "normal",
      "icon_url": "assets/img/components/transcr-editor/default_markers/truncation_start.png",
      "button_text": "~abc",
      "description": "Diesen Marker nur am Anfang setzen, sollte die Audiosequenz mit einem abgeschnittenem Wort beginnen",
      "shortcut": {
        "mac": "ALT + 1",
        "pc": "ALT + 1"
      }
    },
    {
      "id": 2,
      "name": "filled pause",
      "code": "<nib>",
      "type": "normal",
      "icon_url": "assets/img/components/transcr-editor/default_markers/fil.png",
      "button_text": "Gefüllte Pause",
      "description": "Für Zögern des Sprechers wie hm, ähm, äh und andere.",
      "shortcut": {
        "mac": "ALT + 2",
        "pc": "ALT + 2"
      }
    }
  ]
}

Options

• meta: Contains all meta data

  • meta.object_language: The spoken language
  • meta.project: project which uses this guidelines
  • meta.authors: names of the authors separated by commas
  • meta.version: version of this guidelines.
  • meta.date: Date of last change
  • meta.encoding: Encoding of this file. (e.g. UTF-8)
  • meta.validation_url: Url where the functions.json file is hosted. More information about function.js

• instructions: Array of guidelines (by name)

  • group: Name for the group. This is equal to the title that will be visible
  • entries: Array of instructions
    • code: Unique identifier. This is required for validation.
    • priority: Priotrity as number. This. could be needed for validation.
    • title: Title for instruction
    • description: Descrioption for instruction
    • examples: Array of examples
      • annotation: Annotation text
      • url: Media URL (to audio file or mp4 file)

• markers: Array of markers

  • id: Unique number for this marker. It is recommended to start with 1
  • name: Name for this marker in English
  • code: Text marker that is used to replace the associated image marker
  • type: "normal" or "break". "break" means that there is no speech
  • icon_url: URL to the image icon
  • button_text: Text that is visible to the user. This should be translated for each language.
  • description: Description. This should be translated for each language.
  • shortcut:
    • mac: Shortcut for MacOS systems.
    • pc: Shortcut for Windows or Linux systems.