Wayfinder-Параметры Wayfinder

Описание Wayfinder

Wayfinder– сниппет, который выводит полный список ссылок на ресурсы сайта.

Для чего использовать Wayfinder?

Wayfinder использую для создания динамической навигации по сайту, то есть в меню.

Версия 2.0

https://docs.modx.com/extras/revo/wayfinder

Примеры вызова

[[Wayfinder? &startId=`0`&level=`1`]]
[[!Wayfinder? &startId=`0`]]
[[!Wayfinder?

&startId=`0`

&level=`3` 

&hideSubMenus=`1` 

&outerTpl=`wfOuter`

&rowTpl=`wfRow` 

&hereTpl=`wfHere`

]]
[[!Wayfinder? &startId=`[[*parent]]`]]

Выводить подменю не для всех разделов:
<li><ahref="[ [+wf.link]]"id="[[+id]]">[[+wf.linktext]]</a> [[+id:ne=`5`:then=`[[[+wf.wrapper]]`]] </li>

&startId

Начальная точка (идентификатор документа) для меню, из которого выводится список документов. Укажите 0, чтобы начать с корня сайта. Значения: Любой номер (ID) документа. По умолчанию: Текущий документ

  • &startId=`0`
  • &startId=`[[*id]]` - для текущего ID;
  • &startId=`[[+id]]` - для текущего ID;

&level

 Число уровней в глубину для сбора документов. Значение: целое число больше либо равно нулю.
По умолчанию: 0

  • &level=`3`

&includeDocs
ID документов, разделенных запятой
Значение по умолчанию: нет
  • &includeDocs=`5,6,7`
Разделенный запятыми список идентификаторов документов, которые будут включены в меню.

&ignoreHidden

 Игнорировать галочку «Показывать в меню» и выводить такие
документы тоже.
Значения:
  • true
  • false (по умолчанию)

&ph

 Название переменной, которая будет использована для вывода результата
Значения:
  • любое название переменной
  • false (по умолчанию)

&debug

 Установить режим отладки для диагностики.
Значения:
  • true (по умолчанию)
  • false

&debug=`false` - очень подробно выведит всю инф.

&hideSubMenus

Выводить только активные меню.

Значения:

  • true
  • false (по умолчанию)

&removeNewLines

Убирать символ переноса строки при выводе (?).
Значения:

  • true
  • false (по умолчанию)

&textOfLinks

Поле, используемое для названия ссылки меню.
Значения:

  • menutitle (по умолчанию)
  • id
  • pagetitle
  • description
  • parent
  • alias
  • longtitle
  • introtext

&titleOfLinks

Поле используемое для title ссылки меню.
Значения:

  • menutitle
  • id
  • pagetitle (по умолчанию)
  • description
  • parent
  • alias
  • longtitle
  • introtext

&rowIdPrefix

Устанавливать уникальный идентификатор (id) для каждого элемента (id складывается
из значения rowIdPrefix + docId).
Значения:

  • true
  • false (По умолчанию)

&useWeblinkUr

Выводить ссылку в переменную [[+wf.link+]].
Значения:

  • true (по умолчанию)
  • false

&showSubDocCount

Выводить количество документов в папке в переменную
[[+wf.subitemcount+]].

Значения:

  • true
  • false (по умолчанию)

&sortOrder

Задает порядок сортировки документов.
Значения:

  • ASC (по умолчанию)
  • DSC

&sortBy

Поле, по которому происходит сортировка.

Значения:

  • id
  • menutitle
  • pagetitle
  • introtext
  • menuindex (по умолчанию)
  • published
  • hidemenu
  • parent
  • isfolder
  • description
  • alias
  • longtitle
  • type
  • template

&excludeDocs
Разделенный запятыми список идентификаторов документов, которые должны быть исключены из меню. Формат: ID документов, разделенных запятой
Значение по умолчанию: нет
Примечание:список любых документов, разделенный запятыми
  • &excludeDocs=`6,7,8`

&fullLink

&fullLink — Вывести полный URL

Формат: 0 | 1
Значение по умолчанию: 0

  • &fullLink=`1`

Вывод подменю не у всех разделов

