# =========================================================================== #
# NG CMS // Плагины // Облако тегов                                           #
# =========================================================================== #

Плагин позволяет запустить на вашем сайте функцию "облако тегов".
Что такое "облако тегов"? Вот описание из википедии:
----
Облако тегов или Туча ярлыков или Облако меток (англ. tag cloud) - визуальное
представление списка ярлыков (или категорий). Частота упоминаний, поисков, ссылок
в интернете с определенного сайта неких слов, терминов, имен, отображается на
специальной странице в виде изображения этих слов в формате гиперссылок.
Размер изображения тем больше, чем выше релевантность данного слова (термина, имени).
----

После установки и активизации плагина у вас появляется возможность для каждой новости
указать (через запятую) список тегов/ключевых слов актуальных для данной новости.


Отображение плагина:
--------------------------------------------------------------------
* Внутри новости:
  При активации плагина становятся доступны:
  1. Блок [tags] ... [/tags], который будет видим в случае, если в новости
     есть хотябы один тег
  2. Переменная {tags}, содержащая список тегов
  TWIG переменные:
  * p.tags.flags.haveTags - флаг: true если есть теги, иначе - false
  * p.tags.value	- блок со списком тегов (выводит тоже самое, что и переменная {tags})
  * p.tags.count	- кол-во тегов в новости
  * p.tags.list		- массив со списком тегов, каждый элемент содержит:
	* name		- название тега
	* link		- URL тега
	* value		- ссылка на тег



* На боковой панели:
  Добавьте в шаблон сайта main.tpl переменную {plugin_tags}

* На собственной страничке плагина:
  Страница плагина доступна по следующему адресу на Вашем сайте:
  /plugin/tags/ (при заданных по умолчанию настройках ЧПУ)


Возможности режима отображения: внутри новости
--------------------------------------------------------------------
Для формирования переменной {tags} используется конфигурационный файл
params.ini, находящийся в одном каталоге вместе с шаблоном плагина
(в зависимости от настроек плагина, шаблон может располагаться либо
в каталоге плагина, либо - в каталоге общего шаблона сайта).
Из файла params.ini используются следующие переменные:
tag_news 	   - оформление отображения тега
	Доступные переменные:
		{url} - URL страницы тега
		{tag} - тег
tag_news_delimiter - разделитель тегов в списке


Возможности режима отображения: на боковой панели
--------------------------------------------------------------------
Для отображения используются следующие файлы:
* sidebar.tpl - "оболочка" вокруг облака тегов на боковой панели
  Доступные переменные:
  {tpl_url} - URL шаблона сайта
  {entries} - список тегов. как формируется - указано ниже
  {cloud3d} - специальная переменная для вывода 3D облака тегов, активируется
              параметром конфигурации `Выводить переменную для 3D облака тегов`
              (пример работы с 3D облаком тегов можно найти в скине 3d)
  ** стиль отображения списка берётся из params.ini

* cloud.tpl - "оболочка" вокруг облака тегов (на странице плагина)
  Доступные переменные:
  {tpl_url} - URL шаблона сайта
  {entries} - список тегов. как формируется - указано ниже
  {tag}     - название отображаемого тега
  {pages}   - отображение блока постраничной навигации
  ** стили для отображения тегов в списке тегов берётся из params.ini
  ** стиль для отображения новостей по конкретному тегу берётся из cloud.tag.entry.tpl
  Блоки:
  [paginator]..[/paginator] - отображается в случае, если есть постраничная навигация (т.е.
   если навигация разрешена и должно отображаться более одной страницы)

* cloud.tag.tpl - "оболочка" вокруг облака тегов (на странице плагина) при отображении
  конкретного тега.
  ## Это опциональный шаблон, его наличие - не обязательно.
  ## Если данного шаблона нет, то вместо него используется шаблон cloud.tpl

* cloud.tag.entry.tpl - стиль отображения новостей по конкретному тегу
  Доступные переменные:
  {news_link} - ссылка на новость
  {title}     - название новости
  {date}      - дата создания новости
  ** ВНИМАНИЕ !! **
  ** [ для данного шаблона указан неполный список поддерживаемых переменных    ] **
  ** [ описание полного списка смотрите в описании шаблона сайта news.full.tpl ] **


* pages.tpl - отображение постраничной навигации
  Доступные переменные:
  {pages}     - страницы для постраничной навигации
  Блоки:
  [prev_link]..[/prev_link] - его содержимое отображается в виде ссылки в случае, если есть
    предыдущая страница
  [next_link]..[/next_link] - его содержимое отображается в виде ссылки в случае, если есть
    следующая страница
  ** Параметры отображения постраничной навигации берутся из текущего шаблона из файла
     конфигурации variables.ini (блок [navigation])

* params.ini - конфиг, из которого используются параметры:
  news.tag              - стиль отображения тега в списке тегов в новости
       Доступные переменные:
       {url}    - ссылка на страницу тега
       {tag}    - название тега

  news.tag.delimiter    - разделитель между тегами
  news.notags	- текст для отображения при включении функции "Всегда выводить в новости блок с тегами"
  sidebar.tag           - стиль отображения тега на боковой панели
       Доступные переменные:
       {url}    - ссылка на страницу тега
       {tag}    - название тега
       {posts}  - кол-во новостей в которых встречается этот тег
       {params} - HTML стиль/класс отображения тега
  sidebar.tag.delimiter - разделитель между тегами
  cloud.tag             - стиль отображения тега на странице плагина (список тегов)
       Доступные переменные:
       {url}    - ссылка на страницу тега
       {tag}    - название тега
       {posts}  - кол-во новостей в которых встречается этот тег
       {params} - HTML стиль/класс отображения тега
  cloud.tag.delimiter   - разделитель между тегами
  ; Переменные, доступные при использовании 3D облака тегов
  size3d.min    - минимальный размер шрифта для облака тегов (в pt, по умолчанию - 10)
  size3d.max    - максимальная размер шрифта для облака тегов (в pt, по умолчанию - 18)


Возможности режима отображения: на странице плагина (общая страница)
--------------------------------------------------------------------
На общей странице отображается просто список тегов.
Все возможности дублируются с возможностями режима "на боковой панели".
Отличительные черты:
1. Использование шаблона "sidebar.tpl" вместо шаблона "cloud.tpl"
2. В шаблоне "plugin.tpl" доступна переменная {tag} в которой для данного
   режима отображается строка "список тегов"

Смысл данного режима - возможность отобразить заметно бОльший список тегов
(вплоть до нескольких сотен).


Возможности режима отображения: на странице плагина (страница тега)
--------------------------------------------------------------------
На странице конкретного тега отображается список новостей, в которых
встречается данный тег.
Для отображения используются следующие файлы:
* plugin.tpl - "оболочка" для отображения списка новостей по тегу.
  Доступные переменные для данного шаблона описаны ниже.
  Переменная {tag} в данном режиме принимает иное значение - в неё
  записывается выбранный пользователем тег.
* entry.tpl - строка-описание новости
  Доступные переменные:
  {news_link} - URL новости
  {title}     - Название новости
  {date}      - Дата создания новости


Настройка отображения плагина при добавлении/редактировании новостей
--------------------------------------------------------------------
Для отображения элементов плагина используются следующие файлы:
* tags_addnews.tpl  - добавление новости
* tags_editnews.tpl - редактирование новости
  Доступные переменные:
  {tags} - список тегов новости