ListIndexer Вывод форматированного списка ссылок на документы

ListIndexer
MODX Wiki
Перейти

Сниппет ListIndexer предназначен для вывода форматированного списка ссылок на документы. Поддерживается пагинация и сортировка. Шаблоны не поддерживаются. Внешний вид определяется конфигурацией и CSS. Обычно используют для отображения информации о последних опубликованных документах на сайте. Вообще говоря, Ditto с лихвой перекрывает возможности ListIndexer, но ListIndexer даёт меньшую нагрузку на сервер и имеет специальный режим повышенной производительности. Можно использовать для формирования ленты новостей.

Параметры

Основные параметры

&LIn_root - Разделённый запятыми список сканируемых папок для поиска новых документов

Формат: ID документов, через запятую
Значение по умолчанию: 0
Примечание:
Пример: 
&LIn_root=`3,6,88`

&LIn_depth - Глубина сканирования

Формат: число
Значение по умолчанию: 0
Примечание: 0 - все уровни
Пример: 
&LIn_depth=`2`

&LIn_seeThru - Сканировать или нет внутри не опубликованных папок

Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
Пример: 
&LIn_seeThru=`1`

&LIn_seeShowInMenu - Показывать или нет документы не показываемые в меню

Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
Пример: 
&LIn_seeShowInMenu=`1`

&LIn_hidePrivate - Скрывать приватные страницы

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
Пример: 
&LIn_hidePrivate=`0`

&LIn_mode - Показывать ограниченное количество документов или все

Формат: short | full
Значение по умолчанию: short
Примечание:
Пример: 
&LIn_mode=`full`

&LIn_sort - Поле для сортировки документов

Формат: alpha | date | menuindex
Значение по умолчанию: date
Примечание:
alpha - по алфавиту
date - по дате
menuindex - по позиции в меню
Пример: 
&LIn_sort=`menuindex`

&LIn_dir - Направление сортировки

Формат: ASC | DESC
Значение по умолчанию: нет
Примечание:
Пример: 
&LIn_dir=`DESC`

&LIn_exclude - Исключаемые джокументы

Формат: id документ
Значение по умолчанию: пусто
Примечание: Разделенный запятыми список идентификаторов документов, которые должны быть исключены из результатов.
Внимание! Дочерние документы не исключаются.
Пример: 
&LIn_exclude=`3,11`

&LIn_removeLinks - Удалить ссылки

Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
Пример: 
&LIn_removeLinks=`1`

Отображение

&LIn_title - Название для списка ссылок по умолчанию

Формат: строка
Значение по умолчанию: нет
Примечание:
Пример: 
&LIn_title=`Новости компании`

&LIn_sDesc - Показывать или не показывать описание при LIn_mode=`short`

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
Пример: 
&LIn_sDesc=`0`

&LIn_fDesc - Показывать или не показывать описание при LIn_mode='full'

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
Пример: 
&LIn_fDesc=`0`

&LIn_link - Публикация ссылки на корневой документ

Формат: ID документа
Значение по умолчанию: нет
Примечание:
Пример: 
&LIn_link=`10`

&LIn_indexText - Текст ссылки на корневой документ

Формат: строка
Значение по умолчанию: Index
Примечание:
Пример: 
&LIn_indexText=`Все новости`

&LIn_showDate - Показывать дату создания документа

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
Пример: 
&LIn_showDate=`0`

&LIn_dateFormat - Формат даты (начиная с версии 1.0.2)

Формат: Y | y | M | m | D | d
Значение по умолчанию: Y.m.d - для версии 1.0.1, M d, Y - для верии 1.0.2
Примечание:
Y = год (4 цифры)
y = год (2 цифры)
M = месяц (Jan - Dec)
m = месяц (01 - 12)
D = день (Sun - Sat)
d = день (01 -31)
Пример: 
&LIn_dateFormat=`d.m.Y`

&LIn_sQty - Количество ссылок в коротком списке (LIn_mode=`short`)

Формат: число
Значение по умолчанию: 3
Примечание:
Пример: 
&LIn_sQty=`5`

&LIn_titleLength - Число символов в названии ссылки (начиная с версии 1.0.2)

Формат: число
Значение по умолчанию: 0
Примечание: 0 - полное название
Пример: 
&LIn_titleLength=`15`

&LIn_descriptionLength - Число символов для описания (начиная с версии 1.0.2)

