Versions Compared

Old Version 25

changes.mady.by.user Bob Swift

Saved on

compared with

New Version 26

changes.mady.by.user Bob Swift

Saved on

Key

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

Table of Contents
maxlevel2
minlevel2
typeflat
separatorpipe

 

Section
HTML Macro
Column

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

Tip

By default, header content is excluded as it could interfere with Confluence page html. Use head=true to include anyway provided it does not mess up the content.

Parameters

Table plus
ParameterDefaultMacro Browser LabelDescription
outputhtmlFormat

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 need.
scriptmacro bodyLocation 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.
  • #http... - Data is read from url. May required 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
encodingsystem defaultFile encodingEncoding for an external file if different from the system default handling. Example: UTF-8.
jtidyfalseSelect to use JTidyJTidy will ensure the HTML is well formed which can prevent page display problems.
cleantrueRemove conflicting tagsAllows 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.
headfalseInclude head section HTMLOnly 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.
noPanelfalseOmit panel when output is wiki A way of setting the nopanel parameter of the noformat macro. Only matters when output=wiki.
width500Width of iframeOnly in affect for clean=false
height500Height of iframeOnly 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 millisecondsURL 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

No Format
{html:script=#example.html}
{html}

Example - HTML from an attachement

No Format
{html:script=^example.html}
{html}

Example - HTML put within {noformat} panel

No Format
{html:output=wiki|noPanel=true}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam fermentum vestibulum est. Cras rhoncus.
{html}

Example - HTML from an URL

No Format
{html:script=#http://localhost/example.html}
{html}

Example - use of CSS inline style sheet

No Format
{html}
<P style="font-size: x-large; color: #8000">
   Using inline style sheets - or is that inline styles?
</p>
{html}

Example - use of CSS external style sheet

No Format
{html}
<LINK href="http://www.cssgarden.com/css/T22/keylime_0001.css"  rel="stylesheet" title="default" type="text/css"></LINK>
<H1>Absolute </H1>
{html}

...