nav

Creates a simple HTML list as navigation below a given page. This method basically serves as a shorthand version of a foreach loop iterating a pagelist of type "children".

<@ nav { options } @>

Options

context String: The parent context of the listed navigation items. The default is "/".
homepage Boolean: Defines whether the homepage is included in the navigation that uses the root page as context. The default is false.
excludeHidden Boolean: Defines whether hidden pages are excluded from the navigation. The default is true.
class String|false: An optional class of the wrapping <ul> element. The default is false.
active String|false: An optional class for the active <li> element. The default is false.

Example

A simple example that generates a top-level navigation:

<@ nav {
  context: '/',
  class: 'nav',
  active: 'active'
} @>

img navChildren

Creates the markup for a breadcrumb trail to the current page.

This method is a shorthand version for the nav method, using the current page as the parent context.

This method is a shorthand version of the nav method, using the parent page of the current page as the parent context. The included pages are therefore all siblings of the current page.

This method is a shorthand version of the nav method, using the homepage page as the parent context.

Generates the HTML for a full site tree. This method can be used as a shorthand for recursively iterating over pagelists to create nested lists of page links.

Creates a new pagelist object. The current pagelist will be replaced. A foreach loop can be used to iterate the pagelist object. This method does not have any output. To only update the configuration of the current pagelist, without resetting all other parameters, the pagelist method can be used instead.

Modifies the currently defined pagelist object. Only specified options will be changed, all others will be preserved. To restore a default pagelist and reset all options, the newPagelist method can be used.

Redirects the current page to a given URL.