Confluence Storage Format for Macros

default-parameter

(Unnamed in wiki markup)

Available values:

• false - Displays only the latest version of each attachment.
• true – Displays all versions of each attachment, including the old versions.

A comma-separated list of regular expressions, used to filter the attachments by file name. Note that the parameter values must be regular expressions. For example:

• To match a file suffix of 'jpg', use .*jpg (not *.jpg).
• To match file names ending in 'jpg' or 'png', use .*jpg,.*png

Available values:

• date
• size
• name

The default sort order is determined by the sortBy type:

• Reverse chronological for 'date'.
• Largest to smallest for 'size'.
• Alphabetical for 'name'.

Available values:

• ascending
• descending

Available values:

• entire – Display the whole content of each blog post.
• excerpts – Display a short extract from each blog post. If the post contains an Excerpt macro, the Blog Posts macro will display the content defined in the Excerpt macro. If the post does not contain an Excerpt macro, the Blog Posts macro will display the first few sentences of the post.
• titles – Display a list of blog posts, showing titles only.

One or more space keys, separated by a comma or a space.

• To exclude content in a specific space, put a minus sign (-) immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE.
• To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.)

Special values:

• m — Minutes
• h — Hours
• d — Days
• w — Weeks

For example,

• time=12h – Display blog posts created in the last twelve hours.
• time=7d  – Display blog posts created in the last seven days.

Available values:

• title — Sort alphabetically by title.
• creation — Sort by the date on which the content was added.
• modified — Sort by the date on which the content was last updated.

One or more label values, separated by a comma or a space.

• To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
• To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'.

The type of chart to display. XY charts have numerical x- and y-axes. The x values may optionally be time-based. See the timeSeries parameter.

Available values:

• Standard charts - pie, bar, line, area
• XY plots – xyArea, xyBar, xyLine, xyStep, xyStepArea, scatter, timeSeries
• Other charts – gantt (beta)

The display orientation. Applies to area, bar and line charts.

Available values:

• vertical –  y-axis is vertical
• horizontal –  x-axis is vertical

Show in three dimensions. Applies to area, bar and line charts.

• 75 percent for 3D charts
• 50 percent for non-stacked area charts
• 100 percent for all other charts

Determines whether to display the body of the macro, consisting of the data table. By default, the chart data table is not displayed.

Available values:

• false – the data is not displayed.
• true or after –  the data is displayed after the chart.
• before – the data is displayed before the chart.

The image format to be used for the chart.

Available values:

• png
• jpg

The content orientation. By default, the data tables will be interpreted as columns (horizontally) representing domain and x values.

Available values:

• vertical  –  data table columns will be interpreted as series.
• horizontal – data tables rows will be interpreted as series.

If 'true', the x values in an XY plot will be treated as time series data and so will be converted according date formats.

The time period for time series data. Defines the granularity of how the data is interpreted.

Available values: millisecond, second, minute, hour, day, week, month, quarter, year

Use in combination with the country parameter to form a locale. These additional number and date formats will be used for data conversion before the default languages.

Available values are the two-character ISO 639-1 alpha-2 codes.

Determines whether the macro will forgive (allow) some data formatting errors.

Available values:

• true — the macro tries to convert numeric and date values that do not totally match any of the default or user-specified formats.
• false — the macro enforces strict data formatting. If there are data format errors, the chart will not be produced.

Placement of the axis label text for categories.

Available values:

• up45 — 45 degrees going upward
• up90 — 90 degrees going upward
• down45 — 45 degrees going downward
• down90 — 90 degrees going downward

Placement of the date tick mark.

Available values:

• start — tick mark is at the start of the date period.
• middle — tick mark is in the middle of the date period.
• end — tick mark is at the end of the date period.

• %0% is replaced by the pie section key.
• %1% is replaced by the pie section numeric value.
• %2% is replaced by the pie section percent value.

Example 1: To display something like 'Independent = 20':

%0% = %1%

Example 2: To display something like 'Independent (20%)':

%0% (%2%)

The name and location where the chart image will be saved as an attachment. The user must be authorised to add attachments to the page specified.

Available syntax for this parameter:

• ^attachmentName.png — the chart is saved as an attachment to the current page.
• page name^attachmentName.png — the chart is saved as an attachment to the page name provided.
• spacekey:page name^attachmentName.png — the chart is saved as an attachment to the page name provided in the space indicated.

Defines the the versioning mechanism for saved charts.

Available values:

• new — creates new version of the attachment.
• replace — replaces all previous versions of the chart. To replace an existing attachment, the user must be authorised to remove attachments for the page specified.
• keep — only saves a new attachment if an existing export of the same name does not exist. An existing attachment will not be changed or updated.

 If true, the chart image attachment will be shown as a thumbnail (small, expandable) image.

