Визуальный редактор индекса для категорий документов Discourse

В категориях «Документация» теперь можно создавать боковое меню индексации прямо в административном интерфейсе. Редактор индексов — это нововведение для плагина Doc Categories, которое устраняет необходимость в отдельной теме для индекса.

Два способа формирования индекса

При редактировании категории теперь доступна вкладка Индекс документации с выбором режима:

  • Редактор позволяет формировать индекс на месте, создавая разделы со ссылками.
  • Тема-индекс — это привычное поведение, когда заголовки и списки внутри темы формируют индекс.
  • Отключено полностью отключает боковой индекс для данной категории.

Категории, которые уже указывают на тему-индекс, будут работать так же, как и раньше.

Создание индекса

Раздел содержит ссылки, каждая из которых ведёт либо на тему, либо на любой указанный URL. Каждую ссылку можно снабдить собственной иконкой, а редактор предупредит вас, если две ссылки ведут в одно и то же место или если у двух разделов одинаковые названия.

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

Раздел Автоматическая индексация автоматически заполняется темами из категории, поэтому важные страницы можно перечислить вручную, а все остальные будут собраны в одном месте. Он может обновляться при каждом сохранении.

Разделы и ссылки можно перетаскивать для изменения порядка. Каждый маркер перетаскивания также является обычной точкой таб-навигации, открывающей меню перемещения, поэтому весь индекс можно сортировать с клавиатуры. Пакетный режим поддерживает множественный выбор, позволяя удалять несколько строк сразу или перетаскивать весь выделенный блок.

Включите на своём сайте

Редактор индексов — это экспериментальная функция, готовящаяся к внедрению. Включите Редактор индексов категорий «Документация» по адресу /admin/config/upcoming-changes. Это изменение влияет только на категории «Документация» и отображается только администраторам при редактировании такой категории.

Будем рады обратной связи

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

14 лайков

Исходный PR FEATURE: Add visual doc category index editor - Pull Request #87 - discourse/discourse-doc-categories - GitHub только что был объединен как экспериментальное изменение (upcoming change); скорее всего, функциональность будет дополнительно дорабатываться в течение следующей недели-двух, прежде чем мы переведем ее в статус Alpha.

1 лайк