Wayfinder options

Description

Serves to organize the menu. Allows you to organize simple,
multi-level and drop-down menus.
Through the use of a pattern, the result can be displayed as
numbered and unordered lists or any other.

Consider the options that Wayfinder has. The specified parameters refer to the first version.

The authors

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

Version

2.0

Call examples

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

Options

& startId

ID of the folder from which documents are taken for
formation of the result.

Values: Any number (ID) of the document.

Default: Current Document

& level

The number of levels in depth to collect documents.

Value: an integer greater than or equal to zero.

Default: 0

& ignoreHidden

Ignore the "Show in menu" checkbox and display such
documents too.

Values:

• true
• false

Default: false

& ph

The name of the variable that will be used for output
result (?)

Values:

• any variable name
• false

Default: false

& debug

Set debug mode for diagnostics.

Values:

• true
• false

Default: false

& hideSubMenus

Display only active menus.

Values:

• true
• false

Default: false

& removeNewLines

Remove the newline character in the output (?).

Values:

• true
• false

Default: false

& textOfLinks

The field used to name the menu link.

Values:

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

Default: menutitle

& titleOfLinks

The field used for the menu's title link.

Values:

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

Default: pagetitle

& rowIdPrefix

Set a unique identifier (id) for each element (id is added
from rowIdPrefix + docId).

Values:

• true
• false

Default: false

& useWeblinkUrl

Link to variable [+ wf.link +].

Values:

• true
• false

Default: true

& showSubDocCount

Print the number of documents in a folder to a variable
[+ wf.subitemcount +].

Values:

• true
• false

Default: false

& sortOrder

Sets the sorting order for documents.

Values:

• ASC
• DSC

Default: ASC

& sortBy

The field by which the sorting takes place.

Values:

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

Default: menuindex

Menu templates

& outerTpl

Sets the menu output template.

Meaning: The name of the chunk to be used.

Possible variables:

• [+ wf.classes +] - a place to specify
  used CSS class
  (includes class = "")
• [+ wf.classnames +] - contains only the name of the CSS class (does not include the class = "")
• [+ wf.wrapper +] - the place where it will be displayed
  the contents of the menu.

Example:
<ul id = "topnav" [+ wf.classes +]> [+ wf.wrapper +]

& rowTpl

Sets the display pattern for a range of menus.

Meaning: The name of the chunk to be used.

Possible variables:

• [+ wf.classes +] - a place to specify
  used CSS class
  (includes class = "")
• [+ wf.classnames +] - contains only the name of the CSS class (does not include the class = "")
• [+ wf.link +] - address (href) for the link
• [+ wf.title +] - text for title links
• [+ wf.linktext +] - text link title
• [+ wf.wrapper +] - a place to display a submenu
• [+ wf.id +] - output a unique identifier (id)
• [+ wf.attributes +] - output additional
  link attributes
• [+ wf.docid +] - document ID for
  current item
• [+ wf.subitemcount +] - the number of elements in
  folder
• [+ wf.description +] - displays field values
  descriptions.
• [+ wf.introtext +] - displays field values
  introtext

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

& parentRowHereTpl

Sets the output template for the current item, if it is a folder.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

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

& parentRowTpl

Sets the output template for all documents that are
folders.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

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

& hereTpl

The output template for the current document.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

Example:
<li [+ wf.classes +]> [+ wf.linktext +] [+ wf.wrapper +]

& innerTpl

Template for all the list of all subfolders.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

Example:
<ul [+ wf.classes +]> [+ wf.wrapper +]

& innerRowTpl

Template for a number of submenus.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

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

& innerHereTpl

The template for the current document, if it is a subfolder.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

Example:
<li [+ wf.classes +]> [+ wf.linktext +] [+ wf.wrapper +]

& activeParentRowTpl

Template for displaying subfolders that are ancestors
current document.

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

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

& categoryFoldersTpl

Template for displaying the category folder. Category folder
set by setting a blank template or link attribute
rel = "category".

Meaning: The name of the chunk to be used.

Possible variables: like & rowTpl

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

Name of assignable CSS classes

& firstClass

CSS class
for the first item of the current menu level.

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

& lastClass

CSS class
for the last item of the current menu level.

Value:

• last
• the name of the CSS class.

Default value: last

& hereClass

CSS class
indicating the state of "you are here." Defines the entire chain of items.

Value:

• here
• the name of the CSS class.

Default value: here

& selfClass

CSS class
indicating the state of "you are here." Specifies only the current document.

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

& parentClass

CSS class
pointing menu item as a folder (has attached documents)

Value:

• parent
• the name of the CSS class.

Default value: parent

& rowClass

CSS class
specifying each row of the menu.

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

& levelClass

CSS class
defining each menu level. For each level can be set
special CSS class
(level1, level2, level3, etc.)

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

& outerClass

CSS class
for the menu output template.

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

& innerClass

CSS class
for the template output sub menu items.

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

& webLinkClass

CSS class
for menu links.

Value:

• none
  (missing)
• the name of the CSS class.

Default value: none (absent)

Connect CSS and Javascript to the menu

* & cssTpl

CSS
to add to the page.

Value:

• name chunk with CSS
• false

Default value: false

* & jsTpl

Javascript to add to the page.

Value:

• name chunk with javascript
• false

Default value: false


Link: Snippet Wayfinder 2