This macro is bundled with all the XWiki products by default.
Macro developed by the XWiki Development Team.
This macro cannot currently be downloaded separately.

IncludeTopic Macro

Renders the specified XWiki page in its own context and surrounded by {pre}{/pre} tags to avoid further rendering of XWiki syntax by the including document.

You can use Include Form Macro to include a page that is rendered within the context of the including document

Usage

#includeTopic($pageName)

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
pageNamenoa stringnoneA page name using the syntax described below

The pagename parameter may take the following form:

[database:][web.]page

where optional parts are surrounded by brackets

  • If database is present, the space and page parts will refer to a document in the specified database in the context of an XWiki farm.
  • If web is present, then it will be used as part of the full page name, otherwise the web name of the enclosing document will be used

Example

This macro may be used to display an XWiki page in another one. For instance, the page Community.IRC? from this web site is included below.

#includeTopic("Community.IRC")

Result

Version 5.1 last modified by VincentMassol on 19/06/2008 at 22:07

Comments 0

No comments for this document

Attachments 0

No attachments for this document

Creator: LuisArias on 2007/04/08 11:39
This wiki is licensed under a Creative Commons license
1.4.1.10194