Page Comparison

Table of Contents

maxlevel	2
minlevel	2
type	flat
separator	pipe

Warning

title	Confluence 4.x

You must disable the html-migration macro provided in the Atlassian bundled Confluence Html Macros plugin under System Plugins in order to avoid Unknown Macro errors when inserting wiki markup with the html macro. Or surround with the wiki macro or any other non-migrated (compatibility mode) macro. Unfortunately, Atlassian ships the html-migration macro as enabled even though their html macro is disabled. This causes any html macro to be migrated without a supporting macro . See CONF-25656.

Users upgrading to Confluence 4.x should use HTML 4.0.0 to avoid issues caused by the problem above. Prior to 4.0.0, the html macro works in compatibility mode - see Confluence 4.0 compatibility for Table and other plugins

Section

Column

HTML Macro

Features

Supports security restrictions as described in CMSP.
Supports capabilities for including data similar to other scripting macros.
Find and replace support for adjusting resulting output.

Other HTML macros

{html} and {html-include} macros shipped with Confluence. See the Confluence User Guide: http://confluence.atlassian.com/display/DOC:HTML Macro and http://confluence.atlassian.com/display/DOC:HTML Include Macro. These macros are disabled by default in Confluence, since it is a security exposure unless you only have trusted users on your site. The Confluence HTML macro must be disabled for the new html macro to be used.
HTML Tag - a safer alternative to the standard {html} macro but does not allow for arbitrary html to be included.

Parameters

Table plus

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

...

script
macro. This is a very special case need.

...

	macro body	Location of HTML data

...

If a location of data is specified, the included data will follow the body data (if any).

#filename - Data is read from the file located in confluence home directory/script/filename. 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.
^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.

...

clean

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.
jtidy	false	Select to use JTidy	JTidy will ensure the HTML is well formed which can prevent page display problems.

...

head
	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. When not selected, the HTML is surrounded with an iframe.

...

	false	Include head section HTML	Only in affect if clean=true. The head tag is always removed. However, setting this to true will retain all the other tags from the head section and treat 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 using 0 for an infinite wait.

Usage

Example - HTML from a file in the script folder in the Confluence home directory

...

Versions Compared

Old Version 23

New Version 24

Key