Version 7.1 by Jerome on 2010/12/06 12:59

cog
TypeDoc (Velocity Macro)
Category
Developed byUnknown
Rating
0 Votes
LicenseUnknown

Description

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 IncludeFormMacro 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("dev:Community.IRC")

Result

Get Connected