Overview
The {space-breadcrumbs} macro will add breadcrumbs for a specified page. In particular, it analyzes the space hierarchy information so that it includes all of the parent spaces up to the root space in the breadcrumbs.
Control of the display of the breadcrumb is done using an second optional second parameter - with three possible values.
The macro is used when setting up space hierarchies. It is usually added to the root space in your hierarchy in the space home page.
Parameters
Parameter | Required | Default | Notes | Version |
|---|---|---|---|---|
page |
| The page to display the breadcrumb for including the space hierarchy for the page. | ||
type | home | The information to be included in the breadcrumb – there are three values:
|
Usage
In the macro browser, choose the Space Breadcrumbs macro:
The macro editor displays the space breadcrumb for the default page - the current page @self.
The macro editor options are:
- the page to display the breadcrumb for including the space hierarchy
- a dropdown option menu to include the hierarchy to the page from the space dashboard, the space home page or both of these.
Any options are displayed in the macro placeholder.
The breadcrumb is displayed on the page as follows:
In this example the the space breadcrumb macro is showing the hierarchy for the Space Hierarchy page.
Reference Markup
{space-breadcrumbs:page=@self|type=home}
Related Macros