This document provides documentation on how to configure and customize the Wayfinder and Breadcrumbs snippets in MODx. It describes the various parameters that can be set for each snippet to control things like which templates are used, CSS classes, which fields are displayed, and more. Templates, placeholders, and general processing order are also outlined to help developers customize the output.

1. &hideSubMenus Def: FALSE processed and inserted into the
Pur: remove all non
non-active &sortOrder [+wf.wrapper+] placeholder. If no
submenus from the Wayfinder Pur: Allows the menu to be sorted innerTpl is specified the outerTpl is
Evolution 1.0.2 output if set to TRUE. This in either ascending or descending used when creating submenus.
parameter only wo if multiple
works order Opt: name of template chunk
Wayfinder levels are being displayed. Opt: ASC | DESC Def: see example
Snippet name: Wayfinder Opt: TRUE | FALSE Def: ASC Placeholders
Short Desc: builds site navigation Def: FALSE &sortBy [+wf.classes+]
Version: 2.0 &removeNewLines where classes specifed will be
Authors: Pur: allows the output to be sorted
Pur: set true to remove newline by any of the above fields on a level inserted (includes class=" ")
Kyle Jaebker (muddydogpaws.com)
Ryan Thrash (vertexworks.com) characters from output by level basis. This means that [+wf.classnames+]
Date: February 27, 2006 Opt: TRUE | FALSE each submenu will be sorted outputs the just the class names
Def: FALSE independently of all other (without class=" ")
Not: Wayfinder will automatically submenus at the same level. [+wf.wrapper+]
General Parameters add line breaks into the generated Random will sort the output where inner content will be inserted
output for increased code differently every time the page is Example
readability. To remove these line loaded if the snippet is called <ul id="topnav"
&startId breaks set this parameter to TRUE. uncached [+wf.classes+]>
Purpose: the starting point for the Opt: id | menutitle | pagetitle |
&textOfLinks [+wf.wrapper+]</ul>
menu (document ID) introtext | menuindex | published |
Option: 0 | a document id | Pur: The field specified in the
textOfLinks parameter will be hidemenu | parent | isfolder |
[*parent*] | [*id*] description | alias | longtitle | type | &rowTpl
Default: current docId inserted into the pl
placeholder
template | random Pur: template to output each
Note: - [+wf.linktext+].
Def: menuindex document, folder, or weblink
Opt: id | menutitle | pagetitle |
&level &limit (unless one of the templates below
introtext | menuindex | published |
Pur: the depth to build the menu (0 is used). Any submenus processed
hidemenu | parent | isfolder | Pur: The limit parameter causes
or no param goes through all levels) will be inserted into the
description | alias | longtitle | type | Wayfinder to only process the
Opt: 0 | number [+wf.wrapper+] placeholder.
template number of items specified per level.
Def: 0 Opt: name of template chunk
Def: menutitle (0 or no param goes unlimited).
Def: see example
&includeDocs &titleOfLinks Opt: 0, or a positive integer.
Pur: Acts as a filter and will limit the Def: 0 Placeholders
Pur: The field specified in the
output to only the documents titleOfLinks para
parameter will be &displayStart [+wf.classes+]
specified in this parameter. The where classes specifed will be
inserted into the placeholder Pur: output the document used as
startId is still required. [+wf.title+]. the startId using the template inserted (includes class=" ")
Opt: comma-delimited list of Opt: id | menutitle | pagetitle | startItemTpl. This parameter only [+wf.classnames+]
document ids introtext | menuindex | published | works if the startId is not equal to outputs just the class names
Def: (empty) hidemenu | parent | isfolder | zero. This functionality was added (without class=" ")
&excludeDocs description | alias | longtitle | type | so that it is easy to add header to [+wf.link+]
Pur: Acts as a filter and will remove template submenus. the href value for your link
the documents specified in this Def: pagetitle Opt: TRUE | FALSE [+wf.title+]
parameter from the output. The &rowIdPrefix Def: FALSE text for the link title
startId is still required. Pur: If this param
parameter is set, &config [+wf.linktext+]
Opt: comma-delimited list of Wayfinder will replace the Pur: load all of the parameters and text for the link display
document ids placeholder [+wf.id+] with a unique templates into a single configuration [+wf.wrapper+]
Def: (empty) id consisting of the specified prefix file ($filename.config.php). where to insert a submenu
&ignoreHidden plus the document id. Opt: [+wf.id+]
Pur: ignore the show in menu Opt: name of prefix breadcrumb where to insert a unique id
checkbox for documents and Def: FALSE cssplay-basicdropdown [+wf.attributes+]
include them in the menu Example: &rowIdPrefix=`topMenu` cssplay-dropdown where to insert link attributes
Opt: TRUE | FALSE will output the following for doc # cssplay-dropline [+wf.docid+]
Def: FALSE 29: id="topMenu29" cssplay-flyout the document identifier for the
&ph &useWeblinkUrl
seWeblinkUrl cssplay-flyoutrev current item
Pur: if set to TRUE the link cssplay-upmenu [+wf.subitemcount+]
Pur: name of a placeholder to set
specified in the weblink will be default displays the number of items in a
instead of directly returning the
output to the placeholder [+wf.link+] mollio folder
output results
Opt: TRUE | FALSE slidingdoors [+wf.description+]
Opt: TRUE | FALSE Def: default (blank)
Def: FALSE Def: TRUE the document's description
Not: To display send the output of &fullLink [+wf.introtext+]
Wayfinder to a placeholder set the Pur: if set to TRUE outputs the full Template Parameters output the introtext field
ph parameter equal to the name of url instead of a relative path. Example 1
the desired placeholder. All ouput These parameters specify the
Opt: TRUE | FALSE chunks that contain the templates <li [+wf.id+]
including the debugging (if on) will Def: FALSE [+wf.classes+]><a
be sent to the placeholder that will drive the generation of href="[+wf.link+]"
&showSubDocCount
showSubDocCount Wayfinder's output.
specified. title="[+wf.title+]"
Pur: The showSubDocCount [+wf.attributes+]>
&debug parameter, if set to TRUE, will &outerTpl [+wf.linktext+]</a>
Pur: will output information on how insert the number of documents in [+wf.wrapper+]</li>
each document was processed. Pur: template for the outer most
each folder into the placeholder wrapper for the generated ouput. All
Opt: TRUE | FALSE [+wf.subitemcount+]
Def: FALSE documents and folders will be
Opt: TRUE | FALSE
MODx Evolution 1.0.2: Wayfinder & Breadcrumbs CheatSheet r.1.1 | 1

