Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 3.2.0
Wiki Markup
{toc:type=flat|separator=pipe|maxlevel=2|minlevel=2}

h3. News
{section} {column}
{blog-posts:15|content=titles|time=30d|spaces=HTML,CMSP,TBL}
\\
{column} {column}

{info:title=Source repository}
Source for release 3.2.0 is hosted in a [BitBucket|https://bitbucket.org/] repository: [Confluence HTML Plugin|https://bitbucket.org/bob_swift/confluence-html-plugin]. SVN will not be updated.
{info}

{column} {section} 

{repository-plugin:key=org.swift.confluence.html}

h3. Additions and corrections to above

|| JVM requirements | Java 1.45 and above ||
|| Installation requirements | (/) ConfluenceUniversal Repository\\ (/) Upload from administration console. Plugin Manager \\ (x) Cannot be installed in /WEB-INF/lib ||

{section} {column} 

h2. Description
{excerpt} Collection of macros for rendering HTML and related markup inside a Confluence page. {excerpt}
* HTML macro - Renders HTML markup code and scripts inside a Confluence page (described below)
* [XSLT Macro]

h2. HTML Macro


h3. Features

* Supports security restrictions as described in [CMSP:].
* Supports capabilities for including data similar to other scripting macros.
{warning:title=Security}
If you have untrusted users on your site, then you should setup [CMSP:] before enabling the html macro.
{warning}

h3. 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.

{column} {column:width=50%}

{tip:title=Other information}
- [Atlassian Plugin Exchange - Confluence HTML Plugin|https://plugins.atlassian.com/plugin/details/252]

   [!GINT:Home^gint-tested.png!|GINT:]
{tip}

h2. Compatibility
{csv:output=wiki}
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!|GINT:]
3.2.0,               (x), (x), (/), (/), (/), (/), (/), (/), "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",
...
{csv}

h3. Security
{tip:title=Macro Security Plugin}
If you have untrusted users on your site, then you should setup [CMSP:] before enabling the html plugin.
{tip}

{column} {section} 

h2. Documentation

* Help available in the notation guide.

h3. 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
{note:title=Direct file access}
The script macros access the script directory in Confluence home for file access.
{note}
* *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).

h2. Usage


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

{noformat}
{html:script=#example.html}
{html}
{noformat}

h3. Example - HTML from an attachement

{noformat}
{html:script=^example.html}
{html}
{noformat}

h3. Example - HTML put within \{noformat\} panel

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

h3. Example - HTML from an URL

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

h3. Example - use of CSS *{_}inline{_}* style sheet

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

h3. Example - use of CSS *{_}external{_}* style sheet

{noformat}
{html}
<LINK href="http://www.cssgarden.com/css/T22/keylime_0001.css"  rel="stylesheet" title="default" type="text/css"></LINK>
<H1>Absolute </H1>
{html}
{noformat}
{{Note: Make sure that style sheet is available on a server and provide *absolute URL reference* to this external style sheet resource.}}

h3. Version History

|| Version || Date || Author || Notes ||
| 3.1.0 | 22-Jun-2007 | [~bswift] | [release notes|http://studio.plugins.atlassian.com/secure/IssueNavigator.jspa?&pid=10147&fixfor=10410&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&hide=true] |{repository-plugin:version-grid|key=org.swift.confluence.html|suppressHeader=true} 
* Previous versions were included in Scripting and External Content Macros

h3. Release Notes

*h4. Release 3.12.0
*When:* 22-Jun-2007
*Who:* [~bswift]
*What:*
{jiraissues:httphttps://studio.plugins.atlassian.com/securesr/IssueNavigator.jspa?view=rss&&pid=10150&fixfor=10587&sorter/field=issuekey&sorter/order=DESC&tempMax=25&reset=true&decorator=nonejira.issueviews:searchrequest-xml/temp/SearchRequest.xml?jqlQuery=project+%3D+HTML+AND+fixVersion+%3D+15321+AND+status+in+%28Reopened%2C+Resolved%2C+Closed%29+ORDER+BY+priority+DESC&tempMax=1000|columns=type,key,summary,reporter,assignee,priority,status}

h2. Open Issues

{jiraissues:http://studio.plugins.atlassian.com/secure/IssueNavigator.jspa?view=rss&&pid=10150&summary=true&description=true&body=true&status=1&status=3&status=4&sorter/field=issuekey&sorter/order=ASC&tempMax=25&reset=true&decorator=none|columns=type,key,summary,reporter,assignee,priority,status}