Determines the sort order of the list of child pages.

Available values:

• creation – Sort by the date on which the page was created.
• title – Sort alphabetically by page name.
• modified – Sort by the date on which the page was last updated.

A heading style to be applied to the list of child pages.

Available values: h1 (heading level 1) through to h6 (heading level 6).

The name of the parent page. The macro will display the children of the specified page.

To specify a page in a different space, use a space key followed by a colon. For example:
MYSPACE:My page

If the value of this parameter is a forward slash (/) the macro will list the pages at the root of the current space. In other words, the pages without parents.

If true, Confluence will display all levels of child pages. This setting will override the depth setting.

Specifies the colour scheme used for displaying your code. Many of these themes are based on the default colour schemes of popular integrated development environments (IDEs). The default theme is Confluence (also known as Default), which is typically black and coloured text on a blank background.

Available themes:

• DJango
• Emacs
• FadeToGrey
• Midnight
• RDark
• Eclipse
• Confluence (same as default)


If true, a line number will be shown to the left of each line of code. Numbering is incremented by 1.

If false, no line numbers are shown.

Specifies the language (or environment) for syntax highlighting.

• (none) — that is, no syntax highlighting
• actionscript3
• bash
• csharp — that is, C#
• coldfusion
• cpp — that is, C++
• css
• delphi
• diff
• erlang
• groovy
• java
• javafx
• javascript
• perl
• php
• powershell
• python
• ruby
• scala
• sql
• vb — that is, Visual Basic
• html/xml

If true, the code macro's content will be collapsed upon visiting or refreshing the Confluence page. Clicking the 'expand source' link allows you to view the content.

If false, the code macro's content is always displayed in full.

Code block macro with a body and optional title, line numbers and language parameters defined

width

Filters the results by space. The macro will display only the pages and other content types which belong to the space(s) you specify here.

You can specify one or more space keys, separated by a comma or a space.

• To exclude content in a specific space, put a minus sign (-) immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE.
• To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.)

Special values:

Filters the results by author. The macro will display only the pages and other content types which are written or updated by the author(s) you specify here.

You can specify one or more authors, separated by a comma.

• title — Sort alphabetically by title.
• creation — Sort by the date on which the content was added.
• modified — Sort by the date on which the content was last updated.

• To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
• To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'.

To exclude content of a given content type, put a minus sign (-) immediately in front of that content type. For example: If you specify a content type of -blogpost you will get pages and all other content except for blog posts.

Available values:

• page — ages.
• blogpost or news — blog posts, also known as news items.
• attachment – attachments.

default-parameter

(Unnamed in wiki markup)

maxResults

limit

(None)

Limits the number of contributors displayed in the list.

spaces

Current space

Specifies the space key of the Confluence space to search. Space keys are case sensitive.

Special values:

• @global — All site spaces.
• @personal — All personal spaces.
• @all — All spaces in the Confluence site.

You can specify one or more space keys or special values, separated by commas.

If no page and labels are specified, all pages from the specified set of spaces are included.

reverse

false

Reverses the order of contributors in the list. Must be used in conjunction with the order parameter.

scope

The specified page only

Specifies additional pages to include when generating the list of contributors.

Available values:

• children – only the child pages of the specified page.
• descendants – all descendants of the specified page.

labels

(None)

Limits the list of contributors to those who created the specified labels on a page. You can specify one or more labels, separated by commas.

false

If the value is true, the macro will display a list of the pages used to generate the list of contributors.

"No contributors found for:" (and a summary of selected parameter values)

Any message given here will override the default message that is displayed when no contributors are found.

showCount

false

Determines whether the macro will show the number of times each person made a contribution.

contentType

Both pages and blog posts

Restricts the content type that the macro will use when generating the list of contributors.

Available values:

• pages – pages

• blogposts – blog posts.

include

authors

Filters by either the type of contribution made to a page (and optionally its descendant pages), or the watches on the page. Contribution types are:

• authors - includes people who created or have edited the page(s)
• comments - includes people who have added comments to the page(s)
• labels - includes people who have added labels to the page(s)
• watches - includes people who are watching the page(s).

You can specify one or more contribution types, separated by commas.

mode

inline

Determines how the list of contributors is formatted:

• inline — a comma-separated list
• list — a bullet list.

showAnonymous

false

Determines whether to include those who contributed anonymously to a page.

order

count

Specifies the criteria used to sort contributors. Sort criteria are:

• count – sorts the names based on the total number of contributions to the page(s)
• name – sorts the names into alphabetical order
• update – sorts the names by the date of their last contribution to the page(s).

page

The current page

Specifies the page to use when generating the list of contributors. If page and spaces are left blank, the current page is assumed.

showLastTime

false

Determines whether to show the last time each person made a contribution.

publishDate

(None)e

Specifies the publication date for a blog post. The date format required is: YYYY/MM/DD.

limit

(None)

Limits the number of contributors or pages displayed in the table.

spaces

Current space

Specifies the space key of the Confluence space to search. Space keys are case sensitive.

Special values:

• @global — All site spaces.
• @personal — All personal spaces.
• @all — All spaces in the Confluence site.

You can specify one or more space keys or special values, separated by commas.

If no page and labels are specified, all pages from the specified set of spaces are included.

reverse

false

Reverses the order of items in the table. Must be used in conjunction with the order parameter.

showAnonymous

false

Determines whether to include those who contributed anonymously to a page.

scope

The specified page only

Specifies additional pages to include when generating the list of contributors.

Available values:

• children – only the child pages of the specified page.
• descendants – all descendants of the specified page.

order

edits

Sets the criterion used for sorting items in the table.

Available values:

• edits – sorts items in the table based on the total number of edits made, either by a contributor or to a page.
• name – sorts items in the table in alphabetical order, either by contributor or page name.
• editTime – sorts items in the table based on when the contributor last edited a page (or a specified set of pages) or when the page was lasted edited.
• update – sorts items in the table based on when the contributor last made any contribution to a page (or a specified set of pages) or when the page last had any contribution made to it.

page

The current page

A page title. Specifies the page to use when generating the list of contributors. If page and spaces are left blank, the current page is assumed.

labels

(None)

Limits contribution-based statistics to the specified labels only. You can specify one or more labels, separated by commas.

columns

edits,comments,labels

Determines the columns that should appear in the table. The statistics or type of information presented depends on the groupby parameter.

Available values:

• edits – the number of times each contributor has edited the page(s) or the number of edits made to each page.
• edited – a list of the pages edited by each contributor or a list of contributors who have edited each page.
• comments – the number of times each contributor has added comments to the page(s) or the number of comments on each page.
• commented – a list of pages to which each contributor has added comments or a list of contributors who have commented on each page.
• labels – the number of times each contributor has added labels to the page(s) or the number of labels on each page.
• labeled – a list of pages to which each contributor has added labels or a list of contributors who have added a label to each page.
• labellist – a list of labels either added by each contributor or on each page.
• watches – the number of pages being watched by each contributor/person or the number of contributors/people watching each page.
• watching – a list of pages being watched by each contributor/person or a list of contributors/people watching each page.
• lastupdate – the last time each contributor made an update or when each page was last updated. Valid updates can include edits, comments or label modifications to a page.

You can specify one or more columns, separated by commas.

groupby

Specifies the basis for grouping contribution-based statistics:

• contributors – group by the people who have contributed.
• pages – group by the pages used to find the contributors.

contentType

Both pages and blog posts

Restricts the content type that the macro will use when generating the list of contributors.

Available values:

• pages – pages

• blogposts – blog posts.

publishDate

(None)

Specifies the publication date for a blog post. The date format required is: YYYY/MM/DD.

templateId

templateName

Determines the size of the 'create space' icon displayed. Available values:

• large
• small

Natural size of icon

(1:1 pixel ratio)

The width of the icon to be displayed, specified in pixels. Confluence will stretch or shrink the width of the icon to the number of pixels specified.

Note: This parameter is not available via the macro browser.

Natural size of icon

(1:1 pixel ratio)

The height of the icon to be displayed, specified in pixels. Confluence will stretch or shrink the height of the icon to the number of pixels specified.

Note: This parameter is not available via the macro browser.

default-parameter

(Unnamed in wiki markup)

The name of the page that contains the excerpt to be displayed.

To include an excerpt from a page in another space, type the space key followed by a colon (:) and the page name, like this:

SPACEKEY:My page name

Note: The ability to include excerpts from other spaces is available only in Confluence 4.3.2 and later. In earlier versions of Confluence, the Excerpt Include macro does not work across spaces. Use the Include Page macro instead.

Determines whether the content of the Excerpt macro body is displayed on the page that contains the Excerpt macro.

Note that this option affects only the page that contains the Excerpt macro. It does not affect any pages where the content is reused.

Determines whether the content of the Excerpt macro body is displayed on a new line or inline.

Available values:

• BLOCK – Displays the content of the macro on a new line.

• INLINE – Displays the the content of the macro as part of the same paragraph as the text preceding and following it.