Если надо выводить подменю во всех разделах кроме 5, сперва инициализируем просчет параметра , можно сделать это в атрибуте id, затем пишем условие, не выводить подменю для id 5

<li><ahref="[[+wf.link]]"id="[[+id]]">[[+wf.linktext]]</a> [[+id:ne=`5`:then=`[[+wf.wrapper]]`]] </li>

Шаблоны для вывода меню

 

&outerTpl

 Задает шаблон вывода меню.
Значение: Название используемого чанка.
Возможные переменные:
  • [[+wf.classes+]] — место для указания
    используемого CSS-класса
    (включает class=" ")
  • [[+wf.classnames+]] — содержит только название CSS-класса (не включает class=" ")
  • [[+wf.wrapper+]] — место где будет выводиться
    содержимое меню.

Пример:
<ul id=«topnav»[[+wf.classes+]]>[[+wf.wrapper+]]

&rowTpl

 Задает шаблон вывода ряда меню.
Значение: Название используемого чанка.
Возможные переменные:
  • [[+wf.classes+] — место для указания
    используемого CSS-класса
    (включает class=" ")
  • [[+wf.classnames+] — содержит только название CSS-класса (не включает class=" ")
  • [[+wf.link+]] — адрес (href) для ссылки
  • [[+wf.title+]] — текст для title ссылки
  • [[+wf.linktext+]] — текст названия ссылки
  • [[+wf.wrapper+]] — место для вывода подменю
  • [[+wf.id+]] — вывод уникального идентификатора (id)
  • [[+wf.attributes+]] — вывод дополнительных
    атрибутов ссылки
  • [[+wf.docid+]] — идентификатор документа для
    текущего элемента
  • [[+wf.subitemcount+]] -количество элементов в
    папке
  • [[+wf.description+]] — выводит значения поля
    описания.
  • [[+wf.introtext+]] — выводит значения поля
    интротекста

Пример:
<li[[+wf.id]][[+wf.classes]]><a href="[[+wf.link]]" title="[[+wf.title]]" [[+wf.attributes]]>[[+wf.linktext]]</a>[[+wf.wrapper]]</li>

 

&parentRowHereTpl

 Задает шаблон вывода для текущего элемента, если это папка.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<li[+wf.classes+]><a href="[+wf.link+]"
title="[+wf.title+]">[+wf.linktext+]»[+wf.wrapper+]

&parentRowTpl

 Задает шаблон вывода для всех документов, являющихся папками.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<li[+wf.classes+]><a href="[+wf.link+]"
title="[+wf.title+]">[+wf.linktext+]»[+wf.wrapper+]
 

&hereTpl

 Шаблон вывода для текущего документа.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<li[+wf.classes+]>[+wf.linktext+][+wf.wrapper+]
 

&innerTpl

 Шаблон для всех списка всех подпапок.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<ul[+wf.classes+]>[+wf.wrapper+]
 

&innerRowTpl

 Шаблон для ряда подменю.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<li[+wf.classes+]><a href="[+wf.link+]"
title="[+wf.title+]">[+wf.linktext+][+wf.wrapper+]

&innerHereTpl

 Шаблон для текущего документа, если это подпапка.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<li[+wf.classes+]>[+wf.linktext+][+wf.wrapper+]

&activeParentRowTpl

 Шаблон для вывода подпапок, которые являются предками текущего документа.
Значение: Название используемого чанка.
Возможные переменные: как у &rowTpl
Пример:
<li[+wf.classes+]><a href="[+wf.link+]"
title="[+wf.title+]">[+wf.linktext+][+wf.wrapper+]

&categoryFoldersTpl

Шаблон для вывода папки категории. Папка категории устанавливается установкой шаблона blank или атрибутом ссылки
rel=«category».
Значение: Название используемого чанка. Возможные переменные: как у &rowTpl

Пример:

<li[+wf.classes+]><a href="[+wf.link+]"
title="[+wf.title+]">[+wf.linktext+][+wf.wrapper+]
   

Название назначаемых CSS-классов

&firstClass

 CSS-класс для первого пункта текущего уровня меню.
Значение:
  • none (отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)

&lastClass

 CSS-класс для последнего пункта текущего уровня меню.

Значение:
  • last
  • название CSS-класса.

Значение по умолчанию: last

&hereClass

 CSS-класс указывающий состояние «Вы здесь». Определяет всю цепочку пунктов.
Значение:
  • here
  • название CSS-класса.

Значение по умолчанию: here
 

&selfClass

 CSS-класс указывающий состояние «Вы здесь». Определяет только текущий документ.
Значение:
  • none (отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)

&parentClass

 CSS-класс указывающий пункт меню как папку (имеет вложенные документы)
Значение:
  • parent
  • название CSS-класса.

Значение по умолчанию: parent
 

&rowClass

 CSS-класс задающий каждый ряд меню.
Значение:
  • none (отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)

&levelClass

 CSS-класс определяющий каждый уровень меню. Для каждого уровня может быть задан специальный CSS-класс (level1, level2, level3 и т.д.)
Значение:
  • none (отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)
 

&outerClass

 CSS-класс для шаблона вывода меню.
Значение:
  • none (отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)

&innerClass

 CSS-класс для шаблона вывода подпунктов меню.
Значение:
  • none(отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)
 

&webLinkClass

 CSS-класс для ссылок меню.
Значение:
  • none (отсутствует)
  • название CSS-класса.

Значение по умолчанию: none (отсутствует)

Подключение CSS и Javascript к меню

*&cssTpl

 CSS для добавления на страницу.
Значение:
  • название чанка с CSS
  • false (по умолчанию)

*&jsTpl

 Javascript для добавления на страницу.
Значение:
  • название чанка с Javascript
  • false (по умолчанию)
Авторы Kyle Jaebker (muddydogpaws.com)
Ryan Thrash (vertexworks.com) &scheme - Формат для генерации URL.
Возможные значения (основанны на вызове makeURL API):
-1 : (значение по умолчанию) URL по отношению к site_url; 0: смотрите http;
1: смотрите https; full: абсолютный URL начинающийся с site_url; abs: абсолютный URL начинающийся с base_url; http: абсолютный URL, заданный принуждённо в http-схеме; 
 
https: абсолютный URL, заданный принуждённо в https-схеме.
&sortBy - Поле, по которому происходит сортировка. (по умолчанию menuindex) Варианты: id, menutitle, pagetitle, introtext, menuindex, published, hidemenu, parent, isfolder, description, alias, longtitle, type, template
&sortOrder - Порядок сортировки. 'ASC' или 'DESC'. По умолчанию ASC &where - JSON-стиль параметров фильтрации (Соответствует where в MySQL) . Например, когда необходимо скрыть блог или новости из дополнения Articles: &where=`[{"class_key:!=": "Article"}]`
Примеры: вывод только папок: &where=`isfolder = 1 &hereId - Определять текущий ID для использования в сниппете. Используйте значение 5 если шаблон указан с помощью параметра hereTpl и activeRowParentTpl не применяеться корректно в пункте меню. По умолчанию текущий ид. Нужно указывать только если скрипт сам его неверно определяет, например, при выводе меню из чанка другого сниппета.
&hereTpl - Шаблон hereTpl используется в момент, когда текущий пункт отображается в меню.

 

Возможные плэйсхолдеры:

[[+wf.classes]] - место для указания используемого CSS-класса (включает class=" ")
[[+wf.classnames]] - содержит только название CSS-класса (не включает class=" ")
[[+wf.link]] - адрес (href) для ссылки
[[+wf.title]] - текст для title ссылки
[[+wf.linktext]] - текст названия ссылки
[[+wf.wrapper]] - место для вывода подменю

[[+wf.id]] - вывод уникального идентификатора (id)
[[+wf.attributes]] - вывод дополнительных атрибутов ссылки
[[+wf.docid]] - идентификатор документа для текущего элемента
[[+wf.subitemcount]] -количество элементов в папке
[[+wf.description]] - выводит значения поля описания
[[+wf.introtext]] - выводит значения поля интротекста 
 
 Пример шаблона: <li[[+wf.classes]]>
24.07.2026

Главная »

Яндекс.Метрика