org.xwiki.platform:xwiki-platform-display-macroXWiki Platform - Display - Macrojar00.0

XWiki Platform - Display - Macro

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>>Include Macro]]. == Usage == === From WYSIWYG Editor === {{image reference="displayMacro-wysiwygEditor.png"/}} === From Wiki Syntax === {{code}} {{display page="Page1/Page2"/}} {{/code}} === Parameters definition === |=Name|=Optional|=Allowed values|=Default value|=Description |##page## {{warning}}Hidden{{/warning}}|no or ##reference##|A [[page reference>>extensions:Extension.Model Module||anchor="HPageReferences"]]| |{{version since="10.11.2"}} The reference of the page to display. {{/version}}{{version since="12.4"}}This parameter is hidden by default, use ##reference## instead.{{/version}} |##reference ##|no or ##page##|An entity reference| |The reference of the entity to display. |##type {{warning}}Hidden{{/warning}}##|yes|document|document|The type of the entity. This parameter is only useful when used with the ##reference## parameter. {{version since="12.4"}}This parameter is hidden by default.{{/version}} |##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>>url:https://jira.xwiki.org/browse/XWIKI-17185]]. ))) |##excludeFirstHeading##|yes|true or false|false|{{version since="12.4"}}If true, exclude the heading from the displayed page if the first element of that page is a heading.{{/version}} == Examples == Example 1: {{code}} {{display page="Page1/Page2" /}} {{/code}} Example 2 (if you want to display a page from another wiki) {{code}} {{display page="somewiki:Page1/Page2" /}} {{/code}} Example 3: {{code}} {{display page="Page1/Page2" section="HMySection" /}} {{/code}} Example 4 (using the ##reference## parameter): {{code}} {{display reference="Page1.Page2.WebHome" /}} {{/code}} 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.GNU Lesser General Public License 2.1http://extensions.xwiki.org/xwiki/bin/view/Extension/Display%20MacroXWiki Development Teamhttps://xwiki.org/xwiki/bin/view/XWiki/XWikiTeamgitgit://github.com/xwiki/xwiki-platform.git/xwiki-platform-core/xwiki-platform-display/xwiki-platform-display-macrogitgit@github.com:xwiki/xwiki-platform.git/xwiki-platform-core/xwiki-platform-display/xwiki-platform-display-macrohttps://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/xwiki-platform-display/xwiki-platform-display-macro/jirahttps://jira.xwiki.org/browse/XWIKImacrofalsemaven.groupidorg.xwiki.platformmaven.artifactidxwiki-platform-display-macromaven.Modelorg.xwiki.platform:xwiki-platform-display-macro:jar:18.7.0xwiki.extension.recommendedVersions.commonsorg.xwiki.commons:.*/[18.7.0]xwiki.extension.recommendedVersions.platformorg.xwiki.commons:.*/[18.7.0], org.xwiki.rendering:.*/[18.7.0], org.xwiki.platform:.*/[18.7.0]xwiki.extension.recommendedVersionsorg.xwiki.commons:.*/[18.7.0], org.xwiki.rendering:.*/[18.7.0], org.xwiki.platform:.*/[18.7.0]4.1.4maven-xwikihttps://nexus.xwiki.org/nexus/content/groups/publicmaven