Категории документации Discourse

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

Вам нужно лишь убедиться, что включена опция doc categories enabled, а затем создать индексную тему в категории, добавив её в поле «Индексная тема» в настройках категории. Если в настройках старого плагина Docs всё ещё указана категория, удалите её оттуда.

Привет, Хью, спасибо за быстрый ответ! Если я упомянул плагины Docs, приношу извинения. У меня здесь установлен только плагин Doc Categories.

Вот полезный отчёт для поиска тем, которые не были проиндексированы. Пока у меня всего две тестовые темы.

А вот экран настроек. Я знаю, что уже близко к решению, но где-то упускаю один или два шага! Спасибо!

Вы настроили параметр категории?

Также, как выглядит ваш индекс? Он структурирован так?

Привет, Марк! Да, категория, очевидно, установлена через отчёт выше, верно? Но вот она.

Страница категории выглядит так:

Я понимаю, что что-то упускаю. Что вы имели в виду под этой страницей: она структурирована так?

Эта ссылка ведёт к индексу раздела Documentation на Meta. Ваша назначенная тема должна выглядеть похоже на неё, чтобы индекс мог быть сгенерирован. Судя по вашим скриншотам, я думаю, вы что-то неправильно поняли или прочитали. Прочитайте отсюда.

Кстати, немного не по теме, но всё же: нужен ли мне плагин темы боковой панели, чтобы индекс также отображался справа? Или это происходит автоматически? Спасибо!

Не совсем понятно, что вы имеете в виду. Насколько я понимаю, боковая панель является частью ядра по умолчанию, а не плагином.

Понял, вы имели в виду разделы заголовков/подзаголовков? Я искал это в редакторе, но для меня (по крайней мере) не было очевидно, нужны ли мне заголовки вроде HTML

и тому подобное. Еще раз спасибо за быстрые ответы!

Заголовки — h1, ссылки оформлены в виде маркированного списка. Вы можете просто скопировать и вставить мета-индекс — это должно дать вам пример для начала, если вы испытываете трудности.

Таким образом:

## что-то полезное
* это то: https://forum.example.tld/t/777
* это другое: https://forum.example.tld/t/666

И так далее

Я ленив, поэтому не делал это вручную, а использовал ИИ форума.

1 лайк

Спасибо. Я скопировал часть индекса документации выше, как предоставил @MarcP, но не вижу бокового индекса, что странно, если только я снова что-то упускаю…

Этот скриншот не показывает структуру. Вы уверены, что используете форму

* description: url

и указываете имя, URL или ID этой темы в настройках соответствующей категории?

Так?

1 лайк

Да. Если вы видите что-то подобное в Composer (не обращайте внимания на довольно странный язык, суть должна быть понятна):

Это используется в меню-гамбургере для отображения 20 самых реактивных тем в категории #koiramaailma. Что-то вроде рекламного окна.

## Топ-20 самых реактивных тем

* Что, чёрт возьми, происходит в ветеринарии 🤬: https://foorumi.katiska.eu/t/mita-helvettia-elainlaakinnassa-tapahtuu/6772
* Реклама сухого корма: Смешные реальные случаи: https://foorumi.katiska.eu/t/kuivamuonamainokset-hassut-aidot-tapaukset/479

Эти описания не отображаются в боковой панели.

1 лайк

Что ж, как видите, справа ничего нет :frowning:

Если это кому-то поможет, вот список установленных мною плагинов…

    cmd:
      - git clone https://github.com/discourse/docker_manager.git
      - git clone https://github.com/discourse/discourse-solved.git
      - git clone https://github.com/discourse/discourse-user-notes.git
      - git clone https://github.com/discourse/discourse-openid-connect.git
      - git clone https://github.com/discourse/discourse-ai.git
      - git clone https://github.com/discourse/discourse-yearly-review.git
      - git clone https://github.com/paviliondev/discourse-custom-wizard.git
      - git clone https://github.com/discourse/discourse-doc-categories.git
      - git clone https://github.com/discourse/discourse-reactions.git
      - git clone https://github.com/discourse/discourse-akismet.git
      - git clone https://github.com/discourse/discourse-data-explorer.git
      - git clone https://github.com/discourse/discourse-oauth2-basic.git
      - git clone https://github.com/discourse/discourse-assign.git
      - git clone https://github.com/discourse/discourse-templates.git
      - git clone https://github.com/discourse/discourse-policy.git
      - git clone https://github.com/discourse/discourse-gamification.git
      - git clone https://github.com/discourse/discourse-category-experts.git
      - git clone https://github.com/merefield/discourse-ai-topic-summary.git
      - git clone https://github.com/MonDiscourse/discourse-formatting-toolbar.git
      - git clone https://github.com/discourse/discourse-custom-topic-lists.git
      - git clone https://github.com/thoka/discourse-send-pdf-inline.git
      - git clone https://github.com/discourse/discourse-prometheus.git
      - git clone https://github.com/communiteq/discourse-user-response-times.git
      - git clone https://github.com/discourse/discourse-fingerprint.git
      - git clone https://github.com/discourse/discourse-bcc.git
      - git clone https://github.com/featheredtoast/discourse-pushover-notifications.git
      - git clone https://github.com/discourse/discourse-saved-searches.git

Обычно боковая панель находится слева (красная). Боковая панель документации просто заменяет содержимое по умолчанию. Справа (фиолетовая) вы видите оглавление, которое добавляется компонентом темы DiscoTOC - automatic table of contents.

Да, DiscoTOC — это тоже установленный компонент темы. У меня тоже не получается его запустить. Что-то не так…

Не уверен, но ваши скриншоты нечеткие. Вы делаете скриншот, и боковая панель вообще не отображается? Не отображается ли боковая панель документации? Или боковая панель не отображается вообще (она не просто скрыта, попробуйте нажать =)

Редактирование: подумав об этом, вы должны четко указать, у вас ли проблемы с discoTOC (оглавление для автора оригинала) или с doc-categories (боковая панель индекса документации)

1 лайк

Привет, Марк!

Так что DiscoTOC работает. Я вернулся и перепроверил — действительно, после того как зайти в настройки и вставить TOC, как указано в инструкции, создаётся боковое оглавление.

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

У меня просто есть странное чувство, что это очень простое исправление, но я пока не дошёл до него :frowning:

Я не вижу боковых панелей на ваших скриншотах — на всех показан только контент сообщения. Не могли бы вы опубликовать скриншот полного экрана Discourse, когда вы находитесь в категории, где должен отображаться индекс?

3 лайка