Welcome to Scribd, the world's digital library. Read, publish, and share books and documents. See more
Download
Standard view
Full view
of .
Save to My Library
Look up keyword
Like this
2Activity
0 of .
Results for:
No results containing your search query
P. 1
MODx Wayfinder and Breadcrumbs Cheatsheet v1.1

MODx Wayfinder and Breadcrumbs Cheatsheet v1.1

Ratings: (0)|Views: 1,208 |Likes:
Published by Thomas Grant
MODx Wayfinder and Breadcrumbs Cheatsheet v1.1

www.muddydogpaws.com
MODx Wayfinder and Breadcrumbs Cheatsheet v1.1

www.muddydogpaws.com

More info:

Published by: Thomas Grant on May 20, 2011
Copyright:Traditional Copyright: All rights reserved

Availability:

Read on Scribd mobile: iPhone, iPad and Android.
download as PDF or read online from Scribd
See more
See less

07/10/2013

pdf

 
 Evolution 1.0.2
Wayfinder 
Snippet name: Wayfinder Short Desc: builds site navigationVersion: 2.0 Authors:Kyle Jaebker (muddydogpaws.com)Ryan Thrash (vertexworks.com)Date: February 27, 2006
General Parameters
&startId
Purpose:
the starting point for themenu (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 theoutput to only the documentsspecified in this parameter. ThestartId is still required.
Opt:
comma-delimited list of document ids
Def:
(empty)
&excludeDocs
Pur:
 Acts as a filter and will removethe documents specified in this parameter from the output. ThestartId 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 theoutput 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 
&hideSubM
Pur:
removesubmenus frooutput if set t  parameter onlevels are bei 
Opt:
TRUE |
Def:
FALSE 
&removeNe
Pur:
set truecharacters fro
Opt:
TRUE |
Def 
: FALSE 
Not:
Wayfind add line breaoutput for inc readability. T breaks set thi 
&textOfLin
Pur:
The fiel textOfLinks pinserted into t +wf.linktext+
Opt:
id | menintrotext | mehidemenu | pdescription |template
Def:
menutitl 
&titleOfLin
Pur:
The fiel titleOfLinks pinserted into t [+wf.title+].
Opt:
id | menintrotext | mehidemenu | pdescription |template
Def:
 pagetitle
&rowIdPref 
Pur:
If this pWayfinder wil  placeholder [ id consisting plus the docu 
Opt:
name of 
Def:
FALSE 
Example:
&r will output the29: id="topMe
 
&useWebli
Pur:
if set tospecified in thoutput to the
Opt:
TRUE |Def: TRUE 
&fullLink
Pur:
if set tourl instead of 
Opt:
TRUE |
Def:
FALSE 
&showSub
Pur:
The sho parameter, if insert the nu each folder in+wf.subitemc 
Opt:
TRUE |
MODx Evolution 1.0.2: Wa
enus
ll non-activem the Wayfinder TRUE. Thisy works if multipleg displayed. ALSE 
wLines
o remove newlinem output  ALSE 
 
r will automatically s into the generated eased coderemove these line parameter to TRUE.
s
specified in therameter will behe placeholder .title | pagetitle |uindex | published |rent | isfolder |lias | longtitle | type |
s
 
 
specified in therameter will behe placeholder title | pagetitle |uindex | published |rent | isfolder |lias | longtitle | type |
ix
rameter is set,replace thewf.id+] with a uniquef the specified prefix ment id. prefix 
 
wIdPrefix=`topMenu`following for doc #nu29" 
kUrl
TRUE the link e weblink will belaceholder [+wf.link+]  ALSE 
 
TRUE outputs the full a relative path. ALSE 
 
ocCount
wSubDocCount et to TRUE, will ber of documents into the placeholder ount+]  ALSE 
 Def:
FALSE 
&sortOrder 
Pur:
 Allows the menu to be sorted in either ascending or descendingorder 
Opt:
 ASC | DESC 
 
Def: ASC 
&sortBy
Pur:
allows the output to be sorted by any of the above fields on a level by level basis. This means that each submenu will be sorted independently of all other submenus at the same level.Random will sort the output differently every time the page isloaded if the snippet is called uncached 
Opt:
id | menutitle | pagetitle |introtext | menuindex | published |hidemenu | parent | isfolder |description | alias | longtitle | type |template | random
 Def:
menuindex 
&limit
Pur:
The limit parameter causesWayfinder to only process thenumber of items specified per level.(0 or no param goes unlimited).
Opt:
0, or a positive integer.
 
Def: 0 
&displayStart
Pur:
output the document used asthe startId using the templatestartItemTpl. This parameter only works if the startId is not equal tozero. This functionality was added so that it is easy to add header tosubmenus.
Opt:
TRUE | FALSE 
 Def:
FALSE 
&config
Pur:
load all of the parameters and templates into a single configurationfile ($filename.config.php).Opt:breadcrumbcssplay-basicdropdowncssplay-dropdowncssplay-droplinecssplay-flyout cssplay-flyoutrev cssplay-upmenu default mollioslidingdoors
 Def:
default (blank)
Template Parameters
These parameters specify thechunks that contain the templatesthat will drive the generation of Wayfinder's output.
&outerTpl
Pur:
template
 
for the outer most wrapper for the generated ouput. All documents and folders will be
finder & Breadcrumbs CheatSheet r.1.1
| 1
 processed and inserted into the[+wf.wrapper+] placeholder. If noinnerTpl is specified the outerTpl isused when creating submenus.
Opt:
name of template chunk 
 Def:
see example
Placeholders
[+wf.classes+]
where classes specifed will beinserted (includes class=" ")
[+wf.classnames+]
outputs the just the class names(without class=" ")
[+wf.wrapper+]
where inner content will be inserted 
Example
<ul id="topnav"[+wf.classes+]>[+wf.wrapper+]</ul>
&rowTpl
Pur:
template to output eachdocument, folder, or weblink (unless one of the templates below is used). Any submenus processed will be inserted into the[+wf.wrapper+] placeholder.
Opt:
name of template chunk 
 Def:
see example
Placeholders
[+wf.classes+]
where classes specifed will beinserted (includes class=" ")
[+wf.classnames+]
outputs just the class names(without class=" ")
[+wf.link+]
the href value for your link 
[+wf.title+]
text for the link title
[+wf.linktext+]
text for the link display 
[+wf.wrapper+]
where to insert a submenu 
[+wf.id+]
where to insert a unique id 
[+wf.attributes+]
where to insert link attributes
[+wf.docid+]
the document identifier for thecurrent item
[+wf.subitemcount+]
displays the number of items in afolder 
[+wf.description+]
the document's description
[+wf.introtext+]
output the introtext field 
Example 1
<li [+wf.id+][+wf.classes+]><ahref="[+wf.link+]"title="[+wf.title+]"[+wf.attributes+]>[+wf.linktext+]</a>[+wf.wrapper+]</li>

Activity (2)

You've already reviewed this. Edit your review.
1 thousand reads
1 hundred reads

You're Reading a Free Preview

Download
/*********** DO NOT ALTER ANYTHING BELOW THIS LINE ! ************/ var s_code=s.t();if(s_code)document.write(s_code)//-->