Include Macro

Last modified by Admin on 2018/08/27 19:49

cogInclude an entity (document, property, etc.)
TypeJAR
Developed by

XWiki Development Team

Active Installs0
Rating
Rate!
2 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise, XWiki Enterprise Manager

Installable with the Extension Manager

Description

Include other pages into the current page.

Usage

{{include page="page1/page2"/}}

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
pageno or referencea page reference since 10.6 the reference of the page to include. 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 include. See the Model module to understand the concept of references.
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 Heading section to include in the target document (note that headings generate anchors automatically in the form: "H" + heading title stripped of all non alpha characters).
documentnoa wiki document the name of the document to include. Deprecated since 3.4M1. Use page (or reference) instead.
contextyesnew/currentcurrentdefines whether the included page is executed in its separated execution context or whether it's executed in the context of the current page. Deprecated since 3.4M1. Use display macro for context=new.

Example

Example 1:

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

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

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

Example 3:

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

Example 4 (using the reference parameter):

{{include 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.

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
6.1XWiki Enterprise 6.1

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). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

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-rendering-macro-include 10.7):

Tags: include
Created by Thomas Mortagne on 2008/09/30 12:57
    

Get Connected