General Actions:
Display Macro
Last modified by Thomas Delafosse on 2013/01/31 17:56
 | Display an entity (document, property, etc.) |
| Type | JAR |
| Developed by | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Enterprise, XWiki Enterprise Manager |
| 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.
To include an entity in the current context see include macro.
Usage
{{display reference="SpaceOf.DocumentToDisplay" type="document"/}}
Parameters definition
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| reference | no | an entity reference | the name of the entity to display | |
| type | yes | document | document | the type of the entity, for now only document is supported |
| 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. |
Example
Example 1:
{{display reference="DocumentToDisplay"/}}
Example 2:
{{display reference="DocumentToDisplay" section="HMySection"/}}
Example 3 (if you want to include a document from another wiki)
{{display reference="wiki:Space.PageName"/}}