Проверка TEI-файла: валидность и ошибки
Проверка отвечает на два вопроса: правильно ли устроен файл и соответствует ли он схеме. Синтаксические ошибки не дают открыть файл, структурные ломают сборку и указатели. Ниже — порядок проверки и типичные ошибки.
Что проверять
Проверка файла отвечает на два разных вопроса: правильно ли он устроен и соответствует ли он правилам схемы. Первое — синтаксис, второе — структура. Ошибки первого типа не дают открыть файл, ошибки второго — ломают сборку и указатели.
Синтаксис
Незакрытые элементы, неверно вложенные теги, лишние символы, неэкранированные знаки. Такие ошибки видны сразу при открытии файла в редакторе с проверкой. Исправлять их нужно до любой другой проверки.
Схема
Схема описывает допустимые элементы и их порядок. Проверка по схеме выявляет элемент не на месте, отсутствие обязательного блока, недопустимый атрибут. Схему берут из проекта и не меняют ради того, чтобы файл прошёл проверку.
Типичные структурные ошибки
Примечание вне ожидаемого места, заголовок без уровня, текст вне абзаца, повторяющийся идентификатор, пустой обязательный элемент. Каждая ошибка имеет понятное сообщение, если проверять по схеме, а не на глаз.
Порядок исправления
Сначала синтаксис, затем схема, затем ссылки и идентификаторы. Исправление структуры может изменить привязки, поэтому ссылки проверяются после. Обратный порядок приводит к повторной работе.
Чтение сообщений
Сообщение об ошибке указывает строку и ожидаемый элемент. Не спешите править по одному сообщению: часто одна ошибка порождает десяток следующих. Исправьте первую и проверьте снова.
Идентификаторы
Проверьте уникальность идентификаторов. Дубликаты ломают ссылки и указатели, но не всегда видны при обычной проверке. Отдельный прогон по списку идентификаторов занимает секунды.
Кодировка
Файл должен быть в UTF-8, без посторонних символов в начале. Испорченная кодировка проявляется как странные знаки вместо букв. Это частая проблема при сборке файлов из разных источников.
Переводы строк
Смешанные переводы строк редко ломают проверку, но мешают сравнению версий. Приведите файлы к одному виду перед слиянием. Это часть подготовки, а не отдельная задача.
Инструменты
Подойдут редактор с проверкой схемы, командные утилиты проверки, онлайн-валидаторы. Онлайн-сервисы не стоит использовать для закрытых текстов. Для чувствительных материалов проверка выполняется локально.
Автоматизация
Проверку стоит запускать одной командой и после каждой крупной правки. Ручной запуск забывается. Результат сохраняется в журнал, чтобы видеть, когда проверка проходила.
Что делать с предупреждениями
Предупреждения не всегда означают ошибку, но их стоит разобрать. Накопленные предупреждения маскируют настоящие проблемы. Если предупреждение неважно, зафиксируйте почему.
Проверка после сборки
После сборки итогового файла проверка повторяется. Сборка может добавить или потерять элементы. Проверять только исходные файлы недостаточно.
Документация ошибок
Заведите короткий список встреченных ошибок и способов исправления. Он экономит время новым участникам и помогает не повторять одни и те же правки. Пять строк на ошибку достаточно.
Типичные ошибки проверки
Проверка на глаз, исправление по одному сообщению, отсутствие проверки после сборки, правка схемы под файл, проверка в онлайн-сервисе для закрытых данных.
Итог
Файл готов, когда проходит синтаксис, схему и проверку идентификаторов, а результат проверки сохранён.
Что делать, если проверка недоступна
Если инструмент проверки недоступен, используйте редактор с подсветкой и минимальный набор правил: закрытые элементы, корректная вложенность, уникальные идентификаторы, отсутствие текста вне абзацев. Это не заменяет полную проверку, но ловит грубые ошибки до того, как они попадут в сборку.
Проверка ссылок и привязок
Отдельно проверьте, что каждая ссылка ведёт на существующий идентификатор, а каждое примечание привязано к фрагменту. Такие ошибки не ловятся схемой, но ломают навигацию. Прогон по списку идентификаторов занимает минуты и экономит часы ручного поиска.
Что делать с ошибками, которые не воспроизводятся
Если проверка проходит на одном компьютере и падает на другом, сравните версии инструмента и кодировку файла. Разное окружение — частая причина расхождений. Зафиксируйте версии в описании проекта, чтобы результат можно было повторить.
Итог по инструментам
Инструмент важен меньше, чем регулярность проверки. Одна и та же команда, запускаемая после каждой правки, надёжнее, чем редкая проверка на мощном редакторе.
Как объяснить ошибку коллеге
В сообщении об ошибке укажите файл, строку, ожидаемый элемент и что именно нарушено. Этого достаточно, чтобы человек исправил сам. Формулировка «файл не проходит» отправляет разбираться заново.
Чек-лист
- Проверен синтаксис файла.
- Файл проверен по схеме проекта.
- Идентификаторы проверены на уникальность.
- Кодировка и переводы строк приведены к одному виду.
- Проверка повторена после сборки итогового файла.
- Результат проверки сохранён в журнал.
- Встреченные ошибки описаны для команды.
Частые вопросы
С чего начинать?
С синтаксиса, затем схема, затем идентификаторы и ссылки.
Можно ли править схему под файл?
Нет, схема фиксирует правила проекта.
Что проверять после сборки?
Итоговый файл, а не только исходные.
Пример
Сборка падала на одном и том же месте. Причина оказалась в дубликате идентификатора: проверка по схеме его не видела. После отдельного прогона по идентификаторам сборка прошла.
Итог
Файл готов, когда проходит синтаксис, схему и проверку идентификаторов, а результат сохранён.