List of All Confluence build-in macros
On this page listed all Macros whith User Parameters that installed on the Confluence Cloud by default.
Grouped by plugins.
Plugin: com.atlassian.confluence.plugins.content-formatting-macros
Align (align)
Choose the alignment of the selected contents.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-align
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Alignment (align) | Select the alignment | ENUM | Null | showValueInPlaceholder: true showNameInPlaceholder: true | REQUIRED |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Background Color (bgcolor)
Give the selected contents a background color.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-bgcolor
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | ||
Color (color) | Enter a color | STRING | green | showValueInPlaceholder: true showNameInPlaceholder: false | REQUIRED |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Center (center)
Centers a block of content or text on the page or within a panel.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-center
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Clickable (clickable)
This macro is deprecated. Please use native Confluence links instead.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-clickable
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Link (link) | The link can be a page title (including space key if desired) or a URL. | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: true | REQUIRED |
Colgroup Macro (colgroup)
Inserts a colgroup to a table.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-colgroup
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content. | STRING | Null | |
Span (span) | Indicates the number of columns this colgroup should span | INT | Null | |
Width (width) | Specifies the width of the table cell | STRING | Null |
Copyright (copyright)
Add a copyright symbol.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-copyright
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Div (div)
Wrap selected contents with a div.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-div
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null | |
Styles (style) | Enter CSS styles | STRING | Null | |
Title (title) | Enter a title | STRING | Null | |
Text Direction (dir) | Choose a text direction | ENUM | Null | |
Alignment (align) | Choose text alignment | ENUM | Null | |
Language Code (lang) | Enter a language code | STRING | Null |
Fancy Bullets (fancy-bullets)
Style the bullets of any list in the macro body.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-fancy-bullets
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | ||
Bullet Type (type) | Choose from a range of bullet types | ENUM | Null | showValueInPlaceholder: true showNameInPlaceholder: false | |
Image (image) | A custom image to be used as a bullet | URL | Null | showValueInPlaceholder: true showNameInPlaceholder: false | |
Padding (padding) | Padding to apply to the list | STRING | Null |
Highlight (highlight)
Highlight the selected contents with a color.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-highlight
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | ||
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null | ||
Color (color) | Enter a color | STRING | yellow | showValueInPlaceholder: true showNameInPlaceholder: false | REQUIRED |
HTML Comment (htmlcomment)
Wraps content in an HTML comment
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-htmlcomment
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Hidden (hidden) | Suppress the comment from being rendered | BOOLEAN | false | showValueInPlaceholder: false showNameInPlaceholder: true |
Iframe (iframe)
Add an iframe to your page.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-iframe
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
URL (src) | URL source of the iframe | URL | Null | showValueInPlaceholder: true showNameInPlaceholder: false | REQUIRED |
ID (id) | Enter an ID | STRING | Null | ||
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null | ||
Styles (style) | Enter CSS styles | STRING | Null | ||
Title (title) | Enter a title | STRING | Null | ||
Width (width) | Choose a width for your iframe. Defaults to '300px', use '100%' for responsive width. | STRING | Null | ||
Height (height) | Choose a height for your iframe | STRING | Null | ||
Align (align) | Choose an alignment for your iframe | ENUM | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.iframe.param.frameborder.label (frameborder) | ENUM | Null | |||
Long Description (longdesc) | Enter a long description | STRING | Null | ||
Margin Height (marginheight) | Enter a margin height | STRING | Null | ||
Margin Width (marginwidth) | Enter a margin width | STRING | Null | ||
Name (name) | Enter a name attribute | STRING | Null | ||
Scrolling (scrolling) | Choose if scrolling should be enabled | ENUM | Null | ||
Text Direction (dir) | Choose a text direction | ENUM | Null | ||
Language Code (lang) | Enter a language code | STRING | Null | ||
Allow Fullscreen (allowfullscreen) | Allow embedded content to use fullscreen | BOOLEAN | false |
com.atlassian.confluence.plugins.content-formatting-macros.img.label (img)
com.atlassian.confluence.plugins.content-formatting-macros.img.desc
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-img
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
com.atlassian.confluence.plugins.content-formatting-macros.img.param.dir.label (dir) | ENUM | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.align.label (align) | ENUM | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.lang.label (lang) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.height.label (height) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.width.label (width) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.border.label (border) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.src.label (src) | URL | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.alt.label (alt) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.longdesc.label (longdesc) | URL | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.ismap.label (ismap) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.img.param.usemap.label (usemap) | STRING | Null |
List Item (li)
Add a list item.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-li
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content. | STRING | Null | |
Styles (style) | Enter CSS styles | STRING | Null | |
Title (title) | Enter a title | STRING | Null | |
Text Direction (dir) | Choose a text direction | ENUM | Null | |
Language Code (lang) | Enter a language code | STRING | Null |
Lozenge (lozenge)
This macro is deprecated. Please use the Confluence panel macro instead.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-lozenge
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Link (link) | Insert the title of a Confluence page or an external url. | CONFLUENCE-CONTENT | Null | |
Title (title) | The title of the lozenge, also used as the tooltip for links | STRING | Null | |
Color (color) | The color of the left panel: silver (default), bronze, gold, blue, cyan, green, purple, pink, red | ENUM | silver | |
Arrow (arrow) | Display or hide the arrow in the left panel: none (default if no link), blue (default if link specified), green | ENUM | Null | |
Width (width) | The width of the entire lozenge specified as pixels (347px default), percentage (eg. 70%) or auto to stretch to fit | STRING | Null |
Ordered List (ol)
Create an ordered list.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-ol
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content. | STRING | Null | |
Styles (style) | Enter CSS styles | STRING | Null | |
Title (title) | Enter a title | STRING | Null | |
Text Direction (dir) | Choose a text direction | ENUM | Null | |
Language Code (lang) | Enter a language code | STRING | Null |
com.atlassian.confluence.plugins.content-formatting-macros.p.label (p)
com.atlassian.confluence.plugins.content-formatting-macros.p.desc
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-p
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
com.atlassian.confluence.plugins.content-formatting-macros.p.param.id.label (id) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.p.param.class.label (class) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.p.param.style.label (style) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.p.param.title.label (title) | STRING | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.p.param.dir.label (dir) | ENUM | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.p.param.align.label (align) | ENUM | Null | ||
com.atlassian.confluence.plugins.content-formatting-macros.p.param.lang.label (lang) | STRING | Null |
Pre (pre)
Wrap selected contents with a pre tag.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-pre
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | A unique id for the element | STRING | Null | |
Class (class) | The class of the element | STRING | Null | |
Title (title) | Text to display in a tool tip | STRING | Null | |
Styles (style) | Enter inline CSS styles | STRING | Null | |
Text Direction (dir) | An inline style definition | ENUM | ltr | |
Language Code (lang) | Sets the language code | STRING | Null | |
Width (width) | Specifies the width of the pre tag | STRING | Null |
Privacy Mark (privacy-mark)
Add a privacy mark symbol.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-privacy-mark
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | ||
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null | ||
Tooltip (tooltip) | Text to be shown on hover | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false |
Privacy Policy (privacy-policy)
Add a link to your configured Privacy Policy.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-privacy-policy
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | ||
Page (page) | Choose a page | CONFLUENCE-CONTENT | Privacy Policy | showValueInPlaceholder: true showNameInPlaceholder: false | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Registered Trademark (reg-tm)
Add a registered trademark symbol.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-reg-tm
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Round Rectangle (roundrect)
This macro is deprecated. Please use the Confluence panel macro instead.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-roundrect
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Title (title) | Displays wiki content in the space above the main content area between the upper corners | STRING | Null | |
Footer (footer) | Displays wiki content in the space below the main content area between the lower corners | STRING | Null | |
Background Color (bgcolor) | The background color of the content area | STRING | Null | |
Width (width) | Enter a width for the rectangle | STRING | Null | |
Height (height) | Enter a height for the rectangle | STRING | Null | |
Corner Size (cornersize) | Defines the radius of the rounded corners | STRING | Null | |
Horizontal Size (hSize) | Overrides Corner size to allow setting the width of the corners | STRING | Null | |
Vertical Size (vSize) | Overrides cornersize to allow setting of the height of the corners | STRING | Null | |
com.atlassian.confluence.plugins.content-formatting-macros.roundrect.param.titlebgcolor.label (titlebgcolor) | The background color of the title area (defaults to background color) | STRING | Null | |
Footer Background Color (footerbgcolor) | The background color of the footer area (defaults to background color) | STRING | Null | |
Corners (corners) | Choose which corners to show | STRING | Null | |
Rows (rows) | A comma separated list of flags stating which rows should be displayed: Top, Middle, Bottom (default is true,true,true) | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional) | STRING | Null |
Service Mark (sm)
Add a service mark symbol.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-sm
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Span (span)
Wrap selected contents with a span.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-span
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null | |
Styles (style) | Enter CSS styles | STRING | Null | |
Title (title) | Enter a title | STRING | Null | |
Text Direction (dir) | Choose a text direction | ENUM | Null | |
Language Code (lang) | Enter a language code | STRING | Null |
Strike (strike)
Add a strikethrough to selected contents.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-strike
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null |
Style (style)
Add CSS stylesheets to your page.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-style
Body Type — PLAIN_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Media (media) | Choose a media type for your styles | STRING | Null | |
Import (import) | Enter an import URL | STRING | Null |
HTML Table (table)
This macro is deprecated. Please use native Confluence tables instead, by copying and pasting the rendered table from the view page directly into the Confluence editor.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-table
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Align (align) | Aligns the table | ENUM | Null | |
Background Color (bgcolor) | Specifies the background color of the table | STRING | Null | |
Border Width (border) | Specifies the border width | STRING | Null | |
Cell Padding (cellpadding) | Specifies the space between the cell walls and contents | STRING | Null | |
ID (id) | A unique id for the element | STRING | Null | |
CSS Class (class) | The class of the element | STRING | Null | |
Inline Style (style) | An inline style definition | STRING | Null |
Table Body (tbody) (tbody)
Creates an HTML table body (tbody) tag
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-tbody
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Align (align) | Specifies the horizontal alignment of cell content | ENUM | Null | |
Alignment Character (char) | Specifies which character to align text on | STRING | Null | |
Alignment Character Offset (charoff) | Specifies the alignment offset to the first character to align on | STRING | Null | |
Vertical Align (valign) | Specifies the vertical alignment of cell content | ENUM | Null | |
ID (id) | A unique id for the element | STRING | Null | |
CSS Class (class) | The class of the element | STRING | Null | |
Inline Style (style) | An inline style definition | STRING | Null | |
Title (title) | Text to display in a tool tip | STRING | Null |
Table Cell (td) (td)
This macro is deprecated. Please use native Confluence tables instead, by copying and pasting the rendered table from the view page directly into the Confluence editor.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-td
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Align (align) | Specifies the horizontal alignment of cell content | ENUM | Null | |
Background Color (bgcolor) | Specifies the background color of the table cell | COLOR | Null | |
Column span (colspan) | Indicates the number of columns this cell should span | STRING | Null | |
Height (height) | Specifies the height of the table cell | STRING | Null | |
Row Span (rowspan) | Indicates the number of rows this cell should span | INT | Null | |
Scope (scope) | Specifies if this cell provides header information for the rest of the row that contains it (row), or for the rest of the column (col), or for the rest of the row group that contains it (rowgroup), or for the rest of the column group that contains it | STRING | Null | |
Width (width) | Specifies the width of the table cell | STRING | Null | |
ID (id) | A unique id for the element | STRING | Null | |
CSS Class (class) | The class of the element | STRING | Null | |
Inline Style (style) | An inline style definition | STRING | Null |
Table Head (th) (th)
Creates an HTML table heading (th) tag
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-th
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Abbreviation (abbr) | Specifies an abbreviated version of the content in a cell | STRING | Null | |
Align (align) | Specifies the horizontal alignment of cell content | ENUM | Null | |
Axis (axis) | Defines a name for a cell | STRING | Null | |
Background Color (bgcolor) | Specifies the background color of the table cell | COLOR | Null | |
Alignment Character (char) | Specifies which character to align text on | STRING | Null | |
Alignment Character Offset (charoff) | Specifies the alignment offset to the first character to align on | STRING | Null | |
Column Span (colspan) | Indicates the number of columns this cell should span | STRING | Null | |
Headers (headers) | A space-separated list of cell IDs that supply header information for the cell. This attribute allows text-only browsers to render the header information for a given cell | STRING | Null | |
Height (height) | Specifies the height of the table cell | STRING | Null | |
No Wrap (nowrap) | Whether to disable or enable automatic text wrapping in this cell | BOOLEAN | false | |
Row Span (rowspan) | Indicates the number of rows this cell should span | INT | Null | |
Scope (scope) | Specifies if this cell provides header information for the rest of the row that contains it (row), or for the rest of the column (col), or for the rest of the row group that contains it (rowgroup), or for the rest of the column group that contains it | STRING | Null | |
Vertical Align (valign) | Specifies the vertical alignment of cell content | ENUM | Null | |
Width (width) | Specifies the width of the table cell | STRING | Null | |
ID (id) | A unique id for the element | STRING | Null | |
CSS Class (class) | The class of the element | STRING | Null | |
Inline Style (style) | An inline style definition | STRING | Null | |
Title (title) | Text to display in a tool tip | STRING | Null |
Table Head (thead) (thead)
Creates an HTML table heading (thead) tag
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-thead
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Align (align) | Specifies the horizontal alignment of cell content | ENUM | Null | |
Alignment Character (char) | Specifies which character to align text on | STRING | Null | |
Alignment Character Offset (charoff) | Specifies the alignment offset to the first character to align on | STRING | Null | |
Vertical Align (valign) | Specifies the vertical alignment of cell content | ENUM | Null | |
ID (id) | A unique id for the element | STRING | Null | |
CSS Class (class) | The class of the element | STRING | Null | |
Inline Style (style) | An inline style definition | STRING | Null | |
Title (title) | Text to display in a tool tip | STRING | Null |
Trademark (tm)
Add a trademark symbol.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-tm
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content (optional). | STRING | Null |
Table Row (tr) (tr)
This macro is deprecated. Please use native Confluence tables instead, by copying and pasting the rendered table from the view page directly into the Confluence editor.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-tr
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Background Color (bgcolor) | Specifies the background color of the table row | STRING | Null | |
ID (id) | A unique id for the element | STRING | Null | |
CSS Class (class) | The class attribute of the element | STRING | Null | |
Inline Style (style) | An inline style definition | STRING | Null |
Unordered List (ul)
Create an unordered list.
com.atlassian.confluence.plugins.content-formatting-macros:xhtml-ul
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
ID (id) | Enter an ID | STRING | Null | |
Class (class) | Enter a CSS class to apply to the content. | STRING | Null | |
Styles (style) | Enter CSS styles | STRING | Null | |
Title (title) | Enter a title | STRING | Null | |
Text Direction (dir) | Choose a text direction | ENUM | Null | |
Language Code (lang) | Enter a language code | STRING | Null |
Plugin: confluence.macros.basic
Anchor (anchor)
Creates an anchor inside the page, which can be hyperlinked.
confluence.macros.basic:anchor-xhtml
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Anchor Name () | confluence.macros.basic.anchor.param..desc | STRING | Null | REQUIRED |
Cheese (cheese)
Inserts the text 'I like cheese!', used for testing macro functionality.
N/A
Body Type — NONE
Output Type — BLOCK
confluence.macros.basic.deck.label (deck)
Draw a panel with an optional title and border
confluence.macros.basic:deck-xhtml
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
confluence.macros.basic.deck.param.title.label (title) | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false | ||
confluence.macros.basic.deck.param.borderStyle.label (borderStyle) | STRING | Null | |||
confluence.macros.basic.deck.param.borderColor.label (borderColor) | COLOR | Null | |||
confluence.macros.basic.deck.param.borderWidth.label (borderWidth) | STRING | Null | |||
confluence.macros.basic.deck.param.bgColor.label (bgColor) | COLOR | Null | |||
confluence.macros.basic.deck.param.titleBGColor.label (titleBGColor) | COLOR | Null | |||
confluence.macros.basic.deck.param.titleColor.label (titleColor) | COLOR | Null |
Loremipsum (loremipsum)
Insert paragraphs of "lorem ipsum" space-filler text
confluence.macros.basic:loremipsum-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Number of Paragraphs () | confluence.macros.basic.loremipsum.param..desc | INT | 3 |
No Format (noformat)
Create blocks of text where other wiki formatting is not applied
confluence.macros.basic:noformat-xhtml
Body Type — PLAIN_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
No Panel (nopanel) | If selected, the content is displayed without the panel. | BOOLEAN | false |
Panel (panel)
Draw a panel with an optional title and border
confluence.macros.basic:panel-xhtml
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Panel Title (title) | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false | ||
Border Style (borderStyle) | Examples: | STRING | Null | ||
Border Colour (borderColor) | COLOR | Null | |||
Border Pixel Width (Value Only) (borderWidth) | STRING | Null | |||
Background Colour (bgColor) | COLOR | Null | |||
Title Background Colour (titleBGColor) | COLOR | Null | |||
Title Text Colour (titleColor) | COLOR | Null |
Plugin: confluence.extra.attachments
Attachments (attachments)
Creates a list of attachments belonging to this page.
confluence.extra.attachments:attachments-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Filename patterns (patterns) | A comma-separated list of filename regular expression patterns. Example: | STRING | Null | ||
Attachment labels (labels) | A comma-separated list of labels to filter by. | STRING | Null | ||
Include old attachment versions (old) | BOOLEAN | true | |||
Show previews (preview) | BOOLEAN | false | |||
Sort by (sortBy) | ENUM | date | |||
Sort order (sortOrder) | ENUM | ascending | |||
Allow upload (upload) | BOOLEAN | true | |||
Page title (page) | If not specified, the current page is used. | CONFLUENCE-CONTENT | Null | type: page | |
Number of items to display (pageSize) | Number of items to display on each page of results in the table. | STRING | Null |
Space Attachments (space-attachments)
Displays a list of attachments in a space.
confluence.extra.attachments:space-attachments-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Space (space) | SPACEKEY | Null | ||
Show filter controls (showFilter) | BOOLEAN | true |
Plugin: confluence.macros.advanced
Blog Posts (blog-posts)
Displays the most recent blog posts in this space.
confluence.macros.advanced:xhtml-blog-posts
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Content Type to Display (content) | ENUM | entire | REQUIRED | |
Time Frame (time) | Specify how far back to display blog posts. Example: | RELATIVEDATE | Null | |
Restrict to these Labels (labels) | Separate each label with a comma or single space. | STRING | Null | |
Restrict to these Authors (author) | Separate each author with a comma. | USERNAME | Null | MULTIPLE |
Restrict to these Spaces (spaces) | These are case-sensitive. Separate each item with a comma or single space. Example: | SPACEKEY | Null | |
Maximum Number of Blog Posts (max) | INT | 100 | ||
Sort By (sort) | ENUM | Null | ||
Reverse Sort (reverse) | Used only in conjunction with the 'Sort By' parameter. | BOOLEAN | false |
Change History (change-history)
Shows the history of version comments for the current page or blog posts.
confluence.macros.advanced:change-history
Body Type — NONE
Output Type — BLOCK
Child pages (Children Display) (children)
Display a custom list of content nested under a page.
confluence.macros.advanced:xhtml-children
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Show Descendants (all) | BOOLEAN | false | |||
Parent Page (page) | If not specified, the current page is used. | CONFLUENCE-CONTENT | Null | type: page | |
Number of Children (first) | If not specified, no limit is applied. | INT | Null | ||
Depth of Descendants (depth) | INT | Null | |||
Heading Style (style) | ENUM | Null | |||
Excerpt Display (excerptType) | How to display excerpts for each page. | ENUM | none | ||
Sort Children By (sort) | ENUM | Null | |||
Reverse Sort (reverse) | Used only in conjunction with the 'Sort Children By' parameter. | BOOLEAN | false |
Content by User (content-by-user)
Lists all the content created by a particular user.
confluence.macros.advanced:content-by-user
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Author by username (author) | USERNAME | Null | REQUIRED | |
Space(s) (spaces) | These are case-sensitive. Separate each item with a comma or single space. Example: | SPACEKEY | @all | MULTIPLE |
Maximum Number of Results (max) | INT | 15 |
Filter by label (Content by label) (contentbylabel)
Display a custom list of content filtered by label.
confluence.macros.advanced:contentbylabel
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
confluence.macros.advanced.contentbylabel.param.cql.label (cql) | CQL | Null | defaultFields: label requiredFields: label | REQUIRED | |
Sort By (sort) | ENUM | Null | |||
Reverse Sort (reverse) | Used only in conjunction with the 'Sort By' parameter. | BOOLEAN | false | ||
Maximum Number of Pages (max) | INT | 15 | |||
List Title (title) | STRING | Null | |||
Show Labels for Each Page (showLabels) | BOOLEAN | true | |||
Show Space Name for Each Page (showSpace) | BOOLEAN | true | |||
Excerpt Display (excerptType) | How to display excerpts for each page. | ENUM | none |
Decision report (decisionreport)
Create a report of pages and the decisions they contain
confluence.macros.advanced:decisionreport
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
confluence.macros.advanced.decisionreport.param.cql.label (cql) | CQL | space=currentSpace() | defaultFields: space requiredFields: space | REQUIRED | |
Sort by (sort) | ENUM | Null | |||
Columns to display (columns) | Allowed columns are Page created, Page modified | ENUM | Null | MULTIPLE | |
Reverse sort (reverse) | Used only in conjunction with the 'Sort by' parameter. | BOOLEAN | false | ||
Maximum number of decisions (max) | INT | 20 | REQUIRED |
Excerpt (excerpt)
Marks a page section for reuse in other pages.
confluence.macros.advanced:xhtml-excerpt
Body Type — RICH_TEXT
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Excerpt name (name) | Give this excerpt a unique name for easy reference. | STRING | Null | |
Hide excerpt on this page (hidden) | BOOLEAN | false |
Insert excerpt (excerpt-include)
Display an excerpt from another page.
confluence.macros.advanced:xhtml-excerpt-include
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Source page () | confluence.macros.advanced.excerpt-include.param..desc | CONFLUENCE-CONTENT | Null | includeDatePath: true | REQUIRED |
Excerpt name (name) | STRING | Null | |||
Remove title and frame (nopanel) | BOOLEAN | false |
Favourite Pages (favpages)
Lists your favourite pages.
confluence.macros.advanced:favpages
Body Type — NONE
Output Type — BLOCK
Gallery (gallery)
Creates a thumbnail gallery from a page's attachments.
confluence.macros.advanced:xhtml-gallery
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Gallery Title (title) | STRING | Null | ||
Number of Columns (columns) | INT | 4 | ||
Images to Exclude (exclude) | Separate each image by a comma. Example: | STRING | Null | |
Include these Images Only (include) | Separate each image by a comma. Example: | STRING | Null | |
Exclude Images with these Labels (excludeLabel) | Separate each label by a comma. Example: | STRING | Null | |
Include Images with these Labels Only (includeLabel) | Separate each label by a comma. Example: | STRING | Null | |
Use Images in these Pages (page) | Separate each page title by a comma. To specify a page in a different space, use SPACEKEY:Page Title. | STRING | Null | |
Sort Images By (sort) | ENUM | Null | ||
Reverse Sort (reverse) | Used only in conjunction with the 'Sort Images By' parameter. | BOOLEAN | false |
Include Page (include)
Includes the contents of a page within another.
confluence.macros.advanced:xhtml-include
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Page to Include () | To specify a page in a different space, use SPACEKEY:Page Title. | CONFLUENCE-CONTENT | Null | includeDatePath: true | REQUIRED |
Page Index (index)
Creates an index of all pages within the space.
confluence.macros.advanced:index
Body Type — NONE
Output Type — BLOCK
Jira timeline (jiraroadmap)
Embed an interactive Jira timeline into your page.
confluence.macros.advanced:xhtml-jiraroadmap
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
confluence.macros.advanced.jiraroadmap.param.url.label (url) | STRING | Null | REQUIRED |
Labels List (listlabels)
Lists all labels of a space, grouped alphabetically.
confluence.macros.advanced:xhtml-listlabels
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Restrict to this Space Key (spaceKey) | This is case-insensitive. If not specified, the current space is used. | SPACEKEY | Null | |
Excluded label(s) (excludedLabels) | Specify the labels you don't want to appear. These are case-sensitive. Separate each item with a comma. Example: | LABEL | Null | MULTIPLE |
Navigation Map (navmap)
Creates a map of pages associated with a specified label.
confluence.macros.advanced:navmap
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Label () | confluence.macros.advanced.navmap.param..desc | STRING | Null | REQUIRED |
Map Title (title) | STRING | Null | ||
Number of Cells Per Row (wrapAfter) | INT | 5 | ||
Cell Width (Pixels) (cellWidth) | The 'px' attribute is optional. | STRING | 90px | |
Cell Height (Pixels) (cellHeight) | The 'px' attribute is optional. | STRING | 60px | |
Navigation Map Theme (theme) | Example: | STRING | Null |
Popular Labels (popular-labels)
Generates a list or 'heatmap' of the most popular labels.
confluence.macros.advanced:popular-labels
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Number of Labels to Display (count) | INT | 100 | ||
Restrict Labels to this Space Key (spaceKey) | This is case-sensitive. If not specified, popular labels are retrieved from all spaces. | SPACEKEY | Null | |
Style of Labels (style) | ENUM | list |
Jira Premium plan (portfolioforjiraplan)
Insert plans that you've created in Jira into your page.
confluence.macros.advanced:xhtml-portfolioforjiraplan
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
URL (url) | STRING | Null | REQUIRED | |
confluence.macros.advanced.portfolioforjiraplan.param.planHeight.label (planHeight) | STRING | Null | REQUIRED |
Recent updates (recently-updated)
Display a custom list of recently updated content.
confluence.macros.advanced:xhtml-recently-updated
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Author(s) by username (author) | Separate usernames with a comma or single space. | USERNAME | Null | MULTIPLE |
Space(s) (spaces) | These are case-sensitive. Separate each item with a comma or single space. Example: | SPACEKEY | Null | MULTIPLE |
Label(s) (labels) | Include only pages tagged with these labels. Separate labels with commas or single spaces. | STRING | Null | |
Width of Table (width) | As a percentage of the window width. | PERCENTAGE | 100% | |
Include these Content Types Only (types) | Separate each type with a comma or single space. Example: | STRING | Null | |
Maximum Number of Results (max) | INT | 15 | ||
Theme (theme) | ENUM | Null | ||
Show User Profile Pictures (showProfilePic) | BOOLEAN | false | ||
Hide title (hideHeading) | BOOLEAN | false |
Recently Used Labels (recently-used-labels)
Lists the most recently used labels in a predefined scope of spaces.
confluence.macros.advanced:recently-used-labels
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Number of Labels to Display (count) | INT | 10 | ||
Scope for Retrieving Labels (scope) | Example: | ENUM | global | |
List Style (style) | ENUM | list | ||
Table Title (title) | Used only when the 'table' style is selected. | STRING | Null |
Related Labels (related-labels)
Lists labels used on other pages that have labels in common with the current page.
confluence.macros.advanced:related-labels
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Restrict to these Labels (labels) | Separate each label with a comma or single space. | STRING | Null |
Search Results (search)
Searches your Confluence site based on specified terms and displays the results on the page.
confluence.macros.advanced:search
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Search Terms (query) | STRING | Null | REQUIRED | |
Maximum Number of Results (maxLimit) | INT | Null | ||
Restrict to this Space Key (spacekey) | This is case-sensitive. If not specified, all accessible spaces are searched. | SPACEKEY | Null | |
Content Type (type) | ENUM | Null | ||
Last Modified (lastModified) | Restrict search to content last modified in the time period specified. Example: | RELATIVEDATE | Null | |
Restrict to this Username (contributor) | Restrict to content created or updated by this user. | USERNAME | Null |
Plugin: com.atlassian.confluence.plugins.expand-macro
com.atlassian.confluence.plugins.expand-macro.card.label (card)
Embeds an expandable text box into your page.
com.atlassian.confluence.plugins.expand-macro:card
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
com.atlassian.confluence.plugins.expand-macro.card.param.title.label (title) | STRING | Click here to expand... | showValueInPlaceholder: true showNameInPlaceholder: false |
Expand (expand)
Embeds an expandable text box into your page.
com.atlassian.confluence.plugins.expand-macro:expand
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Title (title) | STRING | Click here to expand... | showValueInPlaceholder: true showNameInPlaceholder: false |
Plugin: confluence.extra.chart
Chart (chart)
Display a chart
confluence.extra.chart:chart-xhtml
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Type (type) | Type of chart to generate. | ENUM | pie | |
Display Orientation (orientation) | For area, bar and line charts. If set to horizontal, the x-axis will run from top to bottom. | ENUM | Null | |
Show in 3D (3D) | For bar, line and pie charts. If ticked, the chart data will be rendered at an angle. | BOOLEAN | false | |
Stacked Values (stacked) | For area and bar charts. If ticked, the chart data series will be stacked. | BOOLEAN | false | |
Show shapes (showShapes) | If ticked, data points in the chart data will be highlighted with shapes. | BOOLEAN | true | |
Opacity (opacity) | A value from 0 (transparent) to 100 that determines how opaque the data series are. The defaults are different depending on chart types. For 3D charts, its 75. For stacked area charts, its 50 and for others its 100. | INT | Null | |
Width (width) | Chart width in pixels | INT | Null | |
Height (height) | Chart height in pixels | INT | Null | |
Display Chart Data (dataDisplay) | If set to 'before', the chart data table will be rendered on top of the chart. If 'after', the chart data table will be rendered below the chart. The chart data table isnt rendered by default. | ENUM | Null | |
Image format (imageFormat) | ENUM | Null | ||
Chart Title (title) | STRING | Null | ||
Chart Subtitle (subTitle) | STRING | Null | ||
Horizontal-axis Label (xLabel) | STRING | Null | ||
Vertical-axis Label (yLabel) | STRING | Null | ||
Show Legend? (legend) | BOOLEAN | true | ||
Tables (tables) | Comma separated list of IDs or numbers (starts from 1) in the macro's body to use as chart data. | STRING | Null | |
Columns (columns) | Comma separated list of column names or numbers (starts from 1) in the macros body to use as chart data. | STRING | Null | |
Content Orientation (dataOrientation) | If set to 'vertical', whole columns in the chart data table will be used as a series. Otherwise, whole rows will be used. | ENUM | Null | |
Time Series? (timeSeries) | BOOLEAN | false | ||
Date format (dateFormat) | Has effect only if the chart is a time series. This defines the format that will be used to read data/time values in the chart data. | STRING | Null | |
Time Period (timePeriod) | Has effect only if the chart is a time series. This defines the granularity of how the chart data is interpreted. | ENUM | Null | |
Language (language) | A ISO 639-1 two-letter language code used with 'Country' to form a locale. If specified, the chart macro will try to interpret the chart data in that locale. | STRING | Null | |
Country (country) | A ISO 3166-1 alpha-2 country code used with 'Language' to form a locale. If specified, the chart macro will try to interpret the chart data in that locale. | STRING | Null | |
Forgive (forgive) | If ticked, the chart macro will try to be more lenient with interpreting slightly out-of-format values in the chart data. | BOOLEAN | true | |
Background Colour (bgColor) | COLOR | Null | ||
Border Colour (borderColor) | COLOR | Null | ||
Colours (colors) | Comma separated list of colours used to customise category, sections, and series colours. | COLOR | Null | MULTIPLE |
Range Minimum Value (rangeAxisLowerBound) | INT | Null | ||
Range Maximum Value (rangeAxisUpperBound) | INT | Null | ||
Range Axis Tick Unit (rangeAxisTickUnit) | INT | Null | ||
Range Axis Label Angle (rangeAxisLabelAngle) | INT | Null | ||
Domain Axis Lower Bound (domainAxisLowerBound) | INT | Null | ||
Domain Axis Upper Bound (domainAxisUpperBound) | INT | Null | ||
Domain Axis Tick Unit (domainAxisTickUnit) | INT | Null | ||
Domain Axis Label Angle (domainAxisLabelAngle) | STRING | Null | ||
Category Label Position (categoryLabelPosition) | STRING | Null | ||
Date Tick Mark Position (dateTickMarkPosition) | STRING | Null | ||
Pie Selection Label (pieSectionLabel) | STRING | Null | ||
Pie Section Explode (pieSectionExplode) | STRING | Null | ||
Attachment (attachment) | The link (e.g. ^chart-image.png) to where the generated chart should be saved to or read from. | STRING | Null | |
Attachment Version (attachmentVersion) | Specifies how the generated chart is persisted as attachments. Read documentation for more details | ENUM | Null | |
Attachment Comment (attachmentComment) | The comment on attachment created/updated for the chart | STRING | Null | |
Thumbnail? (thumbnail) | Has effect only if an attachment is specified. Renders charts as thumbnails. | BOOLEAN | false |
Plugin: com.atlassian.confluence.ext.newcode-macro-plugin
Code Block (code)
Macro to format blocks of source-code or XML.
com.atlassian.confluence.ext.newcode-macro-plugin:code-xhtml
Body Type — PLAIN_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Syntax highlighting (language) | STRING | Null | ||
Title (title) | STRING | Null | ||
Collapsible (collapse) | BOOLEAN | false | ||
Show line numbers (linenumbers) | BOOLEAN | false | ||
First line number (firstline) | STRING | Null | ||
Theme (theme) | ENUM | Default |
Plugin: confluence.extra.layout
Column (column)
Defines a column on the page. (Must be used within a Section macro.)
N/A
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Column Width (width) | Specified either in 'px' (pixels) or as a '%' of page width. Examples: | STRING | Null |
Section (section)
Defines a section on a page, which can contain one or more Column macros.
N/A
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Show Border (border) | Draws a border around the sections and its columns. | BOOLEAN | false |
Plugin: com.atlassian.confluence.plugins.confluence-content-report-plugin
Content Report Table (content-report-table)
Provides a content report in table format, based on labels.
com.atlassian.confluence.plugins.confluence-content-report-plugin:content-report-table
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Label(s) (labels) | Enter one or more labels to report on. | STRING | Null | REQUIRED |
Space(s) (spaces) | Enter one or more space keys to report on. | SPACEKEY | Null | MULTIPLE |
Sort by (sort) | Select the column to sort results | ENUM | Page modified | |
Reverse sort (reverse) | Sort in descending order rather than ascending | BOOLEAN | true | |
Show Comments count (showCommentsCount) | Add the column that displays numbers of comments | BOOLEAN | false | |
Show Likes/Reactions count (showLikesCount) | Add the column that displays numbers of likes/reactions | BOOLEAN | false | |
Maximum Number of Pages (maxResults) | INT | 20 | ||
com.atlassian.confluence.plugins.confluence-content-report-plugin.content-report-table.param.blankTitle.label (blankTitle) | STRING | Null | HIDDEN | |
com.atlassian.confluence.plugins.confluence-content-report-plugin.content-report-table.param.blankDescription.label (blankDescription) | STRING | Null | HIDDEN | |
com.atlassian.confluence.plugins.confluence-content-report-plugin.content-report-table.param.contentBlueprintId.label (contentBlueprintId) | STRING | Null | HIDDEN | |
com.atlassian.confluence.plugins.confluence-content-report-plugin.content-report-table.param.blueprintModuleCompleteKey.label (blueprintModuleCompleteKey) | STRING | Null | HIDDEN | |
com.atlassian.confluence.plugins.confluence-content-report-plugin.content-report-table.param.createButtonLabel.label (createButtonLabel) | STRING | Null | HIDDEN |
Plugin: com.atlassian.confluence.contributors
Contributors (contributors)
Displays a list of contributors to a page, its hierarchy or selected spaces, or watches of these pages.
N/A
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Contribution Type (include) | The type of contribution on which to base the list of contributors and calculate statistics. Example: | ENUM | authors | MULTIPLE |
Sort By (order) | ENUM | count | ||
Reverse Sort (reverse) | Used only in conjunction with the 'Sort By' parameter. | BOOLEAN | false | |
Maximum Number of Contributors (limit) | INT | Null | ||
Display Format (mode) | ENUM | inline | ||
Show Anonymous Contributions? (showAnonymous) | BOOLEAN | false | ||
Show Count? (showCount) | Shows the number of times each user made a contribution. | BOOLEAN | false | |
Show Last Contribution Time? (showLastTime) | Show the last time a contribution was made by each user. | BOOLEAN | false | |
Page Name (page) | The page from which to base the contributors list and its statistics. If no Page Name and Space(s) are specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | |
Label(s) (labels) | Lists contributors who created these labels from the current or specified page. Separate each label with a comma. | LABEL | Null | MULTIPLE |
Space(s) (spaces) | Specify the space containing the page or scope of spaces to search. Space keys are case-sensitive. Separate each item with a comma. If no Page Name and Label(s) are specified, all pages from the selected spaces are included. | SPACEKEY | Null | MULTIPLE |
Content Type (contentType) | If not specified, both blog posts and pages are included. | ENUM | Null | |
Blog Post Date (publishDate) | Specify the publish date for a blog post. The date format required is: | DATE | Null | |
Include Page Hierarchy (scope) | Includes either the immediate children or decendants of the specified page. | ENUM | Null | |
Show Selected Pages (showPages) | Shows a list of pages returned above the list of contributors. | BOOLEAN | false | |
Custom "None Found" Message (noneFoundMessage) | When no contributors are found, override the default message displayed with this one. | STRING | Null |
Contributors Summary (contributors-summary)
Displays a summary of contributions to a page, its hierarchy or selected spaces, in tabular form.
com.atlassian.confluence.contributors:contributors-summary-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Group By (groupby) | Specify if the table should group statistics by contributor or page. | ENUM | contributors | |
Columns to Display (columns) | The columns that should appear in the table. Example: | ENUM | edits,comments,labels | MULTIPLE |
Sort By (order) | The criteria used for sorting items in the table. | ENUM | edits | |
Reverse Sort (reverse) | Used only in conjunction with the 'Sort By' parameter. | BOOLEAN | false | |
Maximum Number of Items (limit) | Restricts the number of items in the table. | INT | Null | |
Show Anonymous Contributions? (showAnonymous) | BOOLEAN | false | ||
Show Zero Counts? (showZeroCounts) | If selected, items whose counts in all columns are zero, are included. | BOOLEAN | false | |
Page Name (page) | The page from which to calculate the contribution-based statistics. If no Page Name and Space(s) are specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | |
Label(s) (labels) | Restrict the contribution-based statistics to these labels only. Separate each label with a comma. | LABEL | Null | MULTIPLE |
Space(s) (spaces) | Specify the space containing the page or scope of spaces to search. Space keys are case-sensitive. Separate each item with a comma. If no Page Name and Label(s) are specified, all pages from the selected spaces are included. | SPACEKEY | Null | MULTIPLE |
Content Type (contentType) | If not specified, both blog posts and pages are included. | ENUM | Null | |
Blog Post Date (publishDate) | Specify the publish date for a blog post. The date format required is: | DATE | Null | |
Include Page Hierarchy (scope) | Includes either the immediate children or decendants of the specified page. | ENUM | Null |
Plugin: com.atlassian.confluence.plugins.confluence-create-content-plugin
Create from Template (create-from-template)
Embed a button in your content which enables users to create content from any pre-defined template.
com.atlassian.confluence.plugins.confluence-create-content-plugin:create-from-template
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Button text (buttonLabel) | STRING | Null | ||
Template name (templateName) | Name of the template to create the new page from. | ENUM | Null | REQUIRED |
Title of page to be created (title) | You can use @currentDate, @spaceName or @spaceKey to have those values inserted for you. | STRING | Null | |
Space key (spaceKey) | The space new pages will be created in (by default, the current space). | SPACEKEY | Null | REQUIRED |
com.atlassian.confluence.plugins.confluence-create-content-plugin.create-from-template.param.templateId.label (templateId) | STRING | Null | HIDDEN | |
com.atlassian.confluence.plugins.confluence-create-content-plugin.create-from-template.param.blueprintModuleCompleteKey.label (blueprintModuleCompleteKey) | STRING | Null | HIDDEN | |
com.atlassian.confluence.plugins.confluence-create-content-plugin.create-from-template.param.contentBlueprintId.label (contentBlueprintId) | STRING | Null | HIDDEN |
Plugin: confluence.macros.dashboard
Create Space Button (create-space-button)
Displays a create space icon that links to the create space page.
confluence.macros.dashboard:create-space-button
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Icon Size (size) | ENUM | large |
Global Reports (global-reports)
Displays a list of links to global reports.
confluence.macros.dashboard:global-reports
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Width of Table (width) | As a percentage of the window width. Example: | PERCENTAGE | Null |
Recently Updated Dashboard (recently-updated-dashboard)
Lists the most recently changed Confluence content in a dashboard view style.
confluence.macros.dashboard:recently-updated-dashboard
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Space(s) (spaces) | These are case-sensitive. Separate each item with a comma. | SPACEKEY | Null | MULTIPLE |
Include these Content Types Only (types) | Separate each type with a comma. Example: | STRING | Null | MULTIPLE |
Label(s) (labels) | Include only pages tagged with these labels. Separate labels with commas. | STRING | Null | MULTIPLE |
User(s) (users) | Filter updates by a list of usernames. Separate usernames with commas. | USERNAME | Null | MULTIPLE |
Width of Table (width) | As a percentage of the window width. Example: | PERCENTAGE | 100% | |
Show User Profile Pictures (showProfilePic) | BOOLEAN | false |
Space Details (space-details)
Displays a table containing information about the current space.
confluence.macros.dashboard:space-details
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Width of Table (width) | As a percentage of the window width. Example: | PERCENTAGE | Null |
Spaces List (spaces)
Displays a list of the spaces on this wiki.
confluence.macros.dashboard:spaces
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Scope of spaces () | confluence.macros.dashboard.spaces.param..desc | ENUM | Null | |
Width of List (width) | As a percentage of the window width. Example: | PERCENTAGE | 100% |
Welcome Message (welcome-message)
Insert welcome message text.
confluence.macros.dashboard:welcome-message
Body Type — NONE
Output Type — BLOCK
Plugin: confluence.extra.masterdetail
Page Properties (details)
Enter a table of summary information in this macro and display it on another page using a Page Properties Report macro. You will need to add a label to this page and specify it in the report macro.
confluence.extra.masterdetail:details-xhtml
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Page properties ID (optional) (id) | Specify an ID if you have multiple page properties macros on this page and want to report on them seperately. | STRING | Null | |
Hidden (hidden) | Hide the contents of this macro when viewing this page. Content will still be displayed in the Page Properties Report macro. | BOOLEAN | false |
Page Properties Report (detailssummary)
Display a table of pages that contain the Page Properties macro and a specific label. The table includes a link to each page and the summary information contained in the Page Properties macro(s) on that page.
confluence.extra.masterdetail:detailssummary-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
confluence.extra.masterdetail.detailssummary.param.cql.label (cql) | CQL | space = currentSpace() | defaultFields: label requiredFields: label defaultValue: space = currentSpace() | REQUIRED | |
Page properties ID (optional) (id) | If you have multiple page properties macros on a page and want to report on a specific one, enter the Page Properties ID of that macro. Leave blank to include all macros. | STRING | Null | ||
Title column heading (firstcolumn) | Change the heading of the Title column which contains links to pages. Maximum 35 characters. | STRING | Null | ||
Columns to show (headings) | Comma separated list of columns to include in the table. Page title is always shown. | STRING | Null | ||
Max results per page (pageSize) | Number of results displayed at a time, up to 30. | STRING | 30 | ||
Sort by (sortBy) | By default the table will sort by last modified date. | STRING | Null | ||
Reverse sort (reverseSort) | Used only in conjunction with the Sort by parameter. | BOOLEAN | false | ||
Show total comments count (showCommentsCount) | BOOLEAN | false | |||
Show likes/reactions count (showLikesCount) | BOOLEAN | false | |||
Show open inline comments count (showUnresolvedCommentsCount) | BOOLEAN | false | |||
Show labels (showPageLabels) | BOOLEAN | false | |||
Show owner (showCreator) | BOOLEAN | false | |||
Show last modified time (showLastModified) | BOOLEAN | false | |||
confluence.extra.masterdetail.detailssummary.param.blankTitle.label (blankTitle) | STRING | Null | HIDDEN | ||
confluence.extra.masterdetail.detailssummary.param.blankDescription.label (blankDescription) | STRING | Null | HIDDEN | ||
confluence.extra.masterdetail.detailssummary.param.contentBlueprintId.label (contentBlueprintId) | STRING | Null | HIDDEN | ||
confluence.extra.masterdetail.detailssummary.param.blueprintModuleCompleteKey.label (blueprintModuleCompleteKey) | STRING | Null | HIDDEN | ||
confluence.extra.masterdetail.detailssummary.param.createButtonLabel.label (createButtonLabel) | STRING | Null | HIDDEN |
Plugin: gadgets
Watched Issues (gadget)
Shows the issues watched by the current user.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:watched-gadget/gadgets/watched-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Average Time in Status (gadget)
Displays the average number of days resolved issues have spent in status.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.ext.charting:timeinstatus-gadget/com/atlassian/jira/ext/charting/gadget/timeinstatus-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Projects (gadget)
List multiple projects
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:project-gadget/gadgets/project-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Sprint Burndown Gadget (gadget)
Sprint burndown chart to track remaining work (Wallboard capable)
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.pyxis.greenhopper.jira:greenhopper-gadget-sprint-burndown/gadgets/greenhopper-sprint-burndown.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Issue Statistics (gadget)
Issue Statistics
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:stats-gadget/gadgets/stats-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Jira Issues Calendar (gadget)
Jira Issues Calendar
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.ext.calendar:issuescalendar-gadget/templates/plugins/jira/portlets/calendar/gadget/calendar-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Created vs. Resolved Chart (gadget)
Displays created issues vs. resolved issues for a project or saved filter.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:created-vs-resolved-issues-chart-gadget/gadgets/createdvsresolved-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Agile Wallboard Gadget (gadget)
Displays a board as a Wallboard gadget
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.pyxis.greenhopper.jira:greenhopper-gadget-rapid-view/gadgets/greenhopper-rapid-view.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Wallboard Spacer Gadget (gadget)
Allows for custom spacing between gadgets in a wallboard
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Height of spacer (height) | null | STRING | 20 | |
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.atlassian-wallboard-plugin:spacer-gadget/gadgets/spacerGadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Sprint Health Gadget (gadget)
Visual snapshot of the health of a sprint (Wallboard capable)
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.pyxis.greenhopper.jira:greenhopper-gadget-sprint-health/gadgets/greenhopper-sprint-health.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Filter Results (gadget)
Shows the issues/results for a saved filter.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:filter-results-gadget/gadgets/filter-results-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Jira Road Map (gadget)
Display upcoming versions for specified projects.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:road-map-gadget/gadgets/roadmap-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Time to First Response (gadget)
Displays the number of hours taken to respond to issues for a project or filter.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.ext.charting:firstresponse-gadget/com/atlassian/jira/ext/charting/gadget/firstresponse-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Time Since Chart (gadget)
Displays the time since a chosen field for each issue for a project or saved filter.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:time-since-chart-gadget/gadgets/timesince-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Quick links (gadget)
Displays links for common tasks
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:quicklinks-gadget/gadgets/quicklinks-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Workload Pie Chart (gadget)
Displays the matching issues for a project or filter as a pie chart.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.ext.charting:workloadpie-gadget/com/atlassian/jira/ext/charting/gadget/workloadpie-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Labels Gadget (gadget)
Jira issue labels in a Gadget
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:labels-gadget/gadgets/labels-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Activity Stream (gadget)
Lists recent activity in a single project, or in all projects.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.streams.streams-jira-plugin:activitystream-gadget/gadgets/activitystream-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Assigned to Me (gadget)
Displays all unresolved issues assigned to me
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:assigned-to-me-gadget/gadgets/assigned-to-me-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Version Report (gadget)
Track the projected release date for a version. This helps you monitor whether the version will release on time, so you can take action if work is falling behind.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.pyxis.greenhopper.jira:greenhopper-gadget-version-report/gadgets/greenhopper-version-report.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Voted Issues (gadget)
Shows the issues voted by the current user.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:voted-gadget/gadgets/voted-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Two Dimensional Filter Statistics (gadget)
Display statistics of issues returned from specified filter
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:two-dimensional-stats-gadget/gadgets/two-dimensional-stats-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Resolution Time (gadget)
Displays a bar graph of elapsed time to resolve issues for a project or filter.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:resolution-time-gadget/gadgets/resolution-time-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Average Number of Times in Status (gadget)
Displays the average number of times issues have been in a status.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.ext.charting:numberoftimesinstatus-gadget/com/atlassian/jira/ext/charting/gadget/numberoftimesinstatus-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Starred filters (gadget)
Lists the current user's starred filters.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:favourite-filters-gadget/gadgets/favourite-filters-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Average Age Chart (gadget)
Displays the average number of days issues have been unresolved.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:average-age-chart-gadget/gadgets/average-age-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Pie Chart (gadget)
Displays the matching issues for a project or filter as a pie chart.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:pie-chart-gadget/gadgets/piechart-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Recently Created Chart (gadget)
Displays recently created issues for a specified project as a bar chart
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:recently-created-chart-gadget/gadgets/recently-created-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Issues in progress (gadget)
Issues in progress
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:in-progress-gadget/gadgets/in-progress-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Days Remaining in Sprint Gadget (gadget)
Displays days remaining in a sprint (Wallboard capable)
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.pyxis.greenhopper.jira:greenhopper-gadget-sprint-days-remaining/gadgets/greenhopper-sprint-days-remaining.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Heat Map (gadget)
Displays the matching issues for a project or filter as a heat map.
N/A
Body Type — NONE
Output Type — null
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
gadgets.gadget.param.url.label (url) | STRING | https://wombats.atlassian.net/rest/gadgets/1.0/g/com.atlassian.jira.gadgets:heat-map-gadget/gadgets/heatmap-gadget.xml | HIDDENREQUIRED | |
Width (width) | Examples: "300" (300px), "300px", "50%", "auto" | INT | 450 | |
Border (border) | Whether or not to surround the gadget with a thin border | BOOLEAN | true | |
gadgets.gadget.param.author.label (author) | STRING | Atlassian | ||
gadgets.gadget.param.preferences.label (preferences) | STRING | Null | HIDDEN |
Plugin: com.atlassian.confluence.plugins.gadgets
com.atlassian.confluence.plugins.gadgets.gadget.label (gadget)
Renders Gadgets in Confluence
com.atlassian.confluence.plugins.gadgets:gadget
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
com.atlassian.confluence.plugins.gadgets.gadget.param.foo.label (foo) | ENUM | pie |
Plugin: confluence.extra.information
Info (info)
com.atlassian.confluence.extra.information.info.desc
confluence.extra.information:xhtml-info
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Optional Title (title) | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false | ||
Show Information Icon (icon) | BOOLEAN | true |
Note (note)
com.atlassian.confluence.extra.information.note.desc
confluence.extra.information:xhtml-note
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Optional Title (title) | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false | ||
Show Exclamation Mark Icon (icon) | BOOLEAN | true |
Tip (tip)
com.atlassian.confluence.extra.information.tip.desc
confluence.extra.information:xhtml-tip
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Optional Title (title) | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false | ||
Show Tip Icon (icon) | BOOLEAN | true |
Warning (warning)
com.atlassian.confluence.extra.information.warning.desc
confluence.extra.information:xhtml-warning
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Optional Title (title) | STRING | Null | showValueInPlaceholder: true showNameInPlaceholder: false | ||
Show Warning Icon (icon) | BOOLEAN | true |
Plugin: confluence.extra.jira
Jira Legacy (jira)
Insert issues from Jira Cloud or Server via JQL
confluence.extra.jira:jira-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
confluence.extra.jira.jira.param.key.label (key) | STRING | Null | showValueInPlaceholder: true showKeyInPlaceholder: false | ||
confluence.extra.jira.jira.param.jqlQuery.label (jqlQuery) | STRING | Null | showValueInPlaceholder: true showKeyInPlaceholder: false | ||
confluence.extra.jira.jira.param.server.label (server) | STRING | Null | showValueInPlaceholder: false showKeyInPlaceholder: false | REQUIRED | |
confluence.extra.jira.jira.param.serverId.label (serverId) | STRING | Null | showValueInPlaceholder: false showKeyInPlaceholder: false | ||
confluence.extra.jira.jira.param.serverUrl.label (serverUrl) | STRING | Null | showValueInPlaceholder: false showKeyInPlaceholder: false | ||
confluence.extra.jira.jira.param.showSummary.label (showSummary) | BOOLEAN | true |
Jira Charts (jirachart)
Display Jira information on your page as a chart.
confluence.extra.jira:jirachart-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
confluence.extra.jira.jirachart.param.server.label (server) | STRING | Null | showValueInPlaceholder: false showKeyInPlaceholder: false | REQUIRED |
Jira Issues (jiraissues)
Macro to retrieve a feed of Jira issues and summarise them in the page
confluence.extra.jira:jiraissues-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Issues URL (url) | The URL to the XML view of the search results in Jira. | URL | Null | REQUIRED |
Columns (columns) | Valid columns are key, summary, type, created, updated, due, assignee, reporter, priority, status and resolution. | STRING | Null | |
Show issues count? (count) | Tick to show the number of issues. | BOOLEAN | false | |
Cache results (cache) | Untick to reload search results from Jira every time at the expense of longer load time. | ENUM | on | |
Show anonymous results (anonymous) | Tick to show results for the Jira anonymous user. | BOOLEAN | false | |
Width (width) | The width of the table. Default is '100%'. | STRING | 100% | |
Height (height) | The height of the table in pixels. Default is '480'. | INT | 480 | |
confluence.extra.jira.jiraissues.param.title.label (title) | STRING | Null | ||
Style (renderMode) | The style of the table. Select 'dynamic' for an interactive table, 'static' otherwise. | ENUM | dynamic | |
confluence.extra.jira.jiraissues.param.showSummary.label (showSummary) | BOOLEAN | true |
Plugin: confluence.extra.livesearch
Live Search (livesearch)
Search Confluence directly from your page, with live results as you type
confluence.extra.livesearch:livesearch-xhtml
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Space (spaceKey) | SPACEKEY | Null | ||
Filter by type (type) | ENUM | all | ||
Filter by label (labels) | LABEL | Null | MULTIPLE | |
Search bar text (placeholder) | STRING | Search | ||
Size (size) | ENUM | medium | ||
Search result format (additional) | ENUM | space name |
Search (search-box)
Search Confluence directly from your page, with live results as you type
confluence.extra.livesearch:xhtml-search-box
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Space (spaceKey) | SPACEKEY | Null | ||
Filter by type (type) | ENUM | all | ||
Filter by label (labels) | LABEL | Null | MULTIPLE | |
Search bar text (placeholder) | STRING | Search | ||
Size (size) | ENUM | medium | ||
Search result format (additional) | ENUM | space name |
Plugin: confluence.macros.multimedia
confluence.macros.multimedia.multimedia.label (multimedia)
Insert audio and video files that are attached to any page.
confluence.macros.multimedia:multimedia
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Page name (page) | CONFLUENCE-CONTENT | Null | includeDatePath: true | ||
File (name) | ATTACHMENT | Null | REQUIRED | ||
Width (width) | In pixels or as a percentage. For example, | INT | Null | ||
Height (height) | In pixels or as a percentage. For example, | INT | Null | ||
Autoplay (autostart) | BOOLEAN | false |
Plugin: confluence.macros.profile
Network (network)
Displays the network of a user.
N/A
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Username (username) | If not specified, the current user is assumed. | USERNAME | Null | |
Mode () | 'Following' displays users that the specified user is following. 'Followers' displays users who are following the specified user. | ENUM | Null | REQUIRED |
Theme (theme) | Full theme displays large icons and includes an item to follow more users. Tiny theme only displays small icons. | ENUM | Null | |
Maximum Results (max) | INT | Null |
User Profile (profile)
Displays a user's profile details.
N/A
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
User (user) | USERNAME | Null | REQUIRED |
Plugin: com.atlassian.plugins.atlassian-connect-plugin
JSM Incident Timeline EU (opsgenie-incident-timeline-eu-jsm-issue-activity-macro)
Shows JSM Incident Timeline
com.atlassian.plugins.atlassian-connect-plugin:xhtml__opsgenie-incident-timeline-eu__opsgenie-incident-timeline-eu-jsm-issue-activity-macro
Body Type — NONE
Output Type — BLOCK
Opsgenie Incident Timeline EU (opsgenie-incident-timeline-eu-macro)
Shows Opsgenie Incident Timeline
com.atlassian.plugins.atlassian-connect-plugin:xhtml__opsgenie-incident-timeline-eu__opsgenie-incident-timeline-eu-macro
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Incident Id (incidentId) | STRING | Null | REQUIRED |
JSM Incident Timeline (opsgenie-incident-timeline-prod-jsm-issue-activity-macro)
Shows JSM Incident Timeline
com.atlassian.plugins.atlassian-connect-plugin:xhtml__opsgenie-incident-timeline-prod__opsgenie-incident-timeline-prod-jsm-issue-activity-macro
Body Type — NONE
Output Type — BLOCK
Opsgenie Incident Timeline (opsgenie-incident-timeline-prod-macro)
Shows Opsgenie Incident Timeline
com.atlassian.plugins.atlassian-connect-plugin:xhtml__opsgenie-incident-timeline-prod__opsgenie-incident-timeline-prod-macro
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Incident Id (incidentId) | STRING | Null | REQUIRED |
Trello Board (trello-board)
Embed a fully interactive Trello board into your page.
com.atlassian.plugins.atlassian-connect-plugin:xhtml__cello__trello-board
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
URL (url) | STRING | Null | REQUIRED | |
Height (height) | STRING | 760px | REQUIRED |
Trello Card (trello-card)
Add a beautiful preview of Trello boards and cards.
com.atlassian.plugins.atlassian-connect-plugin:xhtml__cello__trello-card
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
URL (url) | STRING | Null | REQUIRED | |
Compact card (compact) | BOOLEAN | false |
Plugin: com.atlassian.confluence.plugins.pagetree
Page Tree (pagetree)
Renders a page tree.
com.atlassian.confluence.plugins.pagetree:pagetree-xhtml
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Root Page (root) | Examples: | CONFLUENCE-CONTENT | Null | type: page | |
Restrict to this Space Key (spaces) | This is case-sensitive. If not specified, current space will be used. | SPACEKEY | Null | ||
Sort Pages By (sort) | ENUM | position | |||
Include Excerpts in Page Tree (excerpt) | BOOLEAN | false | |||
Reverse Order (reverse) | Used only in conjunction with the 'Sort Pages By' parameter. | BOOLEAN | false | ||
Include Search Box above Page Tree (searchBox) | Restricts searching to current space only. | BOOLEAN | false | ||
Show Expand/Collapse Links (expandCollapseAll) | Displays the 'expand all' and 'collapse all' links at the top of the page tree. | BOOLEAN | false | ||
Start Depth (startDepth) | Any positive number representing the level to which child pages are shown when the page tree is first displayed. | INT | 1 |
Page Tree Search (pagetreesearch)
Provides a search box that searches a hierarchy of pages (Page Tree) from a specified root page.
N/A
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Name of Root Page (rootPage) | If not specified, the root page is the current page. | STRING | Null | type: page |
Plugin: com.atlassian.confluence.plugins.confluence-profile-picture
Profile Picture (profile-picture)
Displays a user's profile picture.
com.atlassian.confluence.plugins.confluence-profile-picture:profile-picture
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
com.atlassian.confluence.plugins.confluence-profile-picture.profile-picture.param.User.label (User) | USERNAME | Null | REQUIRED | |
com.atlassian.confluence.plugins.confluence-profile-picture.profile-picture.param.Size.label (Size) | ENUM | normal |
Plugin: com.atlassian.confluence.plugins.confluence-roadmap-plugin
Roadmap Planner (roadmap)
Create a simple, visual roadmap for planning projects, software releases and more.
com.atlassian.confluence.plugins.confluence-roadmap-plugin:roadmap-macro
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
com.atlassian.confluence.plugins.confluence-roadmap-plugin.roadmap.param.source.label (source) | STRING | Null | showValueInPlaceholder: false showNameInPlaceholder: false | REQUIRED | |
com.atlassian.confluence.plugins.confluence-roadmap-plugin.roadmap.param.pagelinks.label (pagelinks) | CONFLUENCE-CONTENT | Null | delimiter: ~~~~~ | MULTIPLE | |
com.atlassian.confluence.plugins.confluence-roadmap-plugin.roadmap.param.maplinks.label (maplinks) | STRING | Null |
Plugin: com.atlassian.confluence.plugins.confluence-business-blueprints
Shared Links Bookmarklet Button (sharelinks-urlmacro)
Share a link from anywhere by dragging this button to your browser.
com.atlassian.confluence.plugins.confluence-business-blueprints:sharelinks-urlmacro
Body Type — NONE
Output Type — BLOCK
Plugin: com.atlassian.confluence.plugins.status-macro
Status (status)
Communicate the status of a project, task or milestone with visual indicators.
com.atlassian.confluence.plugins.status-macro:status
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Title (title) | STRING | Null | ||
Colour (colour) | ENUM | Grey | REQUIRED | |
Use outline style (subtle) | BOOLEAN | false |
Plugin: confluence.extra.dynamictasklist2
Tasklist (tasklist)
Displays a modifiable and interactive task list.
confluence.extra.dynamictasklist2:tasklist
Body Type — PLAIN_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Title (title) | If not specified, the default title is 'Task List'. | STRING | Null | |
Width of List (width) | Specified either in pixels ('px') or as a '%' of page width. Examples: | STRING | Null | |
Enable Locking (enableLocking) | Locks individual tasks so that they cannot be changed. | BOOLEAN | false | |
Prompt on Delete (promptOnDelete) | Prompts user on deletion of tasks. | BOOLEAN | false |
Plugin: com.atlassian.confluence.plugins.confluence-inline-tasks
Task report (tasks-report-macro)
Create a report of tasks from specific locations, people, status and more.
com.atlassian.confluence.plugins.confluence-inline-tasks:tasks-report
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Space(s) and page(s) (spaceAndPage) | Only show tasks from these spaces or pages (required) | STRING | Null | MULTIPLEREQUIRED |
Label(s) (labels) | Only show tasks on pages with this label | LABEL | Null | MULTIPLE |
Assigned to (assignees) | Only show tasks assigned to these people | USERNAME | Null | MULTIPLE |
Created by (creators) | Only show tasks created by these people | USERNAME | Null | MULTIPLE |
Created after (createddateFrom) | Only show tasks created on or after this date. Dates must be entered as dd-mm-yyyy. | DATE | Null | |
Task status (status) | ENUM | incomplete | ||
Number of tasks per page (pageSize) | ENUM | 20 | ||
Columns to display (columns) | Allowed columns are description, duedate, assignee, location, completedate, labels | STRING | description,duedate,assignee,location | |
Sort by (sortBy) | ENUM | due date | ||
Reverse sort (reverseSort) | BOOLEAN | false |
Plugin: org.randombits.confluence.toc
Table of Contents (toc)
Generates a hyperlinked table of contents based on the headings present in the current page.
org.randombits.confluence.toc:toc
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Output Type (type) | ENUM | list | ||
Display Section Numbering (outline) | BOOLEAN | false | ||
List Style (style) | The style of bullet-point applied to each item in the list. Any CSS styles are valid. Examples: | STRING | disc | |
Heading Indent (indent) | The amount by which to indent each heading level (in CSS units). Example: | STRING | Null | |
Separator (separator) | The type of separator used when 'Output Type' is set to 'flat'. Examples: | STRING | brackets | |
Minimum Heading Level (minLevel) | The minimum heading level to report in the TOC. For example, '3' will list headings from 'h3.' onwards, but not 'h1.' or 'h2.'. | INT | 1 | |
Maximum Heading Level (maxLevel) | The maximum heading level to report in the TOC. For example, '4' will list headings up to 'h4.', but not from 'h5.' onwards. | INT | 7 | |
Include Headings (include) | If set, any headings not matching the regular expression are ignored. Example: | STRING | Null | |
Exclude Headings (exclude) | If set, any headings that match the regular expression are ignored. Example: | STRING | Null | |
Printable (printable) | If cleared, the TOC will not be visible when printing. | BOOLEAN | true | |
CSS Class Name (class) | If specified, a | STRING | Null | |
Absolute URL (absoluteUrl) | If checked, the links in the table of contents will be full URLs | BOOLEAN | false |
Table of Content Zone (toc-zone)
Generates a table of contents based on the headings present within its body text zone.
org.randombits.confluence.toc:toc-zone
Body Type — RICH_TEXT
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
org.randombits.confluence.toc.toc-zone.param.location.label (location) | ENUM | both | ||
Output Type (type) | ENUM | list | ||
Display Section Numbering (outline) | BOOLEAN | false | ||
List Style (style) | The style of bullet-point applied to each item in the list. Any CSS styles are valid. Examples: | STRING | none | |
Heading Indent (indent) | The amount by which to indent each heading level (in CSS units). Example: | STRING | Null | |
Separator (separator) | The type of separator used when 'Output Type' is set to 'flat'. Examples: | STRING | brackets | |
Minimum Heading Level (minLevel) | The minimum heading level to report in the TOC. For example, '3' will list headings from 'h3.' onwards, but not 'h1.' or 'h2.'. | INT | 1 | |
Max Heading Level (maxLevel) | The maximum heading level to report in the TOC. For example, '4' will list headings up to 'h4.', but not from 'h5.' onwards. | INT | 7 | |
Include Headings (include) | If set, any headings not matching the regular expression are ignored. Example: | STRING | Null | |
Exclude Headings (exclude) | If set, any headings that match the regular expression are ignored. Example: | STRING | Null | |
Print in export (printable) | If cleared, the TOC will not be visible when exporting. | BOOLEAN | true | |
CSS Class Name (class) | If specified, a | STRING | Null |
Plugin: confluence.xhtml.wikimarkup
Wiki Markup (unmigrated-inline-wiki-markup)
Macro that identifies inline wiki markup that could not be migrated. The body of this macro can be a candidate for subsequent attempts at migration.
confluence.xhtml.wikimarkup:unmigrated-inline-wiki-markup
Body Type — PLAIN_TEXT
Output Type — INLINE
Wiki Markup (unmigrated-wiki-markup)
Macro that identifies a block of wiki markup that could not be migrated. The body of this macro can be a candidate for subsequent attempts at migration.
confluence.xhtml.wikimarkup:unmigrated-wiki-markup
Body Type — PLAIN_TEXT
Output Type — BLOCK
Plugin: confluence.extra.userlister
User List (userlister)
Displays a list of Confluence users based on group membership.
N/A
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Group(s) (groups) | Specify one or more groups. Separate each group using a comma. For all groups, specify an asterisk ('*'). | GROUP | Null | MULTIPLEREQUIRED |
Plugin: com.atlassian.confluence.plugins.confluence-view-file-macro
com.atlassian.confluence.plugins.confluence-view-file-macro.view-file.label (view-file)
View file macro
com.atlassian.confluence.plugins.confluence-view-file-macro:view-file
Body Type — NONE
Output Type — INLINE
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
com.atlassian.confluence.plugins.confluence-view-file-macro.view-file.param.page.label (page) | CONFLUENCE-CONTENT | Null | includeDatePath: true derived: name | ||
com.atlassian.confluence.plugins.confluence-view-file-macro.view-file.param.space.label (space) | SPACEKEY | Null | derived: name | ||
com.atlassian.confluence.plugins.confluence-view-file-macro.view-file.param.date.label (date) | DATE | Null | derived: name | ||
com.atlassian.confluence.plugins.confluence-view-file-macro.view-file.param.name.label (name) | FULL_ATTACHMENT | Null | REQUIRED |
Plugin: com.atlassian.confluence.extra.officeconnector
Word (viewdoc)
Embeds a Word document (.doc) file into your Confluence page.
com.atlassian.confluence.extra.officeconnector:viewdoc
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Page Name (page) | Confluence page containing the attached document. If not specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | includeDatePath: true | |
File Name (name) | Name of the attached document to view in this page. | ATTACHMENT | Null | REQUIRED | |
Date (date) | If the Page Name refers to a Blog post, this is the date of the post in the form mm/dd/yyyy | DATE | Null | ||
Space Key (space) | Space containing the attached document. This is case-sensitive. If not specified, the current space is assumed. | SPACEKEY | Null |
View File (viewfile)
Adds a hyperlink for editing in Word
com.atlassian.confluence.extra.officeconnector:viewfile
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
File Name (name) | Name of the attached file to view in this page. | ATTACHMENT | Null | REQUIRED | |
Page Name (page) | Confluence page containing the attached file. If not specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | includeDatePath: true | |
Date (date) | If the Page Name refers to a Blog post, this is the date of the post in the form mm/dd/yyyy | DATE | Null | ||
Space Key (space) | Space containing the attached file. This is case-sensitive. If not specified, the current space is assumed. | SPACEKEY | Null | ||
Height (.ppt files only) (height) | Specified either in pixels (default or 'px') or as a '%' of page width. Examples: | STRING | Null | ||
Width (.ppt files only) (width) | Specified either in pixels (default or 'px') or as a '%' of page width. | STRING | Null |
PDF (viewpdf)
Embeds a PDF document (.pdf) into your Confluence page.
com.atlassian.confluence.extra.officeconnector:viewpdf
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Page Name (page) | Confluence page containing the attached .pdf file. If not specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | includeDatePath: true | |
File Name (name) | Name of the attached .pdf file to view in this page. | ATTACHMENT | Null | REQUIRED | |
Date (date) | If the Page Name refers to a Blog post, this is the date of the post in the form mm/dd/yyyy | DATE | Null | ||
Space Key (space) | Space containing the attached .pdf file. This is case-sensitive. If not specified, the current space is assumed. | SPACEKEY | Null |
Powerpoint (viewppt)
Embeds a Powerpoint document (.ppt) into your Confluence page.
com.atlassian.confluence.extra.officeconnector:viewppt
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Page Name (page) | Confluence page containing the attached .ppt file. If not specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | includeDatePath: true | |
File Name (name) | Name of the attached .ppt file to view in this page. | ATTACHMENT | Null | REQUIRED | |
Date (date) | If the Page Name refers to a Blog post, this is the date of the post in the form mm/dd/yyyy | DATE | Null | ||
Space Key (space) | Space containing the attached .ppt file. This is case-sensitive. If not specified, the current space is assumed. | SPACEKEY | Null | ||
Height (height) | Specified either in pixels (default or 'px') or as a '%' of page width. Examples: | STRING | Null | ||
Width (width) | Specified either in pixels (default or 'px') or as a '%' of page width. | STRING | Null |
Excel (viewxls)
Embeds an Excel document (.xls) into your Confluence page.
com.atlassian.confluence.extra.officeconnector:viewxls
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Options | Properties |
|---|---|---|---|---|---|
Page Name (page) | Confluence page containing the attached .xls file. If not specified, the current page is assumed. | CONFLUENCE-CONTENT | Null | includeDatePath: true | |
File Name (name) | Name of the attached .xls file to view in this page. | ATTACHMENT | Null | REQUIRED | |
Date (date) | If the Page Name refers to a Blog post, this is the date of the post in the form mm/dd/yyyy | DATE | Null | ||
Space Key (space) | Space containing the attached .xls file. This is case-sensitive. If not specified, the current space is assumed. | SPACEKEY | Null |
Plugin: com.atlassian.confluence.extra.widgetconnector
Widget Connector (widget)
Embed YouTube videos, Flickr slideshows, Twitter streams, Google Docs and other content from the web.
com.atlassian.confluence.extra.widgetconnector:widget-xhtml
Body Type — NONE
Output Type — BLOCK
Parameters
Display Name (name) | Description | Type | Default Value | Properties |
|---|---|---|---|---|
Web Site's Widget URL (url) | URL | Null | REQUIRED | |
Pixel Width (Value Only) (width) | INT | Null | ||
Pixel Height (Value Only) (height) | INT | Null |