База знаний

:warning: Функциональность этого компонента темы была заменена плагином Discourse Docs

Этот компонент темы обеспечивает представление в стиле базы знаний для выбранных категорий.

:link: Ссылка на репозиторий

:link: Предпросмотр в конструкторе тем


Для категорий, включённых в настройках, на навигационных вкладках появляется кнопка KB.

После переключения в этот режим база знаний отображает упрощённую версию списка последних тем.

Нажмите на тег в боковой панели, и список тем автоматически отфильтруется по этому тегу. Вы можете выбрать любое количество тегов, а список тегов будет показывать только те, которые добавлены к отфильтрованным темам, что упрощает навигацию по большим объёмам документации.

Хотите выполнить поиск? Просто введите термин в поле. Результаты поиска также ограничиваются выбранными вами тегами.

Важные замечания

Для работы этого компонента требуется включить следующие настройки сайта: включить тегирование и показывать фильтр по тегу.

В настоящее время у этого компонента темы нет мобильной версии.

Тем не менее, мы работаем над созданием более продвинутой версии этого функционала. Обязательно сообщим вам здесь, на Meta, когда она будет готова!

27 лайков

Этот коммит добавляет базовое мобильное представление.

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

9 лайков

Мы используем Discourse в качестве базы знаний уже более 4 лет и насчитываем около 350 постов, посвящённых именно базе знаний, поэтому это очень радостно!

Не уверен, возможно ли это через компонент темы, но можно ли сделать так, чтобы этот «вид» был по умолчанию при открытии категории? То есть чтобы вместо перехода на /c/knowledge-base автоматически загружался /c/knowledge-base?kb=active?

Мы включили компонент темы KB и он нам очень нравится, но мы беспокоимся, что пользователи не видят вид базы знаний, поскольку используют ранее сохранённую ссылку /c/knowledge-base.

Спасибо за вашу работу над этим.

6 лайков

Я подумаю о добавлении настройки для этого! Спасибо за предложение, и рад, что вы находите это полезным.

6 лайков

Это теперь реализовано как настройка темы. Также теперь поддерживаются подкатегории!

9 лайков

Только что обновлено. Выглядит отлично, спасибо!

3 лайка

Как применить это к подкатегории? Есть ли специальный синтаксис?

Огромное спасибо за это! У нас в сообществе есть категория, которая идеально подходит для применения этого компонента, но мы столкнулись с проблемой: категории не отображаются в выпадающем списке «kb categories», поэтому мы не можем выбрать категорию для применения компонента. Есть какие-нибудь советы?

Вы можете просто ввести slug категории и создать её. Это не совсем интуитивно понятно. Мне пока не удалось понять, как создавать подкатегории, но если ваша категория находится на первом уровне, это довольно просто.

1 лайк

Хм, совсем не интуитивно. Я ввёл название и «создал» категорию, и всё сработало. Но она всё равно не отображается так, как ожидалось.

Я установил свежий Discourse для теста, настроил оба компонента:

br%20a170a9ec422c

(D.I.Y. / diy — это категория, для которой я хочу включить базу знаний, и для неё создана специальная верхняя ссылка с помощью компонента Custom top navigation links)

br%2086f9546a1534

Но категория D.I.Y. отображается в обычном виде:

В URL в конце указано: /c/diy?kb=active

1 лайк

Специального синтаксиса нет — просто введите слаг категории (подкатегории или нет) в настройку темы kb categories, обновите браузер, и всё должно заработать.

Это ограничение настроек темы на данный момент — вам придется ввести слаг вручную, как предложил @Sean_R.

Вам удалось разобраться с этим, @TowerBR? Вы обновили страницу после добавления категории в настройку? Вы нажали кнопку KB? Извините за глупые вопросы, но пытаюсь докопаться до сути.

1 лайк

Сработало, спасибо :slight_smile:

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

Однако я заметил, что если переходить к категории через выпадающий список, то представление базы знаний не переключается автоматически.

Все остальные способы навигации работают, кроме выпадающего списка подкатегорий.

2 лайка

У вас включена опция default to kb view? Я только что протестировал это на одном из своих сайтов, и с подкатегориями всё работало.

2 лайка

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

Странно, хорошо. Если сможете воспроизвести это стабильно, дайте знать — я посмотрю. Мне не удавалось вызвать такое поведение с помощью выпадающего списка подкатегорий.

2 лайка

Да, я уже сделал это, посмотрите на скриншот в предыдущем посте:

br%2086f9546a1534

Я удалил компонент «Ссылки верхней навигации». Теперь это полностью «чистая» установка:

br%20346e44618d61

Да, и я очистил кэш.

Да. Когда я выбираю категорию через главное выпадающее меню, страница категории уже загружается с /c/diy?kb=active в конце URL. При наведении на кнопку KB отображается «обычный» URL без этого «дополнения», но при нажатии на неё ничего не происходит.

Используете ли вы последнюю версию компонента темы? Для вашей версии Discourse используется ветка tests-passed или stable?

2 лайка

Это происходит каждый раз. Я могу просто нажать «KB» или обновить страницу, и это исправляет проблему, но не когда я перехожу в категорию через выпадающее меню.

Да:

params:
   version: tests-passed
3 лайка

Это здорово! Только что установил, чтобы посмотреть, и вижу, что это уже очень полезно.

Этот компонент темы действительно, похоже, конфликтует с https://meta.discourse.org/t/knowledge-base-plugin/115288 от @angus. Могу подтвердить, что плагин нужно удалить перед включением этого компонента темы, иначе при просмотре категории базы знаний происходит следующее. Обратите внимание на странную горизонтальную линию рядом с меню и вращающийся круг.

Хотел бы услышать больше о продвинутой версии и о том, что вы планируете. Вот несколько отзывов:

  • баг? Когда вы выбираете тег из левого меню для фильтрации по этому тегу, а затем переходите в другую категорию или в «Последние» и т.д., то при следующем нажатии на «База знаний» для возврата к ней вы обнаружите, что фильтрация по этому тегу всё ещё активна.
  • когда вы нажимаете на тег под заголовком, вас перекидывает на страницу тега, а не на отфильтрованный вид базы знаний, как это происходит при нажатии на тег в левом меню.
  • при нажатии на заголовок категории тегов в левом меню вас перекидывает на вид «Последние» для этой категории. Я бы предложил не делать эту ссылку активной. Заголовок категории, вероятно, тоже не должен содержать #, так как это отвлекает.
  • было бы удобно видеть количество тем с каждым тегом в левом меню.
  • было бы удобно иметь возможность сортировать темы базы знаний в алфавитном порядке или даже в произвольном порядке.
4 лайка