Display Macro
 | Display an entity (document, property, etc.) |
| Type | JAR |
| Category | Macro |
| Developed by | XWiki Development Team |
| Active Installs | 0 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
| Compatibility | Introduced in XWiki 3.4M1 |
Table of contents
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 | 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 | 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 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. | |
| 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 17.8.0):
- org.xwiki.rendering:xwiki-rendering-api 17.8.0
- org.xwiki.rendering:xwiki-rendering-transformation-macro 17.8.0
- org.xwiki.commons:xwiki-commons-context 17.8.0
- org.xwiki.platform:xwiki-platform-bridge 17.8.0
- org.xwiki.platform:xwiki-platform-model-api 17.8.0
- org.xwiki.platform:xwiki-platform-display-api 17.8.0
- org.xwiki.platform:xwiki-platform-rendering-macro-context 17.8.0
- org.xwiki.platform:xwiki-platform-rendering-macro-include 17.8.0
