News
Blog stream
Create a blog post to share news and announcements with your team and company.
Source repository
Source for release 3.2.0 is hosted in a BitBucket repository: Confluence HTML Plugin. SVN will not be updated.
Additions and corrections to above
JVM requirements |
Java 1.5 and above |
---|---|
Installation requirements |
Universal Plugin Manager |
Description
Collection of macros for rendering HTML and related markup inside a Confluence page.
- HTML macro - Renders HTML markup code and scripts inside a Confluence page (described below)
- XSLT Macro
HTML Macro
Features
- Supports security restrictions as described in Macro Security for Confluence.
- Supports capabilities for including data similar to other scripting macros.
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.
Other information
Compatibility
Plugin \ Confluence, 2.x, 3.0, 3.1, 3.2, 3.3, 3.4, 3.5, 4.0, Tested releases [!GINT:Home^gint-tested-small.png!]
3.2.0, , , , , , , , , "3.1.1, 3.4.0, 3.5.13, 4.0.0",
3.1.0, , , , , , , , , "2.7.1, 2.9.2, 3.1.1, 3.4.0, 3.5.0, 4.0.0",
...
Security
Macro Security Plugin
If you have untrusted users on your site, then you should setup Macro Security for Confluence before enabling the html plugin.
Documentation
- Help available in the notation guide.
Parameters
- output - Determines how the output is formated:
- html - Data is output as HTML (default).
- wiki - Data is surrounded by a {noformat} macro.
- script - Location of HTML data. Default is the macro body only. If a location of data is specified, the included data will follow the body data.
- #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
- #http://... - Data is read from the URL specified.
- ^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.
- noPanel - When output=wiki, show the data within a panel (default) unless nopanel=true
- encoding - File encoding for an external file if different from the system default handling. Example: UTF-8.
- clean - Default is true. Some HTML tags (like body and html) are removed to help with formatting in Confluence. Set to false to surround the complete html with an iframe.
- width - Default is 500. Sets the width for the iframe (when clean=true).
- height - Default is 500. Sets the height for the iframe (when clean=true).
Usage
Example - HTML from a file in the script folder in the Confluence home directory
{html:script=#example.html} {html}
Example - HTML from an attachement
{html:script=^example.html} {html}
Example - HTML put within {noformat} panel
{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
{html:script=#http://localhost/example.html} {html}
Example - use of CSS inline style sheet
{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
{html} <LINK href="http://www.cssgarden.com/css/T22/keylime_0001.css" rel="stylesheet" title="default" type="text/css"></LINK> <H1>Absolute </H1> {html}
Note: Make sure that style sheet is available on a server and provide absolute URL reference to this external style sheet resource.
Version History
- Previous versions were included in Scripting and External Content Macros