Note that this option affects only the page that contains the Excerpt macro. It does not affect any pages where the content is reused.

default-parameter

(Unnamed in wiki markup)

width

• Width in pixesl, using px or plain numbers. For example, 500px or 500
• A percentage of the page width, using %. For example, 50%
• Automatic resizing of the gadget to fit 100% of the page width: auto

title

(None)

Specify a title to be displayed above your gallery of pictures.

reverse

Not specified. Sort order is ascending.

Used in combination with the sort parameter, to change the sort order from ascending to descending.

Available values:

• true – Sort order is descending.
• false – Sort order is ascending.

sort

None. The sort order is unspecified and therefore unpredictable.

Specify an attribute to sort the images by. Sort order is ascending, unless you specify the reverse parameter.

Available values:

• name – file name.
• comment – comment linked to the attached file.
• date – date/time last modified.
• size – size of the attached file.

page

If no page is specified, the gallery macro displays the images attached to the page on which the macro is used.

No exclusions. The gallery will include all the pictures on the page.

columns

4

Specify the number of columns for the table that forms the gallery.

exclude

No exclusions. Include all the pictures on the page.

Specify images by file name. The gallery will ignore any images specified. You can specify more than one image, separated by commas.
Note: The file name and file type for this parameter are case sensitive. For example, 'my picture.PNG' will not be recognised as 'my picture.png'.

include

Include all the pictures on the page.

If you specifically include one or more pictures, the gallery will show only those pictures. You can specify more than one picture, separated by commas.
Note: The file name and file type for this parameter are case-sensitive. For example, 'my picture.PNG' will not be recognised as 'my picture.png'.

width

99%

Specify the width of the table in which the links are displayed, as a percentage of the window width.

url

(None)

Specify a URL of the content to be included into your Confluence page.

showid

true

Determines whether the macro shows or hides the user ID of the contact.

Available values:

• true – User ID is shown on the page.
• false – User ID is not shown on the page.

service

Not specified.

The web service that Confluence should query.

Available values:

• aim – AOL Instant Messenger
• gtalk – Google Talk
• icq – ICQ
• jabber – Jabber
• msn – MSN Instant Messenger
• sametime – IBM Lotus Sametime
• skype – Skype
• skypeme – Skype
• wildfire – Openfire Server
• yahoo – Yahoo! Messenger

default-parameter

(Unnamed in wiki markup)

default-parameter

(Unnamed in wiki markup)

The name of the page whose content should be included on the current page

To includecontent from a page in another space, type the space key followed by a colon (:) and the page name, like this:

SPACEKEY:My page name

To include a blog post, specify the date as well as the title of the blog post. For example: /2010/12/01/My blog post.

You can include pages from personal spaces using ~username as the space key, where 'username' is the person's username. For example, ~jsmith:My page name.

Info macro with a body defined and no optional parameters

Info macro with with a body and an optional Title parameter defined

Info macro with a body and optional Title and Icon parameters defined

anonymous

No

false

If this parameter is set to 'true', JIRA will return only the issues which allow unrestricted viewing. That is, the issues which are visible to anonymous viewers, as determined by JIRA's viewing restrictions. If this parameter is omitted or set to 'false', then the results depend on how your administrator has configured the communication between JIRA and Confluence. By default, Confluence will show only the JIRA issues which the user is authorised to view.

Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter.

baseurl

No

The value of the 'url' parameter

If you specify a 'baseurl', then the link in the header, pointing to your JIRA site, will use this base URL instead of the value of the 'url' parameter. This is useful when Confluence connects to JIRA with a different URL from the one used by other users.

columns

No

By default, the following columns are shown:

• type
• key
• summary
• assignee
• reporter
• priority
• status
• resolution
• created
• updated
• due

A list of JIRA column names, separated by semi-colons (;). You can include any columns recognised by your JIRA site, including custom columns. See the JIRA documentation for a list of names.

count

No

false

If this parameter is set to 'true', the issue list will show the number of issues in JIRA. The count will be linked to your JIRA site.

cache

No

on

The macro maintains a cache of the issues which result from the JIRA query. If the 'cache' parameter is set to 'off', the relevant part of the cache is cleared each time the macro is reloaded. (The value 'false' also works and has the same effect as 'off'.)

Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter.

height

No

480 (if render mode is dynamic)


The height in pixels of the table displaying the JIRA issues.
Note that this height specification is ignored in the following situations:

• If the 'renderMode' parameter (see below) is set to 'static'.
• When the JIRA issues are displayed in a PDF or Word document, in an email message or in an RSS feed.

Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter.

renderMode

No

static

