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

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