HTML Include Macro
The HTML Include macro allows you to include the contents of an external HTML file (a webpage) in a Confluence page.
HTML macros are disabled by default
The HTML macro will only be available if it has been enabled by an administrator. Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks.
Using the HTML Include Macro
To insert the HTML Include macro into a page:
- From the editor toolbar, choose Insert
> Other Macros - Find and select the required macro
Speed it up with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro.
To edit an existing macro: Click the macro placeholder and choose Edit. This will open the macro details, so you can edit the macro parameters.
Parameters
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).
| Parameter | Required | Default | Description |
|---|---|---|---|
HTML Page's URL(url) | Yes | None | The URL of the page to include. |
Enabling the HTML Include Macro
The HTML Include macro is disabled by default. You'll need Confluence Administrator or System Administrator permissions to enable this macro.
Enabling these macros can make your Confluence site vulnerable to cross-site scripting attacks. You should only turn on these macros if you trust all your users not to attempt to exploit them. We strongly recommend leaving this macro disabled if you allow self-signed up or anonymous users to create content.
To enable the HTML Include macro:
Go to
> Manage apps- Select System from the drop down and search for the Confluence HTML Macros system app.
- Expand the listing and enable the html-include (html-include-xhtml) module.
Administrators can also choose to use the whitelist to restrict URLs that can be displayed in the HTML Include macro.
Troubleshooting
- Administrators can define a whitelist of trusted URLs. If a URL is not in the whitelist, you will see an error message in the HTML Include macro.
You can only use the HTML Include macro for pages with absolute links. If you use the macro to include an HTML page that has relative links, you will see a 'Page Not Found' error. See CONF-6567 - Getting issue details... STATUS .
Wiki markup example
This example is useful when you want to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.
Macro name: html-include
Macro body: None.
{html-include:url=http://www.example.com}