modx CMS

Instructions

Copy the contents of the file snippet.wayfinder.tpl.php into a new snippet named Wayfinder.

Create a new folder under assets/snippets named wayfinder.

Copy the file wayfinder.inc.php into the newly created folder.

To get the default menu output use the following snippet call: Wayfinder? &startId=`0`

For documentation on all of the paramters refer to the file wayfinder.documentation.htmlUpdates

• template variable support; just add a placeholder into your template and it will get processed i.e. for the tv: docTags you would add a placeholder +docTags+
• link for site start no longer includes the alias; i.e. www.modxcms.com instead of ww.modxcms.com/home.html
• Ability to use a configuration file to set all of the wayfinder parameters. more documentation on this to come.
• Ability to specify templates like ditto using the @FILE & @CODE options
• parent templates only used if child documents are shown in the menu
• Enhanced debugging
• Rewrote how documents are retrieved to only use one db query for enhanced performance.
• New parameter &fullLink - if set to true outputs the full url instead of a relative path.
• New parameter &displayStart - displays the document specified as the startId as a header to the menu (only works with startId not equal to 0)
• New template &startItemTpl - Used to format the output of the startId Doc if &displayStart is used. Defaults to <h2>+linktext+</h2>
• New parameter &includeDocs - comma delimited list of documents to be included in output. The startId is still required this just acts as a filter.
• New paramter &excludeDocs - comma delimited list of documents to be excluded from the output. The startId is still required this just acts as a filter.
• Rewrote some other stuff to make it work better and hopefully a little faster.

Instructions

Copy the contents of the file snippet.wayfinder.tpl.php into a new snippet named Wayfinder.

Create a new folder under assets/snippets named wayfinder.

Copy the file wayfinder.inc.php into the newly created folder.

To get the default menu output use the following snippet call: Wayfinder? &amp;startId=`0`

For documentation on all of the paramters refer to the file wayfinder.documentation.htmlUpdatesMinor update to fix error for users upgrading to MODx version 0.9.2.2

Instructions

Copy the contents of the file snippet.wayfinder.tpl.php into a new snippet named Wayfinder.

Create a new folder under assets/snippets named wayfinder.

Copy the file wayfinder.inc.php into the newly created folder.

To get the default menu output use the following snippet call: Wayfinder? &amp;startId=`0`

For documentation on all of the paramters refer to the file wayfinder.documentation.htmlUpdates

• Updated database query so sorting works correctly for MySql 4.1.12 users
• Added parameters for determining sortBy and sortOrder
• Added placeholders for introtext and description
• Added ability to show count of docs in a folder with new placeholder
• Removed some code from snippet into class for easier maintenance
• Added limit parameter to allow for result limiting
• Added random option to sortBy parameter

Instructions

Copy the contents of the file snippet.wayfinder.tpl.php into a new snippet named Wayfinder.

Create a new folder under assets/snippets named wayfinder.

Copy the file wayfinder.inc.php into the newly created folder.

To get the default menu output use the following snippet call: Wayfinder? &amp;startId=`0`

For documentation on all of the paramters refer to the file wayfinder.documentation.htmlUpdates

• Added category support, with additional template
• Added active parent template
• Added docid placeholder for output of docid
• Added separate placeholder for class names
• Fixed last item detection
• Updated to add parameter for using content for url or using docId for weblinks.
• Added support for link_attributes
• Made custom version of getActiveChildren in class
• Added class for weblinks

Instructions

Copy the contents of the file snippet.wayfinder.tpl.php into a new snippet named Wayfinder.

Create a new folder under assets/snippets named wayfinder.

Copy the file wayfinder.inc.php into the newly created folder.

To get the default menu output use the following snippet call: Wayfinder? &amp;startId=`0`

For documentation on all of the paramters refer to the file wayfinder.documentation.htmlUpdates

• Fixed bug for assigning parentClass
• Added parameter rowIdPrefix to create a custom id for each menu item
• Removed ultimateparent functionality, if you want to use this, nest the snippet calls.
• Added parentRowHereTpl, this tempalte is used on a folder if it is the current doc
• Added selfClass, this sets a class for the current doc only (hereClass sets a class for the current doc and its parents)

Instructions

Copy the contents of the file snippet.wayfinder.tpl.php into a new snippet named Wayfinder.

Create a new folder under assets/snippets named wayfinder.

Copy the file wayfinder.inc.php into the newly created folder.

To get the default menu output use the following snippet call: Wayfinder? &amp;startId=`0`

For documentation on all of the paramters refer to the file wayfinder.documentation.html