Модель результатов проверки версия 1.2017-04-12

{
  kinds: {                 // Подписи к типам ошибок (только те, которые встречаются в отчёте)
    mkSpelling: 'орфография', 
    mkTypography: 'типографика' 
  },
  annotations: [           // массив обнаруженных проблем
    {
      id: Int,               // Идентификатор аннотации
      kind: String,          // Тип ошибки Litera5.OrthoKind или Litera5.CiceroKind
      selection: String,     // Кусочек текста, который содержит ошибку
      position: [            // Координаты позиций в файле ogxt где находится selection (может быть несколько, например для повторяющихся частей текста)
        {            
          start: Int,            // начало выделения
          end: Int               // конец выделения
        }
      ],
      description: String,   // Описание ошибки
      suggestion: String,    // Подсказка (что сделать с ошибкой), здесь могут быть линки <a> data-kind — это тип действия, 
                             // data-kind — какое значение нужно в это действие подставить. 
                             // Так же часть подсказки может быть выделена при помощи тэга  — это более подробное место ошибки,
                             // например, ошибочная буква
      suggestionId: String,  // Идентификатор аннотации из которой нужно взять подсказку бывает или suggestion, или suggestionId
      explanation: String,   // Подробное объясление ошибки со ссылкой на библиотеку правил или первоисточники
      rule: String,          // Внутренний номер нарушенного правила
      group: String,         // Идентификатор группы, когда несколько аннотаций логически сгруппированы в одну суть. Например, однокоренные слова для синонимов
    },
    {
      id: 7,
      kind: 'mkTypography',
      selection: '.',
      position: [Object],
      description: 'отсутствует пробел',
      suggestion: 'вставьте пробел после точки: <a title="заменить на этот вариант (Alt-Insert)">. </a>',
      explanation: 'после запятой, точки, двоеточия, точки с запятой, восклицательного и вопросительного знака ставится пробел <a href="/типографика/пробел_и_знаки_пунктуации/">типографика 6.2</a>',
      rule: 'f.6.2' 
    },
    { 
      id: 6,
      kind: 'mkSpelling',
      selection: 'пейсател',
      position: [Object],
      description: 'неизвестное слово, возможно, опечатка',
      suggestion: '<a title="заменить на этот вариант (Alt-Insert)">пейс<u>а т</u>ел</a>',
      explanation: 'при наборе текста мог быть случайно пропущен пробел <a href="/орфография/пропуск_или_вставка_пробела/">орфография 7.2<a/>',
      rule: 'a.7.2' 
    }
  ],
  water: {                   // Результаты базовой проверки текста на водность
    content: 0.23            // Доля водных слов в тексте (в данном случае 23%)
  },
  collocations: {            // Результаты базовой проверки текста на частотные сочетания
    bigram: 0.01,            // Доля частотных повторений из двух слов в тексте (в данном случае 1%)
    trigram: 0.012,          // Доля частотных повторений из трёх слов в тексте (в данном случае 1.2%)
    ngram: 0.00              // Доля частотных повторений из четырёх и более слов в тексте (в данном случае 0%)
  }
}