Публикации

Регистрация

skin49 1

Плагин Quick Index предназначен для создания оглавлений (меню) статей joomla. С его помощью этот процесс происходит гораздо быстрее. Не требуется расставлять якоря, плагин сам считывает информацию. Quick Index – идеальный инструмент для сайтов, на которых регулярно публикуют объёмные статьи (более 5000 знаков), инструкции, руководства, учебники.

 

Меню статьи

 
 

Как использовать плагин

Версия, ссылка на источник, установка. Основная функция.

Настройки плагина

Основные вкладки: описание, оформление, поведение, синтаксис тегов и дополнительные параметры

Дополнительные возможности

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

Отличие версии PRO

Новые настройки в плагине. Вывод через модуль

 

Как использовать плагин

Последняя версия - 2.2.1 (обновлено в феврале 2019), подходит для joomla 3.9.0-3.x. Страница для скачивания на сайте разработчика: https://www.regularlabs.com/extensions/quickindex/features.

Устанавливается через «менеджер расширений».

skin49 2

После установки плагин по умолчанию активирован. Без лишних настроек начнём пользоваться. Откроем материал. Меню создается на основе подзаголовков статьи, при необходимости некоторые из них исключают. Для создания оглавления достаточно разместить в начале статьи (или после введения) тег index в фигурных скобках – {}. Плагин Quick Index распознает все подзаголовки после тега index и выведет их в том месте, где стоит тег.

skin49 3

Настройки плагина

Откроем QuickIndex и увидим вкладку с описанием, вкладки «Поведение», «Оформление», «Синтаксис тегов» и «Дополнительные параметры». В каждой видны настройки, доступные в версии PRO.

skin49 4

Оформление

Во вкладке «Оформление» первый параметр – это название стиля оформления блока с оглавлением. На стандартных шаблонах джумла, оглавление выводится с серым фоном и с еле заметным обрамлением. И называется такой стиль оформления well, он стилизован под Bootstrap. В нашем примере – фон белый, границ нет, поскольку шаблон создан не с помощью Bootstrap.

Если оформление не устраивает, можно присвоить любое имя класса и сменить стиль оглавления с помощью CSS кода (помещается в таблицу стилей шаблона).

Следующий параметр – имя тега, с помощью которого задаются команды, выполняемые плагином QuickIndex. Тег оглавления – index.

Далее идет имя класса заголовков – indexed.

Параметр, с помощью которого задают номера пунктам оглавления, доступен в версии PRO.

Поведение

Во вкладке «Поведение» можно задать заголовок для оглавления, например, «Меню статьи». При вводе заголовка появляется дополнительная опция – задать уровень заголовка. Логично поставить Н2.

Следующий доступный параметр – Упорядочивать список или нет. Если выбрать опцию «да», у каждого пункта будет номер (у подпунктов нумерация начнётся с цифры 1). Если выбрать «нет», номеров не будет. По умолчанию список нумерованный.

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

skin49 5

Синтаксис тегов

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

  • тег оглавления – задать свой, тогда indexне будет работать,
  • тег noindex, прописать свой вариант,
  • скобки – по умолчанию стоят фигурные.

skin49 6

Вкладка «Дополнительные параметры»

На последней вкладке уместилось множество настроек:

  1. Теги «отсутствия». Заголовки с одним из этих тегов не будут включены в оглавление.
  2. Теги заголовков оглавления. Заголовки с этими тегами отобразятся в оглавлении как заголовки высшего уровня.

skin49 7

Скопируем тег и вставим в тег подзаголовка: <H2 class=”index-title”>. В нашем примере впишем тег в двух местах текста: перед заголовками, разделяющими статью на смысловые блоки. Выбранные подзаголовки будут выделены на фоне других (при условии, что уровень этих заголовков выше, чем уровень остальных, например, Н2, а у остальных Н3). На нумерованном списке разница видна лучше.

skin49 8

  1. Уровень смещения пунктов оглавления – по умолчанию 0. С помощью этого параметра меняют уровень заголовков в оглавлении. Если поставить Н1 имя класса title и выбрать смещение 2, то заголовок в оглавлении станет отображаться как Н3).

В нашем примере заголовки, в теге которых прописан класс index-title второго уровня (Н2). Если поставить значение 3 и посмотреть код страницы, мы увидим, что уровень этих заголовков сменился на Н5.

skin49 9

  1. Добавить ссылки – если поставить нет, все пункты оглавления будут неактивными (без ссылок).
  2. Добавить ссылки на заголовки – если включить, то все подзаголовки в статье станут активными. Что дает эта опция? Можно навести на подзаголовок и скопировать ссылку.
  3. Включать в код страницы HTML.

Остальные настройки доступны в версии PRO.

skin49 10

Дополнительные возможности

После глобальных настроек плагина (глобальных, поскольку они распространяются на все оглавления всех статей), может возникнуть необходимость оформить меню статьи несколько иначе, чем все остальные. Разработчики предусмотрели для этого дополнительные параметры, которые устанавливаются с помощью кода – пример: {Indexordered=” false”},

где первое слово – это тег оглавления, второе - параметр, третья – опция. В нашем примере указан параметр «нумерованный список» и опция «ложный», означающая, что применять этот параметр не нужно.

Вместо опции может стоять конкретное значение, например: max = " 3", где под max подразумевается максимальная глубина вложенности списка.

Код всегда прописывается в фигурных скобках (таковы настройки плагина по умолчанию):

{Indexordered= "false" max = " 3"}.

Какие действия можно выполнить с помощью кодов?

Исключить из оглавления конкретные заголовки, блоки текста

Предусмотрено несколько способов, как это сделать.

  • С помощью тега noindex. Его нужно прописать в тег H2 напротив не нужного подзаголовка: <H2 class=”noindex”>

skin49 11

skin49 12

  • С помощью открывающего и закрывающего тегов noindex (в фигурных скобках) скрывают целые абзацы и блоки текста.

skin49 13

  • Можно поставить закрывающий тег index там, где нужно закончить считывать подзаголовки.

skin49 14

Создать несколько оглавлений

Если текст разбит на 2 и более тематических блока, целесообразно сделать оглавление для каждого из них. С QuickIndex позволяет создавать несколько меню на одной странице. Как это сделать?

В примере на скриншотах текст разделен на два смысловых блока: информационный и коммерческий. Создадим оглавление для информационного – поставим открывающий тег indexпосле введения статьи, а закрывающий – там, где заканчивается мысль (т.е. перед заголовком «Наша помощь….», где речь идет о коммерческом предложении). Чтобы создать меню для второй смысловой части, после закрывающего тега поставим открывающий и уже в конце статьи поставим {/index}.

skin49 15

Пронумеровать пункты

Если в настройках плагина вы выбрали значение «не упорядочивать списки», но возникла потребность пронумеровать оглавление конкретной статьи, вы можете прописать вместо {index} следующий текст {index ordered= "true"} и получите желаемый результат.

Если сложилась противоположная ситуация (установлены для всех статей нумерованные оглавления, но из одного нужно убрать цифры), пропишите то же, но с значением false («ложный»).

skin49 16

Создать сложно структурированный список

Для каждого списка можно задать уровни вложенности: первый, второй, третий. Вписываем в тег: ordered_1= "true" ordered_2= "false" ordered_3= "true", или ordered= "true, false, true".

Задать глубину

В PRO версии плагина QuickIndex сделать это легко, а в бесплатной придётся прибегнуть к коду.

По умолчанию в оглавление включаются подзаголовки всех уровней (H1-H6). Если требуется ограничить глубину до Н3, прописываем рядом с index слово maxи значение «3»: {index max=”3”}. Таким же образом прописывается минимальный уровень: {index min= "2"}. А максимальный и минимальный так: {index min= "2" max=”3”}.

Отличие версии PRO

skin49 17

В версии Pro открываются следующие параметры:

  • на вкладке «Оформление» класс номеров заголовков, он позволяет выводить в оглавлении пункты с такими же номерами, что и у подзаголовков статьи,

skin49 18

  • на «Поведение» минимальный и максимальный уровни заголовков, включаемых в оглавление, а также
  • минимальный и максимальный уровень заголовков (будет преобразовываться в соответствии с настройками),
  • упорядоченный список – уже знакомые опции «нет» и «да», а также «установить индивидуально» (при включении этого параметра открывается выбор стилей списка, для каждого уровня списка можно выбрать своё оформление),

skin49 19

skin49 20

  • в «Дополнительных параметрах» можно добавить номера из оглавления к подзаголовкам статьи (или отключить эту опцию),
  • в поле «Разделитель чисел» ставят желаемый символ, который разделить цифру и заголовок, например, точка или /,
  • добавить сгенерированный номер в подзаголовки статьи (в якоря),
  • добавление родительских заголовков в якоря,
  • список слов, которые следует удалить из якорей,
  • выбрать компоненты, в которых не будет использоваться плагин QuickIndex,
  • удалить синтаксис плагина из отключенных компонентов.

skin49 21

 

skin49 22.1

Pro версия позволяет выводить оглавление статьи через модуль, в том числе на любой другой странице. Для этого укажите {indexarticle=”12”}, где 12 – это ID статьи. Вместо цифр допустимо использовать заголовок материала. Если речь о той же странице, вставьте {index article= "current"}, при этом оглавление в самой статье исчезнет.

skin49 23

skin49 24

Если оглавлений несколько, можно вывести одно из них или несколько, например, 2-е и 4-е по счету: {index article="12" index ="2,4"}.

 

Цена PRO версии – 19 долларов. По времени ограничений нет, но доступ к обновлениям PRO пакета открыт только на 1 год. Обновление пакета предоставляется с 25% скидкой. Количество доменов не ограничено.