Основною метою Wayfinder є отримання навігаційного меню, яке автоматично оновлюються, при внесенні змін до дерево документів.
Можливо робити кілька викликів Wayfinder на одній сторінці, кожен з яких може визначати іншу частину дерева документа, тому ви можете мати кілька навігаційних меню або списків документів на одній сторінці.
Використання
Найпростіший виклик сниппета Wayfinder може бути таким:
Це виклик сниппета буде виводити HTML код у вигляді невпорядкованого списку всього дерева документів (з певними винятками), де кожен елемент списку є посиланням на відповідний документ в дереві документів MODX.
Загальні параметри
Ідентифікатор папки з якої беруться документи для формування результату. Можна використовувати будь-який ID документа-контейнера.
параметри шаблону
Ці параметри вказують чанкі, які містять шаблони, які будуть генерувати висновок Wayfinder.
У поточній версії Wayfinder для MODX Revolution, ви можете отримати доступ до ваших кастомними TV використовуючи прейсхолдерибез префікса wf. наприклад # 91; # 91; + my_TV]]
На момент написання статті, будуть повернуті тільки вихідні значення TV - вони не будуть форматироваться. Наприклад, якщо вашим TV є зображення - звичайне використання таке TV всередині вашого шаблону буде повертати повний повний тег зображення, але всередині шаблону Wayfinder - буде повернений тільки шлях до зображення.
Якщо ви хотіти обробляти TV, ви можете зробити це викликом сниппета в межах шаблону ряду Wayfinder ( rowTpl. Наприклад ваш TV зображення називається icon і зазвичай для виведення в шаблоні використовується приблизно такий код:
Але так як це не дозволить вам обробляти TV, потрібно замінити його на:
І тепер всередині сниппета processTV поміщаємо наступний PHP код:
В результаті повертається повністю оброблене TV зображення.
Назва чанка містить шаблон зовнішнього контейнера.
- wf.classes - виводить відповідний класи взятий з набору параметрів Wayfinder (включаючи атрибут class = "")
- wf.classnames - висновок назву відповідних класів (без class = "")
- wf.wrapper - висновок внутренего вмісту (row). Це заповнювач об'язателен.
параметр innerTpl містить такий же набір плейсхолдеров що і outerTpl.
Назва чанка містить шаблон для елементів ряду меню.
- wf.classes - висновок соответвствующіх класів (включаючи атрибут class = "")
- wf.classnames - висновок відповідних класів (без class = "")
- wf.link - значення атрибута href = "" для посилання меню
- wf.title - ім'я тексту заголовка для посилання від поля наданого в секції titleOfLinks
- wf.linktext - текст для діючої посилання, зазначеному в полі, переданим в параметрі textOfLinks
- wf.wrapper - висновок внутрішнього вмісту, наприклад підміню
- wf.id - висновок унікального ID атрибута. Вам потрібно вказати параметр rowIdPrefix для того щоб цей заповнювач міг отримати значення. Значним є префікс + docId.
- wf.attributes - виводить посилання атрибутів для поточного елемента
- wf.docid - ідентифікатор документа поточного елемента
- wf.description - опис для поточного елемента
- wf.level - поточний рівень вкладеності (добавленнно в v2.3.3)
Ще один варіант: