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