Документация и инструкции

To Kaiten

Содержание в Документах

Теперь в Документах автоматически создается Содержание. Добавьте заголовки и Kaiten сам сформирует структуру. Содержание поможет быстро ориентироваться в длинных текстах и переходить к нужному разделу в один клик.

Функция уже доступна облачным клиентам Kaiten. Для on-premise — после обновления до последней версии.

Так выглядит содержание этого анонса. Вы можете нажать на любой заголовок и прейти к нужному блоку:

Как добавить содержание в документ

Раньше приходилось создавать оглавление вручную из якорных ссылок для публичного доступа и внутреннего. Теперь всё делается автоматически – достаточно добавить в документ заголовки: H1, H2 и H3.

В режиме редактирования содержание находится в правой панели в виде удобного списка.

Если заголовков нет — содержание не отображается. Содержание обновляется автоматически при любых изменениях текста: добавили заголовок — он появился в содержании, удалили — исчез.

Структура строится с учетом вложенности:

  • заголовки верхнего уровня идут выше,

  • подзаголовки отображаются с отступом,

  • если документ начинается с H2 и нет H1, система покажет его как заголовок первого уровня — это упрощает навигацию.

Содержание в меню быстрых команд

С помощью быстрой команды Кайтен сгенерирует содержание в любой части документа. Это удобно, так как читатель сразу увидит структуру и сможет перейти к нужному блоку.

Как добавить содержание в текст документа:

  1. Нажмите «+» в области редактирования или введите «/».

  2. Выберите «Содержание документа».

Если вы поменяете блоки или заголовки местами, то изменения в содержании отобразятся автоматически.

Как содержание работает в публичной Базе знаний

В опубликованных в публичную Базу знаний документах содержание находится за знаком книжки с подписью «Содержание». По клику список раскрывается. В нем видны все заголовки статьи.

Нажмите на нужный заголовок и сразу перейдете в этот раздел без лишних скролов и поиска по документу.

В мобильном приложении значок содержания находится рядом со строкой поиска: