cetera-labs/plugin-glossary

Модуль «Глоссарий»

dev-main 2023-12-05 08:12 UTC

MIT

• Daniil Prokofev

README

Добавляет в cms новый тип материала - «Глоссарий», в материалах данного типа задаются термины, их определения и синонимы при наличии. На странице материала отображаются указанные поля и список ссылок на страницы сайта, на которых упоминаются заданные термины и их синонимы. На обычных страницах сайта добавленные в глоссарий термины выделяются в ссылки на определение из глоссария.

Уточнения

1. Если синонимы не заданы - это поле не выводится на странице термина.
2. Поиск терминов и их синонимов на странице производится в том порядке, в котором они указаны в панели создания материала, находится и выделяется первое совпадение, остальное опускается.
3. Не стоит задавать разным терминам одни и те же синонимы, либо заводить термины с таким же именем, как и один из синонимов другого термина, в таком случае модуль не перестанет работать, но выделение терминов на страниице может стать не логичным.
4. Ссылки на страницы, содержащие термины генерируются автоматически при открытии страницы термина.
5. Если упоминаний на других страницах не найдено, поле с ссылками также опускается.
6. Поиск упоминаний осуществляется ТОЛЬКО в тексте материалов, созданных через интерфейс Fastsite CMS, преобразование терминов в ссылки происходит на всей странице.
7. Если на странице найдено упоминание, обёрнутое в ссылку, страница будет указана в ссылках, но на самой странице термин не будет обёрнут в ссылку на страницу из глоссария, однако, если после обёрнутого в ссылку термина существует повторное упоминание, не обёрнутое в ссылку - именно оно обернётся в ссылку на страница глоссария.

Установка

1. composer require cetera-labs/plugin-glossary
2. Заходим в cms
3. Проверка и ремонт БД->Анализировать->Исправить обнаруженные ошибки
4. Обновляем страницу cms
5. Готово, тип материала добавлен

Инструкция по работе

Для лобавления на сайт раздела «Глоссарий» создаём в структуре новый раздел с типом материала «Глоссарий», индексную страницу при этом создавать не нужно, все настройки для страницы со списком заданных терминов задаются в настройках раздела. Далее, для добавления нового термина создаём в разделе новый материал, заполняем необходимые поля:

1. Термин (имя термина) Одно слово, или словосочетание - обязательное поле

2. Определение Задается на одноименной вкладке, может содержать картинки и дополнительную разметку

3. Синонимы Задаются через запятую ("," либо ", ", значения не имеет). Не обязательное поле

Также, не стоит забывать задавать мета-теги для созданных материалов на отдельной вкладке