| Parameter | Default | Macro Browser Label | Description |
|---|
| output | html | Format | Determines how the output is treated. - html - standard HTML
- 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.
|
|---|
| script | macro body | Location of HTML data | If the 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 directory/script/filename. Subdirectories can be specified.
- #http... - Data is read from URL. May require the user and password parameters as well.
- 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.
- ^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.
|
|---|
| find |
| Find regex patterns | Comma separated list of regex patterns to use to post-process the output HTML with find and replace logic. Example: (href=)(/display) |
|---|
| replace |
| Replacement strings | Comma separated list corresponding to find patterns via index position in list. Single quote entries containing a comma. Example: $1$base_url$2 |
|---|
| encoding | system default | File encoding | Encoding for an external file if different from the system default handling. Example: UTF-8. |
|---|
| tidy | false | Select to use JTidy | JTidy ensures HTML is well formed which can prevent page display problems. |
|---|
| clean | true | Remove conflicting tags | Allows display in Confluence page without an iframe. Removes HTML, body and (optionally) the head tags including their corresponding ending tags so that it displays properly on a Confluence page.
If not selected, the HTML is surrounded with an iframe. |
|---|
| head | false | Include head section HTML | Only in affect if clean=true. The head tag is always removed. However, if set as true, it retains all the other tags from the head section and treats them as regular body content. This is useful for retaining style information in particular. |
|---|
| noPanel | false | Omit panel when output is wiki | A way of setting the nopanel parameter of the noformat macro. Only matters when output=wiki. |
|---|
| width | 500 | Width of iframe | Only in affect for clean=false. |
|---|
| height | 500 | Height of iframe | Only in affect for clean=false. |
|---|
| user |
| URL user | User name for URL access via basic authentication. |
|---|
| password |
| URL user password | User password for URL access via basic authentication. |
|---|
| timeout |
| Timeout in milliseconds | URL connections may timeout before getting data. Use this to increase time needed for slow connections. Be careful when using 0 as the connections would be in an infinite wait. |
|---|