Deprecation notice:
Please note that the URL user and URL password parameters are deprecated and will be removed on March 31, 2022. We recommend using profiles to access your data from remote locations.
To comply with Atlassian requirements, the HTML macro name has changed from HTML to Html-bobswift from version 5.7.0. Any existing occurrences of the HTML macro name are not affected by this change; however, only the Html-bobswift macro name is now available in the macro browser for any new macro additions to the pages.
Features
- Render HTML content from within the macro body, attachments, or remote locations using URLs.
- Allows malformed HTML to be cleaned so content displays properly with JTidy.
- Supports find and replace for adjusting resulting output.
- Allows the user to restrict the usage of Javascript in the Html-bobswift macro (based on the configuration of Allow Javascript in the Configuration page). The Confluence page throws a rendering error if this parameter is not enabled, and Javascript is inserted while using the macro.
- Supports capabilities for including data similar to other scripting macros.
- Supports security restrictions as described in Macro Security for Confluence.
The macro works with valid, downloadable HTML files only.
How to identify HTML files that are valid for the macro?
Paste the file link into your browser's address bar. If the actual HTML code is displayed in the browser, it is considered to be invalid or in an incorrect format. If the file downloads to your system, the macro can process the file and its contents.
If you want to specify a URL in the Location of HTML data parameter, make sure that only a raw URL is provided. A raw URL is defined as the part of the URL following the domain information and includes the query string, if present. For example, in the URL string http://www.contoso.com/articles/recent.aspx, the raw URL is /articles/recent.aspx.
Important information for Macro Security users!
Existing pages that use the HTML macro name with the Macro Security macro are unaffected, and for any new macro additions with the Html-bobswift macro name, specify the same HTML configurations as given for the HTML macro. In such cases, parameters for both, HTML and Html-bobswift, macro names must be added in Macro Security for Confluence Configuration to render the HTML content on the pages correctly. Any entries made for the XSLT macro remain unaffected and hence, the entries made for this macro can be retained as-is in the Macro Security configuration. Refer to the Configuration page for more information.
Other HTML macros
- Confluence comes with two native macros: {html} and {html-include}. These macros are disabled by default in Confluence, since it is a security exposure unless you only have trusted users on your site. The native Confluence HTML macros must be disabled to use the Html-bobswift macro of HTML for Confluence.
- HTML Tag - a safer alternative to the standard {html} macro but does not allow for arbitrary HTML to be included.
By default, header content is excluded as it could interfere with a Confluence page's HTML code. Enable Include head section HTML to include the header tag, provided it does not mess up the HTML content.
Parameters
| Macro browser label | Default | Description | Macro parameter |
|---|---|---|---|
| Format | html | Specify how the output is treated. The options are as follows:
| output |
| Profile | Enter the profile name to access the files to be rendered. Profiles contain a basic set of parameters used to access a remote location such as the type of URL, user credentials, and so on. Refer to this link to know more about profile configuration and this link for tutorials.
| profile | |
| Location of HTML data | macro body | Enter the location that contains the HTML file to be rendered. If a location of data is specified, the included data follows the body data (if any).
Precedence in URL handling URLs are processed using a fixed precedence explained as follows:
| script |
| Find regex patterns | Enter a comma-separated list of regex patterns to dynamically update the output content. Refer to this article for more information about regular expressions. Example: (href=)(/display) | find | |
| Replacement strings | Enter a comma-separated list of positions to search for patterns in the output content. Note that the positions are indexed beginning at "1". If a comma is a part of the search, use single quotes (') around it. Example: http://www.google.com/$1 | replace | |
| File encoding | system default | Specify the encoding for an external file, if different from the system default handling. Example: UTF-8. | encoding |
| Select to use JTidy | false | Enable this option to use JTidy to ensure the HTML is well formed to prevent page display problems. | tidy |
| Remove conflicting tags | true | Disable this option to surround the HTML with an iframe. By default, this parameter allows the display of HTML content in a Confluence page without an iframe. The html, body, and (optionally) the head tags including their corresponding ending tags are removed so that it displays properly on a Confluence page. | clean |
| Include head section HTML | false | Enable this option to retain all the other tags from the header section and treat them as regular body content. This is useful for retaining style information in particular. By default, the head tag is always removed. Valid only if Remove conflicting tags is enabled. | head |
| Omit panel when output is wiki | false | Enable this option to hide the panel around the rendered content. This parameter provides a way of setting the nopanel parameter of the noformat macro. Valid only if Format is set to wiki. | noPanel |
| Width of iframe | 500 | Enter the width for the iframe that displays the HTML content. Valid only if Remove conflicting tags is disabled. | width |
| Height of iframe | 500 | Enter the height for the iframe that displays the HTML content. Valid only if Remove conflicting tags is disabled. | height |
| URL user | Enter the user name to be used for URL access to HTML files. | user | |
| URL user password | Enter the user password to be used for URL access to HTML files. | password | |
| Timeout in milliseconds | Enter time in milliseconds to wait until the URL connection times out before getting data. Use this to increase time needed for slow connections. Note that if a zero is given, the connection may wait indefinitely. | timeout |
About profiles:
- Administrators create profiles to connect to remote locations. A profile contains the basic information required to access a remote location and usually contains the base URLs of the location. In the macro editor, you must specify the relative URL in the Location of HTML data parameter. The macro combines these paths to create an absolute URL. If any part of this URL is incorrect or the URL itself is invalid, the macro generates an error. To get more information about profiles, select the relevant article specified in the Helpful resources section.
- Since release 5.7.0, the HTML macro name has changed from HTML to Html-bobswift. Existing pages that use the HTML macro name with the Macro Security macro are unaffected. Any new pages that are created automatically use the Html-bobswift macro name. So, entries for both, HTML and Html-bobswift, macro names must be kept in Macro Security for Confluence Configuration.
If any of these entries are not available in Macro Security for Confluence Configuration, an error, "Security restricted macro with parameter 'profile' is not allowed. An edit restriction is required that matches the macro authorization list.", is displayed. Ensure that the following entries are available for the HTML macro name:- Key: html.profile.*
Value: *ANY - Key: html
Value: *ANY - Key: html.allowJavascript
Value: *ANY
- Key: html-bobswift.profile.*
Value: *ANY - Key: html-bobswift
Value: *ANY - Key: html-bobswift.allowJavascript
Value: *ANY
- Key: html.profile.*
Usage examples
HTML from a file in the Confluence home/script directory
{html:script=#example.html}
{html}
HTML from an attachment
{html:script=^example.html}
{html}
HTML put within {noformat} panel
{html:output=wiki|noPanel=true}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam fermentum vestibulum est. Cras rhoncus.
{html}
HTML from a URL
{html:script=#http://localhost/example.html}
{html}
Use of CSS inline style sheet
{html}
<P style="font-size: x-large; color: #8000">
Using inline style sheets - or is that inline styles?
</p>
{html}
Use of CSS external style sheet
{html}
<LINK href="http://www.cssgarden.com/css/T22/keylime_0001.css" rel="stylesheet" title="default" type="text/css"></LINK>
<H1>Absolute </H1>
{html}
Make sure that style sheet is available on a server and provide the absolute URL reference to this external style sheet resource.
Helpful resources
- How to use URLs in the HTML for Confluence macros
- Key concepts to understand how to link and render HTML content from other sources