2. Example 2 <ul[+wf.classes+]> &startItemTpl
[+wf.wrapper+]</ul> CSS Class Name
<li><a Pur: The startItemTpl is used for
href="[+wf.link+]"> templating the startId document Parameters
[+wf.linktext+]</a> - &innerRowTpl when the parameter &displayStart You can use CSS to control the
[+wf.description+] is set to TRUE. appearance (and in some cases the
Pur: allows for a different template
[+wf.wrapper+]</li> Opt: name of template chunk behavior) of various portions of the
for all items processed that have a
level great then one (any item Def: see example generated output. But it's up to you
&parentRowHereTpl inside a folder). Not: the default template shows the to tell Wayfinder the CSS
Pur: is used when the current item Opt: name of template chunk start item but does not link it. If you classnames you want to use, and
is displayed in the menu, it is a Def: NULL do not need a link, a class can be which portions of the generated
folder, and the folders children are Placeholders applied to the default template output you want them associated
displayed in the menu. If the current using the parameter with.
same as rowTpl &firstClass=`className`
item has children but they are not
Example
displayed in the menu this template Placeholders &firstClass - ()
will not be used. <li[+wf.classes+]><a
href="[+wf.link+]" same as rowTpl CSS class denoting the first item at
Opt: name of template chunk a given menu level
title="[+wf.title+]"> Example
Def: NULL &lastClass - (last)
[+wf.linktext+]</a> <h2>[+wf.linktext+]</h2>
Placeholders [+wf.wrapper+]</li> [+wf.wrapper+] CSS class denoting the last item at
same as rowTpl a given menu level
Example &innerHereTpl Template Processing Order &hereClass - (active)
<li[+wf.classes+]><a Pur: is used when the current item CSS class denoting the "you are
startItemTpl
href="[+wf.link+]" is displayed in the menu and the here" state all the way up the chain
title="[+wf.title+]"> parentRowHereTpl
item has a level greater than one (is innerHereTpl &selfClass - ()
[+wf.linktext+]</a>
in a folder). hereTpl CSS class denoting the "you are
[+wf.wrapper+]</li>
Opt: name of template chunk activeParentRowTpl here" state for current doc only
Def: NULL categoryFoldersTpl
&parentRowTpl &parentClass - ()
Placeholders parentRowTpl
Pur: is used when processing items CSS class denoting the menu item
same as rowTpl innerRowTpl
that are folders with their children is a container and has children
Example rowTpl
being displayed in the menu. &rowClass - ()
Opt: name of template chunk <li[+wf.classes+]><span> CSS class denoting each output
[+wf.linktext+]</span> Template Schema
Def: NULL row
[+wf.wrapper+]</li> The overall schema whereby the
Placeholders templates are joined together is as &levelClass - ()
same as rowTpl shown below. CSS class denoting each output
&activeParentRowTpl rows level, the level number will be
Example • &startItemTpl
Pur: is used on the parent, added to the specified class (i.e.
<li[+wf.classes+]><a grandparent, etc. of the current o &outerTpl
href="[+wf.link+]" level1, level2, level3, etc...)
item. The template is applied all the &rowTpl
title="[+wf.title+]">
&rowTpl &outerClass - ()
[+wf.linktext+]</a> way up the document tree.
Opt: name of template chunk &rowTpl CSS class for the outer template
[+wf.wrapper+]</li>
Def: NULL • &innerTpl &innerClass - ()
Placeholders o &innerRowTpl CSS class for the inner template
&hereTpl
same as rowTpl o &innerRowTpl &webLinkClass - ()
Pur: is used when the current item
Example o &innerRowTpl CSS class for weblinks
is displayed in the menu.
Opt: name of template chunk <li[+wf.classes+]><a &rowTpl Example
Def: NULL href="[+wf.link+]" &rowTpl To add one of these parameters to
title="[+wf.title+]"> the snippet call use this format:
Placeholders [+wf.linktext+]</a>
@Bindings Parameters &levelClass=`level`
same as rowTpl [+wf.wrapper+]</li>
If a template parameter's value This will result in
Example
begins with @FILE: then Wayfinder <li class="level2">
<li[+wf.classes+]> &categoryFoldersTpl
<span>[+wf.linktext+] will interpret the rest of the value as
Pur: is used when the item is a the directory path to a file which
</span>[+wf.wrapper+]
</li> folder, and either has the template contains the template. For example: Code-Embedding
set to blank or has rel="category" in &rowTpl= Parameters
the link attributes field. The children `@FILE:/assets/templates/
&innerTpl of the item must be displayed for myTemplate.txt` If the generated output of a
Pur: is used as a wrapper for each this template to be used as well. Wayfinder call requires the
If a template parameter's value
submenu. If no innerTpl is specified Opt: name of template chunk presence of certain CSS or
begins with @CODE: then
the outerTpl is used in its place. Def: NULL JavaScript, you can store the CSS
Wayfinder will interpret the rest of
Each item processed in the in one chunk and the JavaScript in
Placeholders the value as the template itself! For
another, then use these parameters
submenu will be inserted into the same as rowTpl example:
placeholder [+wf.wrapper+]. to have Wayfinder copy one or both
&rowTpl=
Opt: name of template chunk Example chunks into the HEAD section of
`@CODE:<h2>[+pagetitle+]
Def: NULL <li[+wf.classes+]><a </h2>` the webpage in which the
href="[+wf.link+]" Wayfinder call is made.
Placeholders title="[+wf.title+]">
same as outerTpl [+wf.linktext+]</a>
Example [+wf.wrapper+]</li>
MODx Evolution 1.0.2: Wayfinder & Breadcrumbs CheatSheet r.1.1 | 2