If the value is 'dynamic', the JIRA Issues macro offers an interactive display which people can manipulate as follows:

• Click the column headers to sort the output.
• Drag and drop the columns into a different order.
• Temporarily remove a column from the display.
• View a page of issues at a time, for faster response times.

A value of 'static' will disable the dynamic display features.

Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter.

url

Yes

none

The URL of the XML view of your selected issues in JIRA Issue Navigator.

Note: If the URL in the 'url' parameter does not contain a tempMax argument, then the value of tempMax will default to 500. If your JIRA server is version 3.12 or earlier, this means that the JIRA Issues macro will return a maximum of 500 issues. If your JIRA server is version 3.13 or later, a value of 500 means that the JIRA Issues macro will return a maximum of 500 issues per page.

width

No

100%

The width of the table displaying the JIRA issues. Can be indicated either as a percentage (%) or in pixels (px).

Note: This parameter is available only if you insert the macro via wiki markup or by editing the storage format of the page. The graphic user interface (macro browser) for the JIRA Issues macro does not offer this parameter.

directory

(None)

URL of a directory containing your test result files. This must be a directory name and not the XML file itself. Overrides the url parameter if you use both.

Note: When using a local drive, you must use a directory name and not the XML file itself.

reportdetail

all

Level of detail required in the report.

Available values:

• all
• fixture
• summary
• failuresonly

url

(None)

URL of a particular test result XML file.

This parameter is overridden by the directory parameter if you use both.

For Confluence installations that require authentication, you can specify login credentials as part of this parameter, in the form of URL parameters:

• os_username — The username of a Confluence user with permission to access the JUnit test results.
• os_password — The password of the Confluence user specified in the os_username parameter.

debug

false

If the value of this parameter is true, the report will show the content of failures, as well as the error messages.

spaceKey

Current space

placeholder

(None)

spaceKey

All spaces

default-parameter

(No name in wiki markup)

3

page

No

Current page

Name of the page to which the multimedia file is attached.

space

No

Current space

Space key of the page that has the multimedia file attached.

name

Yes

None

File name of the multimedia file, which is attached to a Confluence page.

width

No

If not specified, the browser will determine the width based on the file type.

Width of the movie window to be displayed on the page. By default, this value is specified in pixels. You can also choose to specify a percentage of the window's width, or any other value accepted by HTML.

height

No

If not specified, the browser will determine the height based on the file type.

Height of the movie window to be displayed on the page. By default, this value is specified in pixels. You can also choose to specify a percentage of the window's height, or any other value accepted by HTML.

autostart

No

false

If the parameter is set to true then the video or audio file will start playing as soon as the page is loaded. If this option is set to false then the file will not play until the user clicks the icon or image on the page.

default-parameter

(Unnamed in wiki markup)

wrapAfter

No

5

The number of cells in a row.

title

No

(None)

A title for the navigation map.

cellHeight

No

60

Height of the cells, in pixels.

cellWidth

No

90

Width of the cells, in pixels.

theme

No

(None)

Not applicable to Confluence OnDemand.

The name of a Velocity template that defines a theme for the navigation map.

The name of your theme file must have the following format: navmap-mytheme.vm,  where mytheme is the name of your theme. That is also the value to use for the theme parameter of the macro. For example, if your theme file is navmap-roundededges.vm, use the value roundededges for this parameter.

Put your theme file in the confluence/WEB-INF/classes/templates/macros directory, in your Confluence installation. (Create the directory if it does not exist.)

default-parameter

(Unnamed in wiki markup)

The display mode, which determines the set of users to be listed, based on their relationship to the specified user:

• following – those whom the user is following.
• followers – those who are following the user.

username


No

Current user's username

The username of the Confluence user whose network interactions you wish to show.

max

No

30

The maximum number of users to show. If the number of users exceeds the specified maximum, then the macro provides a 'Show All' link. This link leads to the specified user's network view, showing the complete list of network interactions.

theme

No

full

Determines how the user's network is displayed:

• full – Shows a large version of user's profile pictures. If the display mode is set to  'following', the macro offers the option to follow more users.
• tiny – Shows only the small version of user's profile pictures.

Determines whether the macro draws a box around the content.

Available values:

• true – Box is removed. In other words, there is no panel.
• false – Box is drawn. In other words, there is a panel.

Determines whether an icon appears next to the title. The icon is an exclamation mark inside a yellow triangle.

Available values:

• true – the icon appears
• false – the icon does not appear

The file name of the Excel spreadsheet to be displayed. The document must be attached to a page on your Confluence site.

The number of the last column you want displayed, starting from '0' as the first column.

