Skip to content
Randy Merrill edited this page Jan 28, 2011 · 15 revisions

Breadcrumb — getBreadcrumb(options)

Options

The following options can be passed while retrieving the breadcrumb.

Option Description Default
separator Text used to separate the breadcrumb items. :
showMultiple Determines if only the current page will be shown or if multiple breadcrumb items will be used. true
topLevel Used as the top level that will be displayed. If the page level is less than the top level it will return a blank breadcrumb. 1
useNavTitle Determines if the breadcrumb will use the navigation title or the normal page title. true

HTML Title — getHtmlTitle(options)

Options

The following options can be passed while retrieving the html title.

Option Description Default
separator Text used to separate the html title items. :
showMultiple Determines if only the current page will be shown or if multiple items will be used for the title. false
useNavTitle Determines if the html title will use the navigation title or the normal page title. true

Navigation — getNavigation(level, navPosition, options, user)

Options

The following options can be passed while retrieving the navigation.

Option Description Default
depth Number of navigation levels to display. 1
innerTag Tag used around the individual navigation elements. ul
numLevels
Used to control the number levels of navigation to retrieve. If the value is > 1 it will nest any available sub navigation. If the value is -1 it will return all levels of nested navigation.
		<div>
			Can also be used with the selected only to only show sub navigation 
			when the sub navigation is part of the current path.
		</div>
	</td>
	<td><code>1</code></td>
</tr>
<tr>
	<td><code>outerTag</code></td>
	<td>
		Tag used as the parent to the individual navigation elements.
	</td>
	<td><code>ul</code></td>
</tr>
<tr>
	<td><code>parentPath</code></td>
	<td>
		Used as the parent path for the navigation.
		Useful when trying to output navigation for a that does not change based upon the current path.
	</td>
	<td><code>@current path@</code></td>
</tr>
<tr>
	<td><code>selectedOnly</code></td>
	<td>When showing more than 1 level will only display sub navigation for the current page.</td>
	<td><code>false</code></td>
</tr>

Clone this wiki locally