3. &cssTpl - (FALSE) &linkTextField instead and it will be converted for If you have a LOT of pages like this,
name of a chunk containing css you Pur: Prioritized list of fields to use you. you might try $hideUnder or use
would like added to the page as link text. The first of these fields Opt: [string] another template.
that has a value will be the title. Def: '...' Opt: document’s IDs
&jsTpl - (FALSE) Not: if you would like to use an Def: NULL
name of a chunk containing Opt: pagetitle, longtitle, description,
menutitle image, the entire image tag must be &hideUnder
javascript you would like added to provided.
the page Def: menutitle,pagetitle,longtitle Pur: Comma separated list of
&linkDescField &stylePrefix parent documents, whose
Pur: Prioritized list of fields to use Pur: Breadcrumbs will add style CHILDREN you don't want
Breadcrumbs as link title text. The first of these
fields that has a value will be the
classes to various parts of the trail.
To avoid class name conflicts, you
Breadcrumbs to appear on at all.
This enables you to hide
Snippet name: Breadcrumbs can determine your own prefix. Breadcrumbs on a whole folders
Short Desc: page trail navigation title.
Opt: pagetitle, longtitle, description, Opt: [string] worth of documents by specifying
Version: 1.0.1
Authors: menutitle Def: B_ the parent only. The PARENT will
Jaredc (modx.honeydewdesign.com) Def: description, longtitle, pagetitle, not have Breadcrumbs hidden
Date: 06/12/2006 menutitle however. If you wanted to hide the
Home Link Parameters parent and the children, put the
&showCrumbsAsLinks parent ID in hideUnder AND
The home link is unique. It is a link
General Parameters Pur: If for some reason you want that can be placed at the head of hideOn.
breadcrumbs to be text and not the breadcrumb trail, even if it is not Opt: document’s IDs
links, set to 0 (false). truly in the hierarchy. Def: NULL
&maxCrumbs Opt: 0 | 1 &stopIds
Pur: Max number of elements to Def: 1
&showHomeCrumb Pur: Comma separated list of
have in a breadcrumb path. The &templateSet
Pur: This toggles the "home" crumb document IDs that when reached,
default 100 is an arbitrarily high Pur: The set of templates you'd like to be added to the beginning of stops Breadcrumbs from going any
number that will essentially include to use. To create the new your trail. further. This is useful in situations
everything. If you were to set it to 2, templateSet, you have to edit the Opt: 0 | 1 like where you have language
and you were 5 levels deep, it snippet directly in MODx, and add it Def: 1 branches, and you don't want the
would appear like: inside $template array section. Breadcrumbs going past the
HOME > ... > Level 3 > Opt: defaultString | defaultList | &homeId
"home" of the language you're in.
Level 4 > CURRENT PAGE [string] Pur: Usually the page designated Opt: document’s IDs
It should be noted that the "home" Def: defaultString as "site start" in MODx Def: NULL
link, and the current page do not Not: each template is an array of 5 configuration is considered the
count as they are managed by their home page. But if you would like to &ignoreIds
elements:
own configuration settings. use some other document, you may Pur: Comma separated list of
1. crumb document IDs to explicitly ignore.
Opt: integer explicitly define it.
Def: 100 The crumb will either be a span (not Opt: document’s ID Opt: document’s IDs
linked) or an anchor (linked). So the Def: site_start Def: NULL
&pathThruUnPub "crumb" template piece determines
Pur: When your path includes an if anything else will be included with &homeCrumbTitle
unpublished folder, setting this to 1 that basic code. Pur: If you'd like to use something CSS
(true) will show all documents in 2. separator other than the menutitle (or
path EXCEPT the unpublished. pagetitle) for the home link. If left Placed in either the head section of
When set to 0 (false), the path will The string of text you'd like between blank, the title will follow the title the page, or in an external style
not go "through" that unpublished crumbs. order set in &linkTextField. sheet.
folder and will stop there. 3. crumbContainer Opt: [string]
Opt: 0 | 1 This piece defines what the Def: NULL .[&stylePrefix]crumbBox
Def: 1 breadcrumb container will be &homeCrumbDescription Span that surrounds all crumb
Example: Placeholders Pur: If you'd like to use a custom output
[[Breadcrumbs? [+crumbBoxClass+] and description (link title) on the home .[&stylePrefix]hideCrumb
&pathThruUnpub=`0`]] [+crumbs+]. link. If left blank, the title will follow Span surrounding the "..." if there
“b” unpublished 4. lastCrumbWrapper the title order set in &linkDescField. are more crumbs than will be
"a > c > d" This piece defines how the last Opt: [string] shown
&respectHidemenu crumb will be treated. Def: NULL .[&stylePrefix]currentCrumb
Pur: Setting this to 1 (true) will Placeholders Span or A tag surrounding the
respect the hidemenu setting of the [+lastCrumbClass+] and Custom Behaviors current crumb
document and not include it in trail. [+lastCrumbSpanA+]. .[&stylePrefix]firstCrumb
Opt: 0 | 1 Span that always surrounds the first
5. firstCrumbWrapper
Def: 1 &showCrumbsAtHome crumb, whether it is "home" or not
This piece defines how the first
&showCurrentCrumb crumb (whether it is "home" or not)
Pur: This parameter defines .[&stylePrefix]lastCrumb
Pur: Include the current page at the whether to show the breadcrumbs
will be treated. Span surrounding last crumb,
end of the trail. On by default. on the home page.
Placeholders whether it is the current page or not
Opt: 0 | 1 Opt: 0 | 1
[+firstCrumbClass+] and Def: 0 .[&stylePrefix]crumb
Def: 1
[+firstCrumbSpanA+]. Not: the result will show Class given to each A tag
&currentAsLink surrounding the intermediate
&crumbGap Home » Home
Pur: If the current page is included, crumbs (not home, or hide)
this parameter will show it as a link Pur: String to be shown to &hideOn
represent gap if there are more .[&stylePrefix]homeCrumb
(1) or just plain text (0). Pur: Comma separated list of
Opt: 0 | 1 crumbs in trail than can be shown. documents you don't want Class given to the home crumb
Def: 0 You cannot use "=", so use "||" Breadcrumbs on at all.
MODx Evolution 1.0.2: Wayfinder & Breadcrumbs CheatSheet r.1.1 | 3