Hint for reducing the size of the spreadsheet: Use the col and row parameters to reduce the size of the spreadsheet displayed on the wiki page. This is especially useful to prevent the display from showing empty cells. This will also help to prevent 'out of memory' errors.

Determines whether the macro will show borders around the cells in the spreadsheet.

Accepted values:

• true – Shows borders.
• false – Does not show borders.

The file name of the PowerPoint presentation to be displayed. The document must be attached to a page on your Confluence site.

The file name of the Word document to be displayed. The document must be attached to a page on your Confluence site.

Determines whether the page tree will show excerpts from each page. The excerpts must be defined on the individual pages by the Excerpt macro.

Available values:

• true – Show excerpts.
• false – Do not show excerpts.

Determines whether the macro will offer the 'expand all' and 'collapse all' options at the top of the page tree. Your readers can click these links to open or close all branches of the tree at once.

Available values:

• true – Show the 'expand all' and 'collapse all' options.
• false – Do not show the options.

Used in combination with the sort parameter. Determines the order of pages displayed in the tree, by reversing the default (ascending) order.

Available values:

• true – Pages will be displayed in descending order by title.
• false – Pages will be displayed in ascending order by title.

Specifies the parent page for the page tree. The tree will include all children of the given page, plus their children and grand-children, and so on. The tree will not include the root page itself.

Available values:

• A page title – to specify a page name for the parent or root of the tree. The tree will include all children and grand-children of the specified root. The tree will not include the specified root page itself.
• @home – will include all pages under the home page of the space (default).
• @self – will include all pages under the current page.
• @parent – will include all pages under the parent of the current page, including the current page.
• @none – will include all pages in the space, including orphaned pages and the home page.

Determines whether the macro will offer a search box above the page tree. The search box allows your readers to enter a search term, and then searches within the page tree for the specified value.

Available values:

• true – Include the search box.
• false – Do not include the search box.

Determines the order in which pages are displayed in the tree. This sort order is for display purposes only. It does not permanently re-arrange the page order.

Available values:

• bitwise – sort alphabetically, for example: title1, title10, title2.
• creation – sort by date of creation.
• modified – sort by order of date last modified.
• natural – sort in 'natural' alphabetical order, for example: title1, title2, title10.
• position – sort by the default Confluence sorting rules. If your pages have been ordered manually, this sort will respect the defined order. Otherwise the pages will be displayed in the 'natural' alphabetical order, such as: title1, title2, title10.

Indicates how many levels of children the tree should show when it opens for the first time.

Available values: Any number greater than 0.

Specifies the parent page for the page tree. The tree will include all children of the given page, plus their children and grand-children, and so on. The tree will not include the root page itself.

Note: Unlike the Page Tree macro, the Page Tree Search macro does not accept the special values that start with an @ sign, such as @home or @self.

The style of the panel's border.

Accepted values:

• solid
• dashed
• Other valid CSS border styles.

The file name of the PDF document to be displayed. The document must be attached to a page on your Confluence site.

Determines how the macro displays the labels.

Accepted values:

• list – displays the labels as a bullet list, ordered by popularity (highest first).

• heatmap – displays the labels using different font sizes for each label depending on the label's popularity, ordered alphabetically by label name.

Filters content by space. The macro will display only the pages and other content which belong to the space(s) you specify here.

Accepted values:

• One or more space keys, separated by commas.
• An asterisk (*) means all spaces.

Filters by username of the user who updated the content. The macro will only display content created and updated by the user(s) you specify here.

You can specify one or more usernames separated by commas.

Determines whether the macro displays profile pictures of the users who updated the content.

Accepted values:

• true – the macro will show profile pictures.
• false – the macro will not show profile pictures.

Filters content by label. The macro will display only the pages and other content which are tagged with the label(s) you specify here. You can specify one or more labels, separated by commas.

Note: If there are no pages matching any of the specified labels, then Confluence will ignore the labels and will list all recently updated pages, as well as showing a message, "These labels don't exist and were ignored: xxx ".

Filters content by type. You can specify one or more types, separated by commas.

Accepted values:

• page
• blogpost or news
• spacedesc
• attachment
• comment
• mail
• userinfo

Filters content by space. The macro will display only the pages and other content which belong to the space(s) you specify here.

• To exclude content in a specific space, put a minus sign (-) immediately in front of that space key. For example: If you specify a space key of -BADSPACE you will get only content which is not in the BADSPACE.
• To indicate that the results must come from a specific space, put a plus sign (+) immediately in front of that space key. For example: If you specify a space key of +GOODSPACE you will get only content in GOODSPACE. (Note that this is not particularly useful, because each content item belongs to one space only. If you put a plus sign next to one space key and list other space keys too, the other space keys will be ignored.)

