Versions Compared

Key

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

...

Warning
titleRemoval notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.

...

  • Supports capabilities for including data similar to other scripting macros.
  • Supports find and replace for adjusting resulting output.
  • Allows administrators to restrict the usage of Javascript in the HTML macro (based on Allow JavaScript in Configuration settings). The Confluence page throws a rendering error if this parameter is not enabled, and Javascript is inserted while using the macro.

...

Table plus


Macro Editor LabelDefaultDescriptionMacro Parameter
Formathtml

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

  • html - data is entered as standard HTML directly in the macro body
  • xhtml - data is treated as XHTML and rendered with the Confluence XHTML renderer prior to display
  • wiki - data is surrounded by a noformat macro. This is a very special case.
output
Profile

Enter the profile name to be transformed. Refer to this link to know more about profiles. Contact your Confluence administrator for further information about the profiles available in your instance.

profile name
Location of HTML datamacro body

Enter the location of data. If specified, the included data follows the body data (if any).

  • #http... - Data is read from URL. May require the user and password parameters as well.
  • ^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.
script
Find regex patterns

Enter a comma separated list of regex patterns to use to post-process the output HTML with find and replace logic. Example: (href=)(/display)

find
Replacement strings

Enter a comma separated list corresponding to find patterns via index position in list. If a comma is a part of an entry, use single quotes around it. Example: $1$base_url$2

replace
File encodingsystem defaultSpecify the encoding for an external file, if different from the system default handling. Example: UTF-8.encoding
Timeout in milliseconds
Enter time in milliseconds such that URL connections do not timeout before getting data. Use this to increase time needed for slow connections. Note that if a zero is given the connection may wait infinitely.timeout
User id for URL connection (Removed)

Enter the user name for URL access via basic authentication.

Warning
titleRemoval notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.


user
Password for URL connection (Removed)

Enter the password for URL access via basic authentication. 

Warning
titleRemoval notice

Please note that the URL user and URL user password parameters were removed (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data.


password
Height of rendered content500pxauto calculated

Enter the minimum height (in px or em) to be used for the rendered content.

If you do not specify, the height is auto-rendered according to the HTML content.
If you specify the height, the HTML content fits within the specified height. If the content exceeds the specified height, a scroll bar is displayed that allows you to scroll through the content.

Example: 500px or 1.5em

height


Examples

The following examples show how you can use the macro to render HTML content:

...