MODx/Встроенные сниппеты/ListIndexer

Материал из Викиучебника — открытых книг для открытого мира
Перейти к навигации Перейти к поиску

Сниппет ListIndexer[править]

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


Параметры конфигурации ListIndexer:[править]

$rootFolder - (опционально), разделённый запятыми список сканируемых папок для поиска новых документов. по умолчанию = 0 ListIndexer?&LIn_root=`3,6,88`

$descendentDepth - (опционально), глубина сканирования. ListIndexer?&LIn_depth=`2`

$seeThruUnpub - (опционально), сканировать или нет в нутри не опубликованных папок [ true | false ]. по умолчанию = false

$seeShowInMenu - (опционально),показывать или нет документы со снятым флагом "показывать в меню" [ true | false ]. по умолчанию = false ListIndexer?&LIn_seeShowInMenu=`1`

$hidePrivate -(опционально), скрывать приватные страницы [ true | false ] по умолчанию = true ListIndexer?&LIn_hidePrivate=`0`

$mode -(опционально), режим, показывать ограниченное количество документов или все [ 'short' | 'full' ] по умолчанию = short ListIndexer?&LIn_mode=`full`

$sortBy -(опционально), сортировать по [ 'alpha' | 'date' | 'menuindex' ] по умолчанию = date ListIndexer?&LIn_sort=`alpha`

$sortDir -(опционально), тип сортировки , возрастающий или убывающий список [ 'ASC' | 'DESC' ] по умолчанию = не задано ListIndexer?&LIn_dir=`ASC`&LIn_sortBy=`menuindex`

Параметры отображения[править]

$defaultTitle -(опционально), название списка [ string ] по умолчанию = не задано ListIndexer?&LIn_title=`Some new title`

$shortDesc -(опционально), показывать короткое описание или нет [ true | false ] по умолчанию = true ListIndexer?&LIn_sDesc=`0`

$fullDesc -(опционально), показывать подробное описание или нет [ true | false ] по умолчанию = true ListIndexer?&LIn_fDesc=`0`

$linkToIndex -(опционально), публикация ссылки на корневой документ [ int ] по умолчанию = нет ListIndexer?&LIn_link=`8`

$indexText -(опционально), текст ссылки на корневой документ [ string ] по умолчанию = Index ListIndexer?&LIn_indexText=`Financial News Index`

$showCreationDate -(опционально), показывать дату создания документа [ true | false ] по умолчанию = true ListIndexer?&LIn_showDate=`1`

$dateFormat -(опционально), формат отображения даты создания документа [ string ] Возможные значения - // Y = 4 digit year y = 2 digit year // M = Jan - Dec m = 01 - 12 // D = Sun - Sat d = 01 -31 Например: 'Y.m.d';

$shortQty -(опционально), количество ссылок в коротком списке [ int ] по умолчанию = 3 ListIndexer?&LIn_sQty=`3`

Пагинация[править]

$fullQty -(опционально), количество ссылок на страницу [ int ] по умолчанию = 10 ListIndexer?&LIn_fQty=`20`

$pageSeparator -(опционально), разделитель номеров страниц [ string ] по умолчанию = | пример - ( 1 | 2 | 3 | 4 )

$pgPosition -(опционально), положение списка пагинации [ 'top' | 'bottom' | 'both'] по умолчанию = both


Производительность[править]

$useFastUrls -(опционально), повышает производительность в FULL режиме только, не допускается использовать при нескольких вызовах сниппета на одной странице [ true | false ] по умолчанию = false ListIndexer?LIn_fast=0

$newLinesForLists -(опционально), определяет формат вывода - будет ли использоваться li на каждой новой строке или нет [ true | false ] по умолчанию = true


Стили[править]

Список используемых стилей для сниппета

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