Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Macro browser label

Default

Description

Macro parameter

Format

html

Specify how the output is treated. The options are as follows:

  • html - transformed output is standard HTML.

  • xhtml - transformed output is treated as XHTML and rendered with the Confluence XHTML renderer.

  • wiki - transformed output is treated as wiki markup and rendered with the Confluence wiki renderer.

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

Note
  • Contact your Confluence administrator for further information about the profiles available in your instance.

  • If a profile is specified, it is recommended to provide the relative path to the location of the HTML file to be rendered.

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).

  • #filename - Data is read from the file located in Confluence home/script/filename directory. Subdirectories can be specified.

  • global page template name - Data is read from a global page template. Special note: How to deal with templates on Confluence 4.3 and later.

  • space:page template name - Data is read from a space template.

  • #http://... - Data is read from the URL specified. May require user name and password as well. 

Info

If a Profile is specified, the pound sign (#) is optional, that is, the URL is processed regardless of the pound sign (#) before the URL.

  • ^attachment - Data is read from an attachment to the current page.

  • page^attachment - Data is read from an attachment to the page name provided.

  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.

Note

Precedence in URL handling

URLs are processed using a fixed precedence explained as follows:

  1. If the given URL is linked to a specific application like Bitbucket, GitLab, or GitLab, the macro does not require any user credentials, and processes and renders the given file. Refer to application links for information.

  2. If Profile is specified, the macro appends the URL given here with the URL specified in the profile configuration, and accesses the location to render the required file.

  3. Lastly, if no application links or profiles were given, the URLs are processed as-is and the required file is rendered.

script

Find regex patterns


Enter a comma-separated list of regex patterns to dynamically update the output content. Refer to this article for  Read 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.

Warning

Removal 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.

user

URL user password 


Enter the user password to be used for URL access to HTML files. 

Warning

Removal 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.

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

...