Автоматическое оглавление страниц в Joomla

Оглавление помогает читателю оценить содержание длинной статьи и сразу перейти к нужному разделу. В Joomla его можно сформировать из заголовков с помощью Quick Index. Разберём структуру материала, вставку оглавления, возможности бесплатной и платной редакций и вывод содержания в боковой колонке.

Что умеет Quick Index

Quick Index создаёт список ссылок на разделы по заголовкам в тексте. Когда вы добавляете или переименовываете раздел, не нужно отдельно исправлять оглавление вручную.

На момент подготовки этой редакции актуальна версия Quick Index 5.1.0. Разработчик заявляет совместимость с Joomla 4, 5 и 6 и требует PHP 8.2 или новее. Совместимость расширения с Joomla 4 не означает, что эту ветку стоит выбирать для нового сайта. Для Joomla 3 предназначались старые выпуски плагина, инструкция по актуальной версии к ним не относится.

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

Подготовьте заголовки статьи

Оглавление должно отражать структуру текста. Используйте в редакторе настоящие заголовки H2 и H3, а не обычные абзацы с крупным жирным шрифтом.

Название материала обычно выводится шаблоном как H1. В таком случае начинать тело статьи со второго H1 не нужно. Основные разделы оформляйте H2, подразделы внутри них — H3. Не выбирайте уровень заголовка только ради размера букв.

Пример структуры тела материала:

<h2>Подготовка</h2>
<p>Что понадобится перед началом работы.</p>
<h3>Проверка версии</h3>
<p>Как определить версию установленной Joomla.</p>
<h3>Резервная копия</h3>
<p>Какие данные сохранить перед изменениями.</p>
<h2>Настройка</h2>
<p>Последовательность действий.</p>

Не добавляйте идентификаторы в заголовки вручную ради Quick Index. Генерацию якорей выполняет плагин. После изменения структуры проверьте переходы на странице.

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

Установите и включите плагин

Сначала проверьте расширение на копии сайта. Устанавливайте пакет, подходящий для вашей версии Joomla и PHP.

1. Откройте установку расширений Joomla: Система → Установка → Расширения.
2. Загрузите установочный ZIP-пакет Quick Index.
3. Откройте список плагинов и найдите Quick Index. В английском интерфейсе его название — System - Regular Labs - Quick Index.
4. Убедитесь, что плагин включён.

В Quick Index 5.1.0 откройте вкладку Security → Process Tags. Здесь отдельно задаётся обработка тегов в материалах, компонентах и других областях страницы. Если тег не срабатывает, проверьте соответствующую область. Не включайте обработку сразу везде только ради устранения одного случая. Некоторые названия и пояснения остаются английскими даже в русской панели Joomla.

Добавьте оглавление в материал

Для ручной вставки оглавления достаточно бесплатной редакции. Поставьте тег {index} отдельным абзацем перед первым заголовком, который должен попасть в содержание.

Удобное место — после короткого вступления, перед первым разделом. Если оглавление не должно показываться в анонсе материала, расположите его после разделителя «Подробнее».

<p>{index}</p>
<h2>Подготовка</h2>
<p>Текст раздела.</p>
<h2>Настройка</h2>
<p>Текст раздела.</p>

Quick Index собирает заголовки после тега. Если поставить его посередине статьи, предыдущие разделы в это оглавление не попадут.

Для собственного названия блока используйте параметр title, например {index title="Содержание"}. Именно такой вариант показан на скриншотах.

Чтобы завершить область обработки, используйте {/index}. Следующий открывающий тег {index} тоже начинает новую область. Это полезно, когда в длинном материале нужны отдельные списки для разных частей.

Для маркированного списка можно использовать {index ordered="false"}. Чтобы исключить отдельный заголовок, назначьте ему класс noindex. Целый фрагмент можно окружить тегами {noindex} и {/noindex}. Это исключение из оглавления Quick Index, а не запрет индексации страницы поисковиками.

Чем отличаются Free и Pro

Бесплатной редакции достаточно для оглавления, которое автор вставляет тегом в нужное место. Pro добавляет автоматическую вставку и дополнительные способы вывода и оформления.

Например, в Pro тег {index min="2" max="3"} ограничивает оглавление уровнями H2–H3. Не используйте параметры платной редакции как инструкцию для Free.

Включите Auto Index для категории

Auto Index в Pro автоматически добавляет оглавление в начало материалов. Эта возможность удобна для раздела с однотипными длинными руководствами.

В настройках Quick Index включите Auto Index. Через Categories выберите режим Include, а в Selection укажите нужные категории. Режим Exclude, наоборот, исключает выбранные категории из автоматической вставки.

Параметр Also on child items определяет обработку вложенных категорий:

• No — только выбранная категория.
• Yes — она и её потомки.
• Only — только потомки без самой выбранной категории.

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

Выведите оглавление в модуле

Quick Index Pro позволяет показать оглавление текущей статьи в другом месте страницы, например в боковой колонке. В самой статье уже должно быть оглавление, созданное через {index} или Auto Index. Включать Auto Index специально для этого необязательно.

1. Создайте модуль с произвольным HTML-содержимым.
2. Вставьте отдельным абзацем {index article="current"}.
3. Назначьте модулю подходящую позицию шаблона и нужные пункты меню.
4. Проверьте результат на странице отдельного материала Joomla.

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

Если нужен определённый материал, вместо current укажите его ID, например {index article="12"}. Число 12 — пример, замените его реальным ID своей статьи.

Если на странице виден исходный тег, проверьте разрешённые области обработки Quick Index. Настройки обработки содержимого модуля и ограничения плагина — разные вещи.

Проверьте удобство навигации

Правильный список ещё не гарантирует удобную работу на всех экранах. После настройки проверьте страницу с её настоящим шаблоном.

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

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

Для CSS-класса в поле настроек вводите имя без точки, например table-of-contents. Точка используется в CSS-селекторе .table-of-contents, а не в имени класса.

Если оглавление не работает

Начните с простого материала: тег {index} отдельным абзацем и два заголовка H2 после него. Так легче отделить проблему плагина от особенностей разметки или шаблона.

Если тег остаётся текстом, проверьте включение Quick Index, разрешения обработки и отсутствие лишних HTML-тегов внутри самого шорткода. Если раздел пропущен, проверьте его уровень, положение относительно {index} и исключения noindex.

Если список появился, но выглядит неудачно, проверьте стили шаблона и классы оформления. Внешний вид списка и сбор заголовков — разные части настройки.

Итог

Для оглавления в отдельном материале Joomla начните с правильной структуры заголовков и тега {index}. Pro имеет смысл, если нужны автоматическая вставка по категориям, ограничение уровней или вывод в модуле. После настройки проверьте переходы, мобильную версию и длинные статьи: оглавление должно сокращать путь к нужному разделу, а не мешать чтению.