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