Iframe Macro

Last modified by Vincent Massol on 2021/03/17 21:43

cogAllows you to add an iframe in the page content.
Developed by


0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


Allows you to add an iframe in the page content.


After you have installed the macro page, you can use the macro in any document in your wiki, either via the WYSIWYG editor, or by writing code like this in the wiki editor:

{{iframe url="http://www.xwiki.org" width="75%" height="350px" name="xwiki"}}
No iframe support for your browser. Bummer!

Editing an existing iframe in the WYSIWYG editor can be a bit tricky because bringing up the edit dialog for the macro is not easy - one has to click inside the macro, but not its iframe contents, It is easier if the macro is shown in its "collapsed" form (nor showing its contents) by pressing the "Enter" key when focussing in the macro, or select "Macro" > "Collapse all" from the toolbar.

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
URLnostringnoneURL of the website you want to display in your iframe
NameyesstringiframeName of the iframe
Widthyesint +px or percentage +%100%Width of the iframe
Heightyesint +px500pxHeight of the iframe


{{iframe url="http://www.xwiki.org" width="800" name="xwiki"}}{{/iframe}}




You can import the attached *.xar file via the XWiki Adminstration, in the "Import" section.
Afterwards the macro should be ready to use in any document.

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 following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki
Tags: include

Get Connected