| Table of Contents | ||||||||
|---|---|---|---|---|---|---|---|---|
|
JVM requirements | Java 1.6 and above |
|---|---|
Installation requirements |
|
| Section |
|---|
| Column |
| Excerpt |
|---|
Collection of macros for rendering HTML and related markup inside a Confluence page. |
- HTML macro - Renders HTML markup code and scripts inside a Confluence page (described below)
- XSLT Macro
HTML Macro
Features
Supports security restrictions as described in CMSPRemoval notice:
Please note that the URL user and URL user password parameters were removed in 5.8.5 (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.
|
|---|
| Info |
|---|
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 theConfigurationpage). 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.
...
Other HTML macros
...
| Info | |||||
|---|---|---|---|---|---|
|
| Note |
|---|
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.
| Column | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||
Compatibility
Security
|
Documentation
- Help available in the notation guide.
Parameters
...
- html - Data is output as HTML (default).
- wiki - Data is surrounded by a {noformat} macro.
...
| Tip |
|---|
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 profiles configuration to know more about profiles and see 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).
|
...
|
...
|
...
| script | ||
Find regex patterns | Enter a comma-separated list of regex patterns to dynamically update the output content. Read more about regular expressions. Example: | 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: | replace | |
File encoding | system default | Specify the encoding for an external file, if different from the system default handling. Example: |
...
Usage
Example - HTML from a file in the script folder in the Confluence home directory
...
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 |
| Info |
|---|
About profiles:
|
Usage examples
HTML from a file in the Confluence home/script directory
| Code Block |
|---|
{html:script=#example.html}
{html}
|
...
HTML from an
...
attachment
| No Formatcode |
|---|
{html:script=^example.html}
{html}
|
...
HTML put within {noformat} panel
| No Formatcode |
|---|
{html:output=wiki|noPanel=true}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam fermentum vestibulum est. Cras rhoncus.
{html}
|
...
HTML from
...
a URL
| No Formatcode |
|---|
{html:script=#http://localhost/example.html}
{html}
|
...
Use of CSS inline style sheet
| No Formatcode |
|---|
{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
| No Formatcode |
|---|
{html}
<LINK href="http://www.cssgarden.com/css/T22/keylime_0001.css" rel="stylesheet" title="default" type="text/css"></LINK>
<H1>Absolute </H1>
{html}
|
Note: Make sure that style sheet is available on a server and provide the absolute URL reference to this external style sheet resource.
Open Issues
...
| Anchor | ||||
|---|---|---|---|---|
|
Key concepts to understand how to link and render HTML content from other sources