Special values:

Filters by the username of the user who updated the content. The macro will only display content created and updated by the user(s) you specify here.

The maximum number of results to be displayed.

The theoretical maximum value that this parameter can accept is 2 to the power of 31, minus 1 (or 2147483647). But this maximum is limited to 200 in the code, for performance reasons. More details are in this issue:  CONF-19096

Determines whether the macro hides or displays the text 'Recently Updated' as a title above the list of content.

Accepted values:

• true – Title is hidden.
• false – Title is shown.

Choose the appearance of the macro.

Accepted values:

• concise – The default list, showing the names of pages which were updated or commented on, the users who made the page modifications, and time when the modifications occurred.
• social – Shows recent modifications in reverse chronological order, grouped by user in short time segments. A sub list appears within each user's time segment, showing the names of pages which they updated or commented on and the time when these modifications occurred.
• sidebar – Lists recent updates in reverse chronological order, showing the names of pages which were updated or commented on and time when the page modifications occurred. This theme does not show authorship.

Determines whether the macro displays profile pictures of the users who updated the content.

Accepted values:

• true – the macro will show profile pictures.
• false – the macro will not show profile pictures.

Filters content by label. The macro will display only the pages and other content which are tagged with the label(s) you specify here. You can specify one or more labels, separated by commas.

Note: If there are no pages matching any of the specified labels, then Confluence will ignore the labels and will list all recently updated pages, as well as showing a message, "These labels don't exist and were ignored: xxx ".

Filter the results by label. The macro will display only the pages etc which are tagged with the label(s) you specify here.

You can specify one or more label values, separated by a comma or a space.

• To exclude content which matches a given label, put a minus sign (-) immediately in front of that label value. For example: If you specify a label value of -badpage you will get only content which is not labelled with 'badpage'.
• To indicate that the results must match a given label value, put a plus sign (+) immediately in front of that label value. For example: If you specify a label value of +superpage,+goodpage you will get only content which has at least two labels, being 'superpage' and 'goodpage'.

Filters content by type. You can specify one or more types, separated by commas.

To exclude content of a given content type, put a minus sign (-) immediately in front of that content type. For example: If you specify a content type of -blogpost you will get pages and all other content except for blog posts.

Available values:

• page — Pages.
• blogpost or news — Blog posts, also known as news items.
• comment — Comments on pages and blog posts.
• attachment — Attachments.
• status — Status updates made by other users.

The scope of labels to be displayed in the list.

Accepted values:

• global – All spaces (non-personal) in the Confluence installation.
• space – The current space.
• personal – Your own personal space.

The style of the list of labels:

• list – Displays the list of labels horizontally.
  
• table – Includes additional information such as the page to which the label was added and the user who added it.

Determines whether the macro will show only the titles of the news items, or the titles plus content.

Accepted values:

• true – Displays titles only.
• false – Displays titles and content.

Determines whether the macro will show a title above the list of news items.

Accepted values:

• true – Displays the title.
• false – Does not display a title.

Defines a period of time in weeks, days, hours and/or minutes. The macro will display the content modified within that time frame.

The search terms which this macro will use to generate its results.

You can refine your search query by using operators such as 'AND' and 'OR'. For example: my_term1 AND my_term2

For more information, take a look at the documentation on the Confluence search syntax.

The type of content to include in the search results.

Accepted values:

• page
• comment
• blogpost
• attachment
• userinfo – the content of user profiles
• spacedesc – the content of space descriptions

border

Determines whether or not the filter panel is shown. If you select this option, people viewing the page will be able to filter the list of attachments by file type (extension) and by label.

Accepted values:

• true – Macro displays the filter panel.
• false – Macro does not display the filter panel.

default-parameter

(Unnamed in wiki markup)

Specify the view from which spaces are listed.

Accepted values:

• all – All spaces in the Confluence site.
• category – Spaces grouped according to space categories.
• favourite – Spaces in the reader's list of favourites.
• new – Spaces created within the last 7 days.

The colour of the lozenge.

Accepted values: Grey, Red, Yellow, Green, Blue

The style of the lozenge and its border.

Accepted values:

• false – The lozenge will have the default style: a solid coloured background with white text.
• true – The lozenge will have the outline, or subtle, style: a white background with a coloured border and coloured text.

• none – No list style is displayed.
• circle –  The list style is a circle.
• disc – The list style is a filled circle. This is the typical bullet list, and is the one we are using in this example list.
• square — The list style is a square.
• decimal — The list is numbered (1, 2, 3, 4, 5).
• lower-alpha — The list style is lower case, alphabetised (a, b, c, d, e).
• lower-roman — The list style is lower-case roman numerals (i, ii, iii, iv, v, vi).
• upper-roman — The list style is upper-case roman numerals (I, II, III, IV, V, VI).

