Renders a breadcrumb for the current page.
- Audience
- Categories
- Link / Document
- Tags
- Type
- Since
- 2.0
Render a breadcrumb to the current page.
Properties
The macro provides the following properties.
Template for Label
Specify how the label for each element of the breadcrumb is to be rendered.
The template allows to contain references to document properties. Use ${...} to reference a property and $[...] to reference a property and render a link to the document.
Per default the template $[Name] is used.
Template for Tooltip
Specify how the tooltip for each element of the breadcrumb is to be rendered.
The template allows to contain references to document properties. Use ${...} to reference a property. Since tooltips allow no HTML elements, links are not allowed.
Per default the template ${Short Description} is used.
Use Primary
Check to use the primary page instead of the current page.
This option is useful if the macro is used in the context of a header or footer page where the information should be used from the rendered page and not from the page the macro is part of.
This parameter is available since version 2.5.
Render Self
Checkbox to select whether (checked) or not (unchecked) the page itself should be part of the crumb trail.
If selected, the page will be shown on the right as the last element on the crumb trail.
First Count
Specify the number of elements from the root (left side of the crumb trail) to be always visible.
Defaults to 1.
Last Count
Specify the number of elements from the leaf (right side of the crumb trail) to be always visible.
Defaults to 1.
Breadcrumb Section ID
The breadcrumb is rendered within a HTML container. This parameter allows to control the HTML identifier of the container.
The default identifier is valid to replace Confluence breadcrumb. If you employ this macro for some other use case, you need to specify an ID that does not collide with any other ID on the page.
Breadcrumb ID
The breadcrumb is rendered as an HTML list. This parameter allows to control the HTML identifier of this list.
The default identifier is valid to replace Confluence breadcrumb. If you employ this macro for some other use case, you need to specify an ID that does not collide with any other ID on the page.
Details
Integration in Page Layout
To replace the native rendering of the breadcrumbs, replace the inclusion of /pages/page-breadcrumbs.vm with
##parse ("/pages/page-breadcrumbs.vm")
<content tag="breadcrumbs">
$helper.renderConfluenceMacro("{projectdoc-breadcrumb-macro:
tooltip-template=$\{Title\}: $\{Short Description\}|
first-count=1|last-count=1|
breadcrumb-section-id=breadcrumb-section|
breadcrumbs-id=breadcrumbs}")
</content>To improve readability we added newlines to render each parameter on its own line.
Related macros
| Name | Short Description | Tags |
|---|---|---|
Renders a template with property references. |
||
Renders the value of a document property as an image. The property value is required to an URL that points to an image. |
||
Renders the value of a document property as a link with an alternative label. |
||
Renders the list value of a document property. |
||
Renders the value of a property of a document. |
||
Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property. |
||
Displays a document property from a referenced document. |
||
Renders a space attribute value. |
||
Renders a space property value. |
||
Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name. |
||
Renders the property of the parent document, if it has the same doctype. |
|
Resources
- Quirk Breadcrumb Root Node Fix
- Allows to render an additional node using the CSS class 'first'.