Display Macro

Last modified by Admin on 2024/05/29 17:36

cogDisplay an entity (document, property, etc.)
Developed by

XWiki Development Team

Active Installs0
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard


Introduced in XWiki 3.4M1

Installable with the Extension Manager


Display an entity in its own context. This mean that the entity content will be parsed and transformation executed on it as if it was rendered alone. For example a document will produce the exact same result as if you were displaying it directly.

It for examples allows to include a content page in the current page. To include an entity in the current context see include macro.


From WYSIWYG Editor


From Wiki Syntax

{{display page="Page1/Page2"/}}

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
pageno or referenceA page reference since 10.11.2The reference of the page to display. You should use this parameter rather than the reference one which is more complex to use.
referenceno or pageAn entity reference The reference of the entity to display
typeyesdocumentdocumentThe type of the entity. This parameter is also only useful when used with the reference parameter. It's not needed when using the page parameter.
sectionyesstringThe anchor to the section to display in the target document (note that headings generate anchors automatically in the form: "H" + heading title stripped of all non alpha characters). Only taken into account when the type is document.
excludeFirstHeadingyestrue or falsefalseSince 12.4RC1If true, exclude the heading from the displayed page if the first element of that page is a heading.


Example 1:

{{display page="Page1/Page2" /}}

Example 2 (if you want to display a page from another wiki)

{{display page="somewiki:Page1/Page2" /}}

Example 3:

{{display page="Page1/Page2" section="HMySection" /}}

Example 4 (using the reference parameter):

{{display reference="Page1.Page2.WebHome" /}}

NOTE: Be sure to include the / within the "/}} at the end, otherwise any content that comes after the included section on this page will fail to appear.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.


Dependencies for this extension (org.xwiki.platform:xwiki-platform-display-macro 16.4.0):

Get Connected