Notation Guide

Print Help Tips
External Content

Ways to include, summarise or refer to content from other servers.

Notation Comment
{jiraissues:url=http://jira.xml.url}

{jiraissues:url=http://jira.xml.url|
columns=type;key;summary}

{jiraissues:url=http://jira.xml.url|
count=true}

{jiraissues:url=http://jira.xml.url|
cache=off}

{jiraissues:url=http://jira.xml.url?
os_username=johnsmith&os_password=secret}

{jiraissues:url=http://jira.xml.url|
anonymous=true}
Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

The url should be copied from the XML link of Jira's Issue Navigator. Refer to the JIRA Issues Macro documentation for further details.

To specify a custom title (the text above the columns), you can specify the title parameter. By default this is JIRA Issues. A custom title can be specified by adding title=<My Custom Title> to the macros parameters.

You can control how wide the {jiraissues} macro renders by specifying a width parameter. To specify the width in percentage, use width=XX%. To specify the width in pixels, use width=XXpx. If unspecified, the width will be 100%.

Not specifying columns will lead into the default column list and order.

Allowed columns are: key, summary, type, created, updated, assignee, reporter, priority, status, resolution.

Specifying count=true will cause the macro to just print out how many issues were in the list, without printing the list.

Using cache=off will force the macro to refresh its internal cache of Jira issues.

Note: Certain filters may require a logged-in user in order to work. If a trust association has been established between Confluence and JIRA, user authentication details will be passed between the servers automatically. This functionality requires JIRA 3.12 or later. If a trust association is not available you can send the required login by appending:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your jira issues URL.

You can prevent the jiraissues macro from attempting to use a trusted application link by specifying anonymous=true. Issues will then be retrieved anonymously.

Example:

Atlassian JIRA (This file is an XML representation of some issues)
Key Summary Assignee Status Res Updated
TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

{jiraportlet:url=http://jira.portlet.url} Imports and displays JIRA 3 portlet into a Confluence page.

You can get the URL for the portlet by configuring the portlet into your JIRA dashboard. While in configuration mode, you can copy the portlet URL from the top of the portlet display.

Note: Certain filters may require a logged-in user in order to work. Hence you may need to append:
&os_username=yourJiraUsername&os_password=yourJiraPassword
to the end of your portlet url.

{plugins-supported}
{plugins-supported:profileKey=confluence}
{plugins-supported:profileKey=confluence|by=atlassian}

Lists supported plugins.

  • profileKey — The profile from which to get a list of plugins to display.
  • by — Lets you filter the list of plugins by the name of the person or organization that supports them.

{plugin-compatibility-matrix}
{plugin-compatibility-matrix:key=confluence.repository.client}>
{plugin-compatibility-matrix:key=confluence.repository.client|productStart=2.7|productEnd=2.9}

Shows a plugins compatibility with versions of a product.

  • key — The key of the plugin to show compatibility information of.
  • productStart — The starting product version to show compatibility with. For instance, you can specify a value like 2.8 and the compatibility matrix will show compatibility information of the concerned plugin with product version 2.8 and above.
  • productEnd — This is the same as productStart. The only difference is that this is used as the upper boundary of the product version range, instead of lower.
  • majorVersionsOnly — If set to true, the generated compatibility matrix will only show compatibility with major versions of the product. If this is true, the plugin will assume the concerned plugin to be compatible with a major version of a product only:
    • When a version of the plugin is explicitly marked compatibile with any minor version of the product, and...
    • The same version of the plugin is not marked incompatible with any minor version of the product.
    By default, this is true.
  • rows — The number of the latest X versions of the plugin to show compatibility of. By default, all versions of the plugin is shown.
  • showBrokenBuilds — Lets you to choose whether to display broken builds as . By default, this is false and broken build cells are blank.
{im:myscreenname|service=AIM}
{im:me@hotmail.com|service=MSN|showid=false}

Displays a graphic indication of whether an IM user is online. You must supply a valid user ID as the default argument and the desired service.

Parameters

  • (default) - The user id/screen name.
  • service - The name of the service to check. May be ''aim'', ''gtalk'', ''icq'', ''jabber'', ''msn'', ''sametime'', ''skype'', ''wildfire'' or ''yahoo''.
  • showid - (optional) If ''false'', the user''s id will not be shown.

{junitreport:directory=file:///c:/test-reports}
(currently only picks up result files in XML format. Set ant formatter to "xml")

{junitreport:url=file:///test-reports/TestRep.xml}
Displays the results of a series (or single) JUnit test.

Success Rate Tests Failures Time(s) Time(s)
93%
14 1 0 1.531

{html-include:url=http://www.host.com}

The {html-include} macro allows you to include the contents of an HTML file in a Confluence page.

CAUTION: Including unknown HTML inside a webpage is dangerous. Because HTML can contain active scripting components, it would be possible for a malicious attacker to present a user of your site with script that their web browser would believe came from you. Such code could be used, for example, to steal a users authentication cookie and give the attacker their Confluence login password.

You can specify anonymous=false to download the target content over a trusted connection (Trusted Application). For instance {html-include:url=http://example.com/path/to/target/location}. This parameter defaults to true.

{rss:url=http://host.com/rss.xml}

{rss:url=http://host.com/rss.xml|max=5}

{rss:url=http://host.com/rss.xml|showTitlesOnly=true}

Display the contents of a remote RSS feed within the page. Note: feeds are cached for 60 minutes before being retrieved again.

The 'max' parameter can be used to limit the number of entries displayed.

Example:

Sample RSS Feed (RSS 2.0)
(Feed description here...)
My Item ( Dec 30, 2003 06:53)
And part of the item content here...
Another Item ( Dec 30, 2003 06:53)
And part of the item content here...

You can specify 'showTitlesOnly=true' to show only the RSS feed titles. This parameter defaults to false.

You can specify 'titleBar=false' to hide the feeds titlebar. This parameter defaults to true.

You can specify anonymous=false to download the target content over a trusted connection (Trusted Application). For instance {rss:url=http://example.com/path/to/target/location}. This parameter defaults to true.

{excel:file=^Report.xls}


{excel:file=Year 2005^Report.xls|sheets=First Quarter, Second Quarter}


{excel:file=excel/Report.xls|sheets=1,2,4}

Displays one or more worksheets from Microsoft Excel spreadsheets (Excel 97, 2000, 2003 workbooks). Each worksheet is shown as a table. This macro supports common table capabilities with other table based macros (table-plus, csv, and sql).

  • file - A required parameter unless url is specified. It specifies the location of the Excel file.
    • ^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.
    • filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • encoding - File encoding for an external file if different from the system default handling. Example: *UTF-8*.
  • url - Only required if file is not specified. Specifies the URL of an Excel file. Use of this parameter may be restricted for security reasons. See your administrator for details.
  • sheets - By default, each sheet in the workbook will produce a table. Use the sheets parameter to control what sheets will be shown and ordering. The parameter value can be a comma separated list of sheet names (case sensitive) or sheet numbers (1-based counting)
  • columns - By default, all columns will be shown. Use the columns parameter to control the columns to show. Column ordering is not currently supported. The parameter value can be a comma separated list of column numbers (1-based counting). Hidden columns will show if listed in the columns parameter.
  • output - Determines how the output is formated:
    • html - Data is output as a HTML table (default).
    • wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.
  • heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.
  • border - The border width in pixels. Defaults to normal table border width.
  • width - The table width in pixels. Default is 100%.
  • showHidden - By default, hidden sheets, rows, and columns will not be shown. Set showHidden=true to show all data.
  • showSheetName - By default, the sheet name will not be shown. Set showSheetName=true to show a the sheet name before the table.
  • formatCell - By default, no special formating will be applied to the cells. Set formatCell=true to process each cell for special properties. Currently supported properties are:
    • html - Font and background color.
    • wiki - None at this time.
  • formatColumn - By default, the format for a column will be used to apply formating for all cells in the column. Set formatColumn=false to not use the column formating information from the excel sheet. Note that this parameter is ignored if formatCell=true or columnAttributes are specified.
  • showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table. This is used to help resolve formating issues.
  • escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table. Set escape=true to allow these special characters to be escaped so that it will not affect the formatting. The default is false so that data that has wiki markup will be handled correctly.
  • hyperlinks - Default is true. Set to false to disable inclusion of cell hyperlinks.
  • ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored. Set ignoreTrailingBlankRows=false to show these blank rows.
  • ignoreTrailingBlankColumns - By default, all trailing blank columns will be ignored. Set ignoreTrailingBlankColumns=false to show these blank columns.
  • language - If provided, the language and country specification will be used to provide number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.
  • country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.
  • disableAntiXss - Default is false. Set to true to stop encoding of html special characters found in table content. For security reasons, use of this parameter is restricted to authorized users. See your administrator for details.