| Table of Contents |
|---|
| maxlevel | 2 |
|---|
| minlevel | 2 |
|---|
| type | flat |
|---|
| separator | pipe |
|---|
|
| Warning |
|---|
|
Please note that the User id for URL connection and Password for URL connection parameters are deprecated and will be removed on March 31, 2022. We recommend using profiles to access your data from remote locations. |
Features
- 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.
Parameters
| Table plus |
|---|
| Macro Editor Label | Default | Description | Macro Parameter |
|---|
| Format | html | 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 data | macro 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 encoding | system default | Specify 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 (Deprecated) |
| Enter the user name for URL access via basic authentication. | user | | Password for URL |
connection| connection (Deprecated) |
| Enter the password for URL access via basic authentication. | password | | Height of rendered content | 100px | Enter the minimum height (in px or em) to be used for the rendered content. Example: 500px or 1.5em | height |
|
Examples
The following examples show how you can use the macro to render HTML content:
...