This parameter applies to vertical lists only (type = list). 

Use this parameter to indent the list items according to CSS quantities. For example, a value of 10px will successively indent list heading groups by 10 pixels. Level 1 headings will be indented 10px, and level 2 headings by an additional 10px, and so on.

Specifies the headings to exclude by pattern matching. The value must be a regular expression. If this parameter is specified, the table of contents will include only the headings that match the regular expression. Example: .*\.[1//2]

Defines the overall format of the table of contents.

Available values:

• list – displays the table of contents in a vertical list.
• flat – displays a horizontal series of links. For example: [Heading 1] [Heading 2] [Heading 3].

This parameter applies to flat lists only (type = flat).  Use this parameter to style the display of a flat list. 

Available values:

• brackets – Each item is enclosed by square brackets: [ ].
• braces  – Each item is enclosed by braces: { }.
• parens – Each item is enclosed by parentheses: ( ).
• pipe – The items are separated by a pipe: |
• anything – The items are separated by the value you enter. You can enter any text as a separator, for example ***. If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters.

Specifies the headings to include by pattern matching. The value must be a regular expression. If this parameter is specified, the table of contents will ignore any headings that do not match the regular expression. Example: .*\.[1//2]

 See Sun's Regex documentation for examples of constructing regular expression strings.

Determines where the macro will display the table of contents, relative to the zone delineated by the macro.

Accepted values:

• top – The table of contents appears at the start of the zone.
• bottom – The table of contents appears at the end of the zone.
• both – The table of contents appears at the start and end of the zone.

• none – No list style is displayed.
• circle –  The list style is a circle.
• disc – The list style is a filled circle. This is the typical bullet list, and is the one we are using in this example list.
• square — The list style is a square.
• decimal — The list is numbered (1, 2, 3, 4, 5).
• lower-alpha — The list style is lower case, alphabetised (a, b, c, d, e).
• lower-roman — The list style is lower-case roman numerals (i, ii, iii, iv, v, vi).
• upper-roman — The list style is upper-case roman numerals (I, II, III, IV, V, VI).

This parameter applies to vertical lists only (type = list). 

Use this parameter to indent the list items according to CSS quantities. For example, a value of 10px will successively indent list heading groups by 10 pixels. Level 1 headings will be indented 10px, and level 2 headings by an additional 10px, and so on.

Specifies the headings to exclude by pattern matching. The value must be a regular expression. If this parameter is specified, the table of contents will include only the headings that match the regular expression. Example: .*\.[1//2]

Defines the overall format of the table of contents.

Available values:

• list – displays the table of contents in a vertical list.
• flat – displays a horizontal series of links. For example: [Heading 1] [Heading 2] [Heading 3].

This parameter applies to flat lists only (type = flat).  Use this parameter to style the display of a flat list. 

Available values:

• brackets – Each item is enclosed by square brackets: [ ].
• braces  – Each item is enclosed by braces: { }.
• parens – Each item is enclosed by parentheses: ( ).
• pipe – The items are separated by a pipe: |
• anything – The items are separated by the value you enter. You can enter any text as a separator, for example ***. If using a custom separator, be aware that text displays exactly as entered, with no additional white space to further separate the characters.

Specifies the headings to include by pattern matching. The value must be a regular expression. If this parameter is specified, the table of contents will ignore any headings that do not match the regular expression. Example: .*\.[1//2]

 See Sun's Regex documentation for examples of constructing regular expression strings.

title

Determines whether the macro allows users to lock individual tasks so that they cannot be changed.

Accepted values:

• true – The task list offers the option to lock tasks.
• false – There is no option to lock a task.

Determines whether Confluence will ask the user to confirm the deletion of a task.

Accepted values:

• true – Asks for confirmation before deleting a task.
• false – Deletes the task without asking for confirmation.

One or more groups containing the Confluence users that the macro will list.

Accepted values:

• A comma-separated list of group names.

• * (an asterisk – The macro will list all users registered on the Confluence site.

Instructs the macro to differentiate between online and offline users.

Accepted values:

• Unspecified – The macro will show all registered users.
• true – The macro will show only online users.
• false – The macro will show only offline users.

Note: In order to make this parameter functional, a System Administrator needs to enable the User Log In Listener for your Confluence site. Not applicable to Confluence OnDemand.

The username of the Confluence user whose profile summary you wish to show.

The username of the Confluence user whose status updates you wish to show.