Display an entity (document, property, etc.)

Description

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.

Usage

From WYSIWYG Editor

From Wiki Syntax

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

Parameters definition

Name	Optional	Allowed values	Default value	Description
page WarningHidden	no or reference	A page reference		XWiki 10.11.2+  The reference of the page to display. XWiki 12.4+ This parameter is hidden by default, use reference instead.
reference	no or page	An entity reference		The reference of the entity to display.
type WarningHidden	yes	document	document	The type of the entity. This parameter is only useful when used with the reference parameter. XWiki 12.4+ This parameter is hidden by default.
section	yes	string		The id to the Heading section to include in the target document. To do that you'll need to find out the id that is automatically generated by XWiki. To find it you have 2 solutions: If the heading title contains only characters in the ranges A-Z, a-z, 0-9, or the symbols : _ . -, you can compute the id manually: "H" + heading title, with spaces removed. For example, if your heading title is "My Heading", the id will be HMyHeading. Otherwise, if the heading title contains any other character (accented letters, punctuation, symbols, etc.), that character is not removed but replaced by its hexadecimal Unicode code point. For example, if your heading title is "Café", the id will be HCafE9 (the "é" is replaced by its hex code, E9). Because of this, computing the id manually can be error-prone for headings with special characters. In these cases we recommend viewing the HTML source of the page instead (see below). View the HTML source of the page in your browser and find the id that was generated. For example, for a level 2 heading title of My Heading, the HTML will be <h2 id="HMyHeading" class="wikigeneratedid"><span>My Heading</span></h2>, and thus the id to use is the one from the id attribute, i.e. HMyHeading. Note that in the future we plan to improve it.
excludeFirstHeading	yes	true or false	false	XWiki 12.4+ If true, exclude the heading from the displayed page if the first element of that page is a heading.

Examples

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

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

• org.xwiki.rendering:xwiki-rendering-api 18.7.0
• org.xwiki.rendering:xwiki-rendering-transformation-macro 18.7.0
• org.xwiki.commons:xwiki-commons-context 18.7.0
• org.xwiki.platform:xwiki-platform-bridge 18.7.0
• org.xwiki.platform:xwiki-platform-model-api 18.7.0
• org.xwiki.platform:xwiki-platform-display-api 18.7.0
• org.xwiki.platform:xwiki-platform-rendering-macro-context 18.7.0
• org.xwiki.platform:xwiki-platform-rendering-macro-include 18.7.0