Переход на шаблон читательского интерфейса Next

Переход на шаблон читательского интерфейса Next обеспечивает более высокую производительность, современный дизайн и множество встроенных возможностей. Его архитектура отличается от остальных шаблонов, поэтому часть существующих настроек (пользовательские скрипты, отдельные параметры интерфейса, футеры) потребуют корректировки. Подробнее о преимуществах и ограничениях читайте здесь: Новый шаблон Читательского интерфейса Next.

В этом разделе описан процесс перехода, который поможет перевести портал на новый шаблон.

Шаг 1. Выберите вариант тестирования

Прежде чем применять новый шаблон к рабочей документации, протестируйте его. Выберите вариант, который подходит под ваш процесс:

Шаг 2. Очистите шаблон страницы

В шаблоне Next навигационные элементы встроены изначально. Если раньше вы добавляли для них скрипты или сниппеты в Шаблон страницы, удалите их, иначе элементы будут продублированы:

  • Ссылки на предыдущую и следующую страницу: создаются автоматически.
  • Кнопка возврата к началу страницы: встроена в шаблон.

Шаг 3. Настройте параметры и брендинг

В шаблоне Next реализован новый подход к настройкам: сам интерфейс остаётся легковесным, а более сложная кастомизация вынесена в CSS.

  1. Проверьте настройки читательского интерфейса: шаблон Next поддерживает только часть настроек читательского интерфейса. Всё остальное оформление (например, шрифты, стили заголовка и боковой панели) нужно перенести в Branding.css. Смотрите: Расширенный брендинг с помощью CSS.
  2. Обновите CSS-селекторы: HTML-разметка шаблона Next отличается от других шаблонов. Существующие CSS-правила и скрипты брендинга работать не будут — их придётся переписать.
При переходе на новый шаблон настройки интерфейса текущего шаблона не сохраняются.

Шаг 4. Перенесите футеры и обновите API документацию

Два структурных элемента переносятся по особым правилам:

Шаг 5. Примените шаблон ко всему порталу

Когда результат в тестовом окружении вас устроит, примените шаблон Next глобально:

  1. Включите шаблон Next на уровне портала.
  2. Снимите переопределения шаблона, которые вы задали для тестовых проектов или публикаций на шаге 1, чтобы к ним применились новые настройки портала.

В результате документация будет отображаться с импользованием шаблона Next: страницы загружаются быстрее, интерфейс соответствует стандарту WCAG 2.2 AA, URL без hashbang (#!) корректно индексируются поисковыми системами и ИИ-агентами, а навигация работает встроенными средствами, без пользовательских скриптов.

Часто задаваемые вопросы о переходе

Перестанут ли работать ссылки, которые читатели добавили в закладки? Нет. Шаблон Next не использует hashbang в URL, поэтому адреса страниц меняются, но Документерра автоматически перенаправляет старые адреса на новые. Ссылки из закладок и ссылки, встроенные в ваше приложение, продолжат открываться.
Можно ли перевести на новый шаблон только часть документации? Да. Шаблон читательского интерфейса переопределяется на уровне проекта и на уровне публикации, поэтому во время перехода Next может работать параллельно с другим шаблоном. Смотрите: Переопределение шаблона на уровне проекта или публикации.
Можно ли вернуться обратно, если что-то пойдёт не так? Да, но настройки шаблона, с которого вы уходите, не сохраняются. При возврате на прежний шаблон настройки его читательского интерфейса придётся задать заново.