Формат: число
Значение по умолчанию: 0
Примечание: 0 - описание полностью
Пример: 
&LIn_descriptionLength=`150`

&LIn_SEOprefix - Текст в атрибуте title ссылки перед заголовком

Формат: текст | плейсхолдеры MODX
Значение по умолчанию: нет
Примечание: В качестве значения могут использоваться плейсхолдеры MODX
Пример: 
&LIn_SEOprefix=`[(site_name)]`

&LIn_SEOsuffix - Текст в атрибуте title ссылки после заголовка

Формат: текст | плейсхолдеры MODX
Значение по умолчанию: пусто
Примечание: В качестве значения могут использоваться плейсхолдеры MODX
Пример: 
&LIn_SEOsuffix=`[(site_name)]`

&LIn_SEOlongTitle - Использовать в атрибуте title ссылки вместо pagetitle значение longtitle

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: Если longtitle пуст, не выведется ничего
Пример: 
&LIn_SEOlongTitle=`1`

&LIn_addSeoToLinks - Включить использование LIn_SEOprefix и LIn_SEOsuffix

Формат: 0 | 1
Значение по умолчанию: 0
Примечание:
Пример: 
&LIn_addSeoToLinks=`1`

Пагинация

&LIn_fQty - Количество ссылок на страницу при включенной пагинации

Формат: число
Значение по умолчанию: 10
Примечание:
Пример: 
&LIn_fQty=`20`

&LIn_pageSeparator - Разделитель номеров страниц

Формат: строка
Значение по умолчанию: |
Примечание: Данный параметр настраивается только в коде сниппета в переменной $pageSeparator.
Чтобы появилась возможность задавать разделитель номеров страниц при вызове сниппета, необходимо в код сниппета в блоке с конфигурацией добавить следующую строку:
$pageSeparator = (isset($LIn_pageSeparator))? $LIn_pageSeparator : $pageSeparator ;
Пример: 
&LIn_pageSeparator=`||`

&LIn_pgPosition - Положение списка пагинации

Формат: top | bottom | both
Значение по умолчанию: both
Примечание:
top - сверху
bottom - снизу
both - и сверху и снизу
Данный параметр настраивается только в коде сниппета в переменной $pgPosition.
Чтобы появилась возможность задавать положение пагинации при вызове сниппета, необходимо в код сниппета в блоке с конфигурацией добавить следующую строку:
$pgPosition = (isset($LIn_pgPosition))? $LIn_pgPosition : $pgPosition ;
Пример: 
&LIn_pgPosition=`bottom`

Производительность

&LIn_fast - Повышает производительность в FULL режиме

Формат: 0 | 1
Значение по умолчанию: 0
Примечание: Не допускается использовать при нескольких вызовах сниппета на одной странице
Пример: 
&LIn_fast=`1`

&LIn_newLinesForLists - Определяет формат вывода - будет ли использоваться li на каждой новой строке или нет

Формат: 0 | 1
Значение по умолчанию: 1
Примечание:
Пример: 
&LIn_newLinesForLists=`0`

Стили

div.LIn_title {} Стиль заголовка
ul.LIn_fullMode {} Класс для списка в full режиме
ul.LIn_shortMode {} Класс для списка в short режиме
span.LIn_date {} Класс для даты
span.LIn_desc {} Класс оформляющий описание
div.LIn_pagination {} Стиль для ссылок на следующие страницы (пагинация)
span.LIn_currentPage {} Класс для текущей страницы

Примеры

Формируем вывод ленты новостей:

[!ListIndexer? &LIn_root=`26` &LIn_sQty=`5` &LIn_sDesc=`0` &LIn_title=`Новости компании` &LIn_fDesc=`0` &LIn_link=`26` &LIn_indexText=`Все новости` &LIn_dateFormat=`d.m.Y`!]

где:

  • &LIn_root=`26` - папка с новостями компании
  • &LIn_sQty=`5` - количество отображаемых новостей
  • &LIn_sDesc=`0` - скрываем краткое описание новости
  • &LIn_title=`Новости компании` - устанавливаем заголовок для списка новостей
  • &LIn_link=`26` - ссылка на корневой документ
  • &LIn_indexText=`Все новости` - текст ссылки на корневой документ
  • &LIn_dateFormat=`d.m.Y` - формат даты

Поделитесь ссылкой

Статистика

Яндекс цитирования
© 2011 - 2023 Школа MODX
Напишите нам в Telegram