Главная » Уроки » Документация по Modx Evo » [Evo] Документация Wayfinder параметры, документация
[Evo] Документация Wayfinder параметры, документация
Текущая версия: 2.0.1
Автор: Kyle Jaebker
С помощью этого сниппета создается меню и всевозможные списки.
Особенности Wayfinder
- Настраиваемый шаблон.
- Динамические классы для каждого пункта меню.
- Уникальный идентификатор для каждого пункта меню.
- Показывать кол-во документов для каждого родителя.
- Несколько вариантов сортировки.
- Динамическая загрузка пользовательских JavaScript и CSS.
- Многие заполнители для полного контроля над фрагментом выход.
- Динамически скрывать / отображать подменю.
- Отладочный режим работы для веб-мастеров.
Инструкция по установке
- Создайте папку по адресу assets/snippets с именем Wayfinder.
- Скопируйте файл wayfinder.inc.php в эту папку
- Создайте новый сниппет с именем Wayfinder, через админку (Управление элементами - Сниппет - Новый сниппет)
- Скопируйте содержимое файла snippet.wayfinder.tpl.php в содержание сниппета.
- Используйте вызов сниппета для создания меню.
Пример использования:
[!Wayfinder?&startId =`0`!]
Параметры Wayfinder Modx Evo
- &startId
- по умолчанию: id текущего документа
- Значения: [0 | id документа | [*parent*] | [*ID*]]
- Описание: startId параметр определяет, где Wayfinder должен начать обработку. Все документы, содержащиеся в startId будут обработаны. Для запуска из корневого каталога сайта startId должен быть установлен на 0.
- &level
- по умолчанию: 0
- Значения: [0 | номер]
- Описание: Уровень вложенности меню, насколько глубоко в структуру дерева Wayfinder будет обрабатывать. Если установлено в 0, Wayfinder будет обрабатывать все уровни дерева документа.
- &includeDocs
- по умолчанию: 0
- Значения: [разделенный запятыми список id идентификаторов документа]
- Описание: действует как фильтр и ограничивает вывод только документами, указанными в этом параметре.
- &excludeDocs
- по умолчанию: 0
- Значения: [разделенный запятыми список id идентификаторов документа]
- Описание: действует как фильтр и не выводит документы, указанные в этом параметре.
- &ignoreHidden
- по умолчанию: FALSE
- Значения: [TRUE | FALSE]
- Описание: ignoreHidden параметр позволяет Wayfinder не обращать внимания на галочку отображения в меню, которая может быть установлена для каждого документа. С помощью этого параметра установленого в TRUE, все документы будут отображаться независимо от галочек.
- &ph
- по умолчанию: FALSE
- значения: имя плейсходера
- Описание: Имя подстановщика, заменяющего непосредственно выводимые результаты
- &debug
- по умолчанию: FALSE
- Значения: [TRUE | FALSE]
- Описание: Режим отладки
- &hideSubMenus
- по умолчанию: FALSE
- Значения: [TRUE | FALSE]
- Описание: Установить в ‘true’, чтобы выводилось только активное подменю
- &removeNewLines
- по умолчанию: FALSE
- Значения: [TRUE | FALSE]
- Описание: Wayfinder будет автоматически добавлять строки в выводе результата для повышения читабельности кода. Чтобы удалить эти разрывы строк, установите этот параметр в FALSE.
- &textOfLinks
- по умолчанию: MenuTitle
- Значения: [ id | menutitle | pagetitle | introtext | menuindex | published | hidemenu | parent | isfolder | description | alias | longtitle | type | template ]
- Описание: Параметр для названия ссылки (имя поля, которое будет названием ссылки) [+wf.linktext+].
- &titleOfLinks
- по умолчанию: PageTitle
- Значения: [ id | menutitle | pagetitle | introtext | menuindex | published | hidemenu | parent | isfolder | description | alias | longtitle | type | template ]
- Описание: Значение будет вставлено в [+wf.title+]. Имя поля, которое будет использовано для title ссылки.
- &rowIdPrefix
- по умолчанию: FALSE
- значения: имя префикса
- Описание: Добавлять префикс к id для каждой ссылки (id = rowIdPrefix + docId)
- &useWeblinkUrl
- по умолчанию: TRUE,
- Значения: [TRUE | FALSE]
- Описание: Вывод ссылки в плэйсхолдер [+wf.link+]
- &showSubDocCount
- по умолчанию: FALSE
- Значения: [TRUE | FALSE]
- Описание: Выводить количество документов в [+wf.subitemcount+]
- &sortOrder
- по умолчанию: ASC
- Значения: [ASC | DESC]
- Описание: Параметр для сортировки.
- &sortBy
- по умолчанию: menuindex
- Значения: [ id | menutitle | pagetitle | introtext | menuindex | published | hidemenu | parent | isfolder | description | alias | longtitle | type | template | random ]
- Описание: Сортировка
- &limit
- по умолчанию: 0
- Значения: числовые значения
- Описание: Максимальное число пунктов меню.
- &displayStart
- по умолчанию: FALSE
- Значения: [TRUE | FALSE]
- Описание: displayStart выведет заголовок - startId и затем подкатегории, с помощью шаблона startItemTpl. Этот параметр работает только в том случае, если startId не равен нулю. Эта функция была добавлена, чтобы легко добавить заголовок подменю. &displayStart=`1` - добавить заголовок подменю.
Шаблоны
- &outerTpl
- по умолчанию: см. пример
- значения: имя шаблона кусок
- Описание: outerTpl шаблон используется в качестве внешней оболочки для меню. Если не указано innerTpl, то outerTpl используется при создании подменю.
- доступные заполнители:
[+wf.classes+] - классы, где specifed будет вставлен (включает в себя класс = "")
[+wf.classnames+] - выводит только имена классов (без классом = "")
[+wf.wrapper+] - где внутреннее содержание будет вставлен - Например:
<ul id="topnav" [+wf.classes+]>[+wf.wrapper+]</ul>
- &rowTpl
- по умолчанию: см. пример
- значения: имя шаблона кусок
- Описание: rowTpl шаблон используется для внутренней оболочки меню.
- доступные заполнители:
[+wf.classes+] - классы, где specifed будет вставлен (включает в себя класс = "")
[+wf.classnames+] - выводит только имена классов (без классом = "")
[+wf.link+] - HREF значение для вашей ссылки
[+wf.title+] - текст для ссылки названием
[+wf.linktext+] - текст для ссылки дисплей
[+wf.wrapper+] - куда вставлять подменю
[+wf.id+] -, где вставить уникальный идентификатор
[+wf.attributes+] - куда вставлять ссылки атрибутов
[+wf.docid+] - идентификатор документа для текущего элемента
[+wf.subitemcount+] - отображает количество элементов в папке
[+wf.description+] - вывод описания полей
[+wf.introtext+] - вывод introtext поле - Например:
<li [+wf.id+] [+wf.classes+]><a href="[+wf.link+]" title="[+wf.title+]" [+wf.attributes+]>[+wf.linktext+]</a>[+wf.wrapper+] </li>
- &parentRowHereTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: Шаблон вывода активного документа-контейнера
- доступные заполнители: То же, что RowTpl.
- Например:
<li [+wf.classes+]> <a href="[+wf.link+] " title=" [+wf.title+] "> [+wf.linktext+] »</a>[+wf.wrapper+] </li>
- &parentRowTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: Шаблон документа контейнера
- Например:
<li [+wf.classes+]> <a href = "[+wf.link+] " title=" [+wf.title+] "> [+wf.linktext+] </a> [+wf.wrapper+] </li>
- &hereTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: hereTpl шаблон используется, когда текущий элемент активен в меню.
- доступные заполнители: То же, что RowTpl.
- Например:
<li [+wf.classes+]><span> [+wf.linktext+]</span>[+wf.wrapper+]</li>
- &innerTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: innerTpl шаблон используется в качестве оболочки для каждого подменю. Если не указано innerTpl, то используется outerTpl.
- доступные заполнители: То же, что OuterTpl.
- Например:
<ul [+wf.classes+]>[+wf.wrapper+]</ul>
- &innerRowTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: innerRowTpl шаблон внутренний для подменю.
- доступные заполнители: То же, что RowTpl.
- Например:
<li [+wf.classes+]><a href="[+wf.link+]" title="[+wf.title+]"> [+wf.linktext+]</ a>[+wf.wrapper+]</li>
- &innerHereTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: innerHereTpl шаблон используется, когда текущий элемент активен и при этом находится в ПОДменю (пункт имеет уровень больше чем один, находится в папке).
- доступные заполнители: То же, что RowTpl.
- Например:
<li [+wf.classes+]><span>[+wf.linktext+]</ span>[+wf.wrapper+]</li>
- &activeParentRowTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: activeParentRowTpl шаблон используется для родителей, и т.д.. текущего пункта меню. Шаблон применяется на всех уровнях вверх по дереву документов.
- доступные заполнители: То же, что RowTpl.
- Например:
<li [+wf.classes+]> <a href= "[+wf.link+]" title=" [+wf.title+] "> [+wf.linktext+] </ a> [+wf.wrapper+] </li>
- &categoryFoldersTpl
- по умолчанию: NULL
- значения: имя шаблона кусок
- Описание: categoryFoldersTpl используется, когда элемент представляет собой папку, и либо имеет шаблон blank или имеет rel="category" в поле ссылки атрибутов.
- доступные заполнители: То же, что RowTpl.
- Например:
<li [+wf.classes+]> <a href = "[+wf.link+] " title=" [+wf.title+] "> [+wf.linktext+]</ a> [+wf.wrapper +] </li>
- &startItemTpl
- по умолчанию: см. пример
- значения: имя шаблона
- Описание: startItemTpl используется для создания шаблонов заголовка - startId, когда параметр &displayStart установлен в TRUE.
- доступные заполнители: То же, что RowTpl.
- Например:
<h2> [+wf.linktext+]</h2> [+wf.wrapper+]
Заказ шаблонов обработки
- startItemTpl
- parentRowHereTpl
- innerHereTpl
- hereTpl
- activeParentRowTpl
- categoryFoldersTpl
- parentRowTpl
- innerRowTpl
- rowTpl
Имена классов
- &firstClass
- по умолчанию: NULL
- значения: имя класса
- Описание: Firstclass будут применены к первому пункту, для каждого уровня.
- &lastClass
- по умолчанию: последний
- значения: имя класса
- Описание: lastClass будет применяться к последнему пункту, для каждого уровня.
- &hereClass
- по умолчанию: активная
- значения: имя класса
- Описание: hereClass будут применены к активному элементу и каждому родителю вверх по дереву документов.
- &selfClass
- по умолчанию: NULL
- значения: имя класса
- Описание: selfClass будут применены только к текущему (активному) элементу.
- &parentClass
- по умолчанию: NULL
- значения: имя класса
- Описание: ParentClass будут применяться к каждому элементу, который имеет детей (папка, контейнер).
- &rowClass
- по умолчанию: NULL
- значения: имя класса
- Описание: rowClass будут применяться к каждому элементу отображается.
- &levelClass
- по умолчанию: NULL
- значения: имя класса
- Описание: levelClass будут применяться к каждому элементу обозначающие каждый пункты уровне, на уровне номер будет добавлен в выбранный класс (level1 т. е. Level2, Level3, и т.д. ..)
- &outerClass
- по умолчанию: NULL
- значения: имя класса
- Описание: OuterClass будет применяться к outerTpl контейнер.
- &innerClass
- по умолчанию: NULL
- значения: имя класса
- Описание: InnerClass будет применяться к контейнеру, используемые в innerTpl.
- &webLinkClass
- по умолчанию: NULL
- значения: имя класса
- Описание: webLinkClass будет применяться ко всем вебссылок включены в выходные.
CSS и Javascript для включения в меню
- &cssTpl
- по умолчанию: FALSE
- значения: имя кусок CSS
- Описание: cssTpl позволяет за кусок содержащей ссылку на таблицу стилей или стилей информацию, которая будет вставлена ??в головной части создаваемой страницы.
- &jsTpl
- по умолчанию: FALSE
- значения: имя чанка с кодом Javascript
- Описание: jsTpl параметр позволяет за кусок, содержащий некоторые Javascript для вставки в головной части создаваемой страницы.