Параметры Wayfinder

Описание

Служит для организации меню. Позволяет организовать простые,
многоуровневые, а также выпадающие меню.
Благодаря использованию шаблона результат может быть выведен в виде
нумерованных и ненумерованых списков или любом другом.

Рассмотрим параметры, которые есть у Wayfinder. Указанные параметры относятся к первой версии.

Авторы

  • Kyle Jaebker (muddydogpaws.com)
  • Ryan
    Thrash (vertexworks.com)

Версия

2.0

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

[[Wayfinder? &startId=`0`]]

[[Wayfinder?
&startId=`0` &level=`3` &hideSubMenus=`1` &outerTpl=`wfOuter`
&rowTpl=`wfRow` &hereTpl=`wfHere`]]

Параметры

&startId

Идентификатор папки из которой берутся документы для
формирования результата.

Значения: Любой номер (ID) документа.

По умолчанию: Текущий документ

&level

Число уровней в глубину для сбора документов.

Значение: целое число больше либо равно нулю.

По умолчанию: 0

&ignoreHidden

Игнорировать галочку «Показывать в меню» и выводить такие
документы тоже.

Значения:

  • true
  • false

По умолчанию: false

&ph

Название переменной, которая будет использована для вывода
результата (?)

Значения:

  • любое название переменной
  • false

По умолчанию: false

&debug

Установить режим отладки для диагностики.

Значения:

  • true
  • false

По умолчанию: false

&hideSubMenus

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

Значения:

  • true
  • false

По умолчанию: false

&removeNewLines

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

Значения:

  • true
  • false

По умолчанию: false

&textOfLinks

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

Значения:

  • menutitle
  • id
  • pagetitle
  • description
  • parent
  • alias
  • longtitle
  • introtext

По умолчанию: menutitle

&titleOfLinks

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

Значения:

  • menutitle
  • id
  • pagetitle
  • description
  • parent
  • alias
  • longtitle
  • introtext

По умолчанию: pagetitle

&rowIdPrefix

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

Значения:

  • true
  • false

По умолчанию: false

&useWeblinkUrl

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

Значения:

  • true
  • false

По умолчанию: true

&showSubDocCount

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

Значения:

  • true
  • false

По умолчанию: false

&sortOrder

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

Значения:

  • ASC
  • DSC

По умолчанию: ASC

&sortBy

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

Значения:

  • id
  • menutitle
  • pagetitle
  • introtext
  • menuindex
  • published
  • hidemenu
  • parent
  • isfolder
  • description
  • alias
  • longtitle
  • type
  • template

По умолчанию: menuindex

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

&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+][+wf.wrapper+]

&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

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

*&jsTpl

Javascript для добавления на страницу.

Значение:

  • название чанка с Javascript
  • false

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

оригинал на хабре

Отправить комментарий

Другие статьи рубрики "wayfinder"