Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space). Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page.

Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space) where the link text is different from the actual hyperlink link. Also you can have an optional link tip which will appear as tooltip. Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page.

Creates an internal hyperlink to the specified blog post in the desired space (or the current one if you don't specify any space). You must specify the date the post was made in /year/month/day form as shown. Anchors and link text can be added the same way as described above.

If you attempt to link to a blog post that doesn't exist, no link will be created.

Creates an internal hyperlink to a view of a whole day's blog. Specify the date you wish to link to as year/month/day. Link titles can be supplied as with other links. It is possible to link to days with no blog posts on them: the destination page will just be empty.

Creates a link to the space homepage, or space summary page of a particular space. Which of these the link points to depends on the configuration of the space being linked to. If the space does not exist, the link will be drawn with a strike-through to indicate it is an invalid space.

Creates a link to the user profile page of a particular user. By default, will be drawn with a user icon and the user's full name, but if you supply a custom link text, the icon will not be drawn. If the user being linked to does not exist, the link will be drawn with a strike-through.

Creates a bookmark anchor inside the page. You can then create links directly to that anchor. So the link [My Page#here] will link to wherever in "My Page" there is an {anchor:here} macro, and the link [#there] will link to wherever in the current page there is an {anchor:there} macro.

Lists

Lists allow you to present information as a series of ordered items.

Notation

Comment

* some * bullet ** indented ** bullets * points

A bulleted list (must be in first column). Use more (**) for deeper indentations.

Example:

some

bullet

indented

bullets

points

- different - bullet - types

A list item (with -), several lines create a single list.

Example:

different

bullet

types

# a # numbered # list

A numbered list (must be in first column). Use more (##, ###) for deeper indentations.

The Dynamic Tasklist Macro displays a task list which can be modified in the page as it is viewed. Despite the fact that this plugin has an ajax UI, it is still fully versioned like a normal Confluence page.

showAssignee - (optional) If set to true the assignee will be shown in the tasks.

width - (optional) The width of the tasklist (default is 640px). To set the width to 400 pixels, set the parameter value to 400px.

enableLocking - (optional) If set to true, tasks can be locked so other users can not modify.

autoLockOnComplete (optional) Used in conjunction with enableLocking. Tasks will auto lock when it is completed.

promptOnDelete - (optional) If set to false there will not be any confirmation prompt when deleting a task.

Example:

What you need to type

What you will get

{dynamictasklist:Arthurs To-Do's}

{rate}

The {rate} macro allows visitors to rate various aspects of your content
Examples:

Displays a dynamic table. Rows are added to the table and updated while viewing the page.

Parameter are the name of the table and optional title. Make sure you don't have two
tables in the same page with the same name.

Example:

Images

Images can be embedded into Confluence pages from attached files or remote sources.

Notation

Comment

!http://www.host.com/image.gif!
or
!attached-image.gif!

Inserts an image into the page.

If a fully qualified URL is given the image will be displayed from the remote source, otherwise an attached image file is displayed.

!spaceKey:pageTitle^image.gif!

!/2007/05/23/My Blog Post^image.gif!

Inserts an image that is attached on another page or blog post.

If no space key is defined, the current is space is used by default.

!image.jpg|thumbnail!

Insert a thumbnail of the image into the page (only works with images that are attached to the page). Users can click on the thumbnail to see the full-sized image.

Thumbnails must be enabled by the site administrator for this to work.

!image.gif|align=right, vspace=4!

For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so.

{gallery}

{gallery:columns=3}

{gallery:title=Some office photos, and a waterfall|columns=3}

{gallery:title=Some office photos, without the waterfall|exclude=waterfall.jpg}

{gallery:title=One office photo, and a waterfall|include=office1.jpg,waterfall.jpg}

{gallery:title=Some office photos, and a waterfall|page=Gallery of Pictures}

{gallery:title=Some office photos, and a waterfall|page=DOC:Gallery of Pictures}

{gallery:title=Some office photos, and a waterfall|sort=name}

{gallery:title=Some office photos, and a waterfall|sort=date|reverse=true}

Create a gallery of thumbnails of all images attached to a page. This will only work on pagesthat allow attachments, obviously.

The title parameter allows you to supply a title for the gallery

The columns parameter allows you to specify the number of columns in the gallery (by default, 4)

The exclude parameter allows you to specify the name of attached images to ignore (i.e., they will not be included in the gallery). You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif

The include parameter allows you to specifically include one or more attached images. The gallery will show only those pictures. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif

The page parameter allows you specify the title of one or more pages which contains the images you want displayed. If a page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro. You can specify more than one page, separated by commas. Example: page=Image Gallery,STAFF:Group Photos

If a page or attachment file name contains a comma, you can use it in the include, exclude, or page parameters by enclosing it in single or doublequotes. Example: include="this,that.jpg",theother.png

The sort parameter allows you to control the order of the images. The options are name,comment, date, or size.

The reverse parameter is used in conjunction with the sort parameter to reverse the order of the specified sort. Valid values are true and false.

Previous versions of the Gallery macro had an additional slideshow parameter. This is no longer used in the latest version, and the slide show is always enabled. We have left the parameter here for compatibility with older versions of the macro.

Tables

Tables allow you to organise content in a rows and columns, with a header row if required.

If you want to use columns instead of tables, you can define them first by marking a {section}, and then placing any number of {column}s inside.

border: - (optional) set to "true" to draw a border around the section and columns.

{table-filter:column=Last Name}

{table-filter:column=Last Name, City}

{table-filter:column=Last Name, City|userfilter=Occupation}

{table-filter:column=Last Name|cell-width=100}

{table-filter:column=Last Name|button=true}

{table-filter:column=Last Name|hidelabels=true}

{table-filter:column=City|default=New York}

{table-filter:column=Last Name, City|default= , New York}

{table-filter:userfilter=City|default=New}

This plug-in allows to filter the data presented in tables. Data filtration can be applied to several fields at the same time. To do this you must specify to the plug-in the names of the fields and that's all. The list of possible values for filtration is taken from the table itself, there is no need for you to specify them manually.

column (optional, no default value) - The columns by which the table should be filtered. While using filters by several columns simultaneously, their names should be divided by comma.

userfilter (optional, no default value) - The columns by which the table should be filtered with the user-entered keywords. While using filters by several columns simultaneously, their names should be divided by comma.

cell-width (optional, default=150) - The value of this parameter specifies the width of combobox. The value of this parameter is in pixels.

button (optional, default=false) - When the value of this parameter is 'true' the filter can be hidden/shown by clicking.

hidelabels (optional, default=false) - Allows to hide labels of comboboxes and textboxes if set to 'true'.

default (optional, no default value) - The default values for comboboxes and textboxes by which the table should be filtered.

wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.

script - Location of csv data. Default is the macro body only. If a location of data is specified, the included data will follow the body data.

#filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.

global page template name - Data is read from a global page template.

space:page template name - Data is read from a space template.

^attachment - Data is read from an attachment to the current page.

page^attachment - Data is read from an attachment to the page name provided.

space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.

url - Specifies the URL of an csv file. If a url location is specified, the included data will follow the body and script data.
Use of this parameter may be restricted for security reasons. See your administrator for details.

heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.

delimiter - Delimiter that separates columns. Note that trailing delimiters on a line result in a blank column at the end of the row.

, or "," (comma) - The default column separator.

whitespace - Blanks, tabs, and other white space are used to separate columns.

tab - A single tab character is used to separate columns.

blanks - Blank or blanks only.

pipe - A single pipe (|) character is used to separate columns.

other single character delimiter - may be within double quotes with some restrictions. Examples: ";", "=",

columns - Comma separated list of column numbers in any order.
Defaults to all columns in existing order.
Columns are enumerated starting at 1.

ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored.
A row is considered blank if all the columns selected by the column parameter are blank.
Set ignoreTrailingBlankRows=false to show these blank rows.

quote - the character used to represent quoted data. Quoted data may contain delimiters or new lines. Quote character data must be doubled inside a quoted string.

double - Double quote character (default).

single - Single quote character.

escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table.
Set escape=true to allow these special characters to be escaped so that it will not affect the formatting.
The default is false so that data that has wiki markup will be handled correctly.

showWiki - Default is false. Set to true to show a non-formatted version of the wiki table following the formatted table.
This is used to help resolve formating issues.

Adds column sorting and other attributes to one or more tables found in the body of the macro.
The tables can be produced by wiki markup or other means.
This macro shares common table capabilities with other table
based macros (excel, csv, and sql).

heading - Number of rows to be considered heading rows (default is 1 row).
Specify heading=false or heading=0 to not show any heading lines.
Heading rows do not participate in sorting.

footing - Number of rows to be considered footing rows (default is 0).
Footing rows do not participate in sorting. An auto total row is automatically treated as a footing row.

multiple - Default is true which means all tables found within the macro body are processed.
Set multiple=false to only process the first table found and may need to be used
if the table includes cells that are also tables.

Other parameters - Other parameters are passed through to the html table markup for more advanced
capabilities or to override the default class

Parameters - the following parameters control these common table capabilities:

enableSorting - Set enableSorting=false to prevent sorting.

enableHighlighting - As the mouse moves over a table row, the row will be highlighted by default.
Set enableHighlighting=false to stop this behavior.
This parameter was formerly known as highlightRow which still works.

sortColumn - The table can be auto sorted before it is displayed by any valid column name
or number provided by this parameter. No auto sorting will be done
if this value is not provided or is invalid. A column number is a 1-based count
of columns (excluding auto number column).

sortDescending - If sortDescending=true, the sort indicated by the sortColumn will
be done in reverse order.

sortTip - Text that is used to provide user feedback with mouse is over
a column heading that is sortable. Default text is: "Click to sort" followed by
the column name if available.

sortIcon - Default is false to not show a sort indicator icon.
Set sortIcon=true to include a sort icon in the first heading row for sortable columns.
An icon will show for the last column sorted indicating the direction the column was sorted.

highlightColor - Color of row when mouse is over a row element.
See Colors for how to specify.

autoNumber - If autoNumber=true, an additional column will be added that will
count each data row.

autoTotal - If autoTotal=true, an additional row will be appended to the end of the table
that will contain totals of all numeric columns.

autoNumberSort - If autoNumberSort=true, the auto number column will be sortable and
will retain the original data row count even after row sorting.

columnTypes - By default, all columns are treated as strings for sorting purposes unless
a more specific sort type is provided either by the macro logic or
by this parameter. The parameter
is a comma separated list of column type indicators to identify column types.

S - string

I - integer

F - float

C - currency or similar where it is a float value with pre or post characters

D - date in the browser date format. More advanced date handling may be available
on your server after installation of a date handling library. See online
docmentation for more information.

X - exclude this column from user selectable sorting

. or - or : or / - separated numbers, like phone numbers or TCP addresses.
Valid values are multiple integer numbers separated by one of the separators indicated by the type.

H - hide the column.

columnAttributes - A comma separated list of values used to modify cell attributes for all
cells in a column. The position in the comma separated list corresponds
to the column that the values apply to. Each value is a double semi-colon
list of attributeName=value pairs that will be applied to the column cells.

enableHeadingAttributes - By default, any column attributes provided will be applied to the all column rows including heading rows.
Set enableHeadingAttributes=false to have the column attributes apply only to data rows.

id - Sets the table id for the table for use in macros (like the chart macro) to identify a
specific table.

Makes a pre-formatted block of code with syntax highlighting. All the optional parameters of {panel} macro are valid for {code} too. The default language is Java but you can specify JavaScript, ActionScript, XML, HTML and SQL too.

Example:

Bar.java

// Some comments herepublicString getFoo()
{
return foo;
}

<test><another tag="attribute"/></test>

{calendar:id=myCalendar|title=My Calendar|defaultView=week}

Displays a calendar.

id - (required) The page-unique ID of the calendar.

title - (optional) The title of the initial sub-calendar.

defaultView - (optional) The view to display by default. May be 'event', 'day', 'week', or 'month' (the default).

firstDay - (optional) The first day of the week. Defaults to 'Monday'.

dataDisplay - Default is false to not display the rendered body of the macro (usually the data tables). When dataDisplay=true or dataDisplay=after, the data will be displayed after the chart. When dataDisplay=before, the data will be displayed before the chart.

imageFormat - Default is png. Format of generated image. Valid formats are png and jpg. Other formats may be also be valid if installed on your server.

Title and label customization parameters

title - The title of the chart.

subTitle - A subtitle for the chart using a smaller font.

xLabel - The label to use for the x (domain) axis

yLabel - The label to use for the y (range) axis

legend - A legend will be displayed unless legend=false is specified.

Data specification parameters - The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined to Confluence will be tried. Additional conversion options can be specified using the parameters below.

tables - Comma separated list of table ids and/or table numbers contained within the body of the macro that will be used as the data for the chart. Defaults to all first level tables. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros).

columns - Comma separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Defaults to all columns. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the (html) title attribute for the column in the header row.

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

dateFormat - For time series data, the date format allows for additional customization of the conversion of data to date values. By default, the Confluence language defined date formats will be used. If a dateFormat is specified, it will be the first format used to interpret date values. Specify a format that matches the format of the time series data. See Date Format.

timePeriod - Specify the time period for time series data. Default is 'Day'. This defines the granularity of how the data is interpreted. Valid values are: Day, Hour, Millisecond, Minute, Month, Quarter, Second, Week, Year.

language - If provided, the language and country specification will be used to create additional number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.

country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.

forgive - Default is true to try to convert numeric and date values that do not totally match any of the default or user specified formats. Specify forgive=false to enforce strict data format. Data format errors will cause the chart to not be produced.

Color customization parameters - See Colors for how to specify colors.

bgColor - Color (default is 'white') to use as the background of the chart.

borderColor - Color of a border around the chart. Default is to not show a border.

colors - Comma separated list of colors used to customize category, sections, and series colors.

Axis customization parameters - Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these paramters.

rangeAxisLowerBound - range axis lower bound

rangeAxisUpperBound - range axis upper bound

rangeAxisTickUnit - range axis units between axis tick marks

rangeAxisLabelAngle - angle for the range axis label in degrees

domainAxisLowerBound - domain axis lower bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (Only used in XY Plots, standard charts will have no effect)

domainAxisUpperBound - domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter. (Only used in XY Plots, standard charts will have no effect)

domainAxisTickUnit - domain axis units between axis tick marks. For a date axis, this value represents a count of the units specified in the timePeriod parameter. The time period unit can be overridden by specifying a trailing character: y for years, M for months, d for days, h for hours, m for minutes, s for seconds, u - milliseconds. (Only used in XY Plots, standard charts will have no effect)

domainAxisLabelAngle - angle for the domain axis label in degrees. (Only used in XY Plots, standard charts will have no effect)

categoryLabelPosition - allows axis label text position for categories to be customized

pieSectionExplode - Comma separated list of pie keys that are to be shown exploded. Defaults to no exploded sections. Note: requires jFreeChart version 1.0.3 or higher.

Attachment parameters - These are advanced options that can be used for chart versioning, automation enablement, and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access re-use the attachment. This can be useful especially when combined with the cache macro to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.

attachment - Chart image will be saved in a attachment.

^attachment - chart.macro.param.attachment.attachment

page^attachment - The chart is saved as an attachment to the page name provided.

space:page^attachment - The chart is saved as an attachment to the page name provided in the space indicated.

attachmentVersion - Defines the the versioning mechanism for saved charts.

new - (default) Creates new version of the attachment.

replace - Replaces all previous versions of the chart. To replace an existing attachment, the user must be authorized 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.

attachmentComment - Comment used for a saved chart attachment.

thumbnail - Default is false. If true, the chart image attachment will be shown as a thumbnail.

Date and time formats are specified by date and time pattern strings. Within date and time pattern strings, unquoted letters from 'A' to 'Z' and from 'a' to 'z' are interpreted as pattern letters representing the components of a date or time string. Text can be quoted using single quotes (') to avoid interpretation. "'" represents a single quote. All other characters are not interpreted; theyre simply copied into the output string during formatting or matched against the input string during parsing.

The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):

Pattern letters are usually repeated, as their number determines the exact presentation.

Text:
For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.

Number:
For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless its needed to separate two adjacent fields.

Year:
For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.

For parsing, if the number of pattern letters is more than 2, the year is interpreted literally, regardless of the number of digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to Jan 11, 12 A.D.

For parsing with the abbreviated year pattern ("y" or "yy"), SimpleDateFormat must interpret the abbreviated year relative to some century. It does this by adjusting dates to be within 80 years before and 20 years after the time the SimpleDateFormat instance is created. For example, using a pattern of "MM/dd/yy" and a SimpleDateFormat instance created on Jan 1, 1997, the string "01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64" would be interpreted as May 4, 1964. During parsing, only strings consisting of exactly two digits, will be parsed into the default century. Any other numeric string, such as a one digit string, a three or more digit string, or a two digit string that isnt all digits (for example, "-1"), is interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.

Month:
If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.

General time zone:
Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:

{show-to:user=bob|group=a-group,another-group|space=MYSPACE:edit}
This text is only visible to bob, users in a-group or another-group,
and users who can edit the MYSPACE Space.
{show-to}

Shows the content to users who meet any of the specified requirements.

In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only user "foo" and
not "bar" can view the content, do this:

user=foo, -bar

If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:

user="foo-bar"

user - (optional) the (list of) users who cannot see the content. May also be one of the following special values:

@self - the user current user.

@anonymous - no user is logged in.

@authenticated - any user is authenticated.

group - (optional) the (list of) groups who can see the conent.

space:perm - (optional) the (list of) spaces where, if the user can view
the space, they can see the content. The user's permission type to that space may be added also.

view - (default) the user can view the space.

edit - the user can edit pages.

admin - the user has administration access.

news - the user can post a news entry.

trim - (optional) if 'true' (the default), the content will be trimmed of whitespace at its beginning and end. (default).

match - (optional) specify the match type.

any - (default) the content is displayed if the user matches any of the criteria.

all - the content is displayed if the user matches *all* the criteria.

prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some
macros will display underendered wiki markup when put inside this macro.

{hide-from:user=bob|group=a-group,another-group|space=MYSPACE:edit}
This text is only hidden from bob, users in a-group or another-group,
and users who can edit the MYSPACE Space.
{hide-from}

Shows the content to users who do not meet any of the specified requirements.

In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only user "foo" and
not "bar" can view the content, do this:

user=foo, -bar

If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:

user="foo-bar"

user - (optional) the (list of) users who cannot see the content. May also be one of the following special values:

@self - the user current user.

@anonymous - no user is logged in.

@authenticated - any user is authenticated.

group - (optional) the (list of) groups who cannot see the conent.

space:perm - (optional) the (list of) spaces where, if the user can view
the space, they cannot see the content. The user's permission type to that space may be added also.

view - (default) the user has permission to view the space.

edit - the user has permission to edit pages.

admin - the user has administration access.

news - the user has permission post a news entry.

trim - (optional) if 'true' (the default), the content will be trimmed of whitespace at its beginning and end. (default).

match - (optional) specify the match type.

any - (default) the content is hidden if the user matches any of the criteria.

all - the content is hiddent if the user matches *all* the criteria.

prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some
macros will display underendered wiki markup when put inside this macro.

{show-if:type=news|display=printable|space=MYSPACE|action=edit}
This text is show if the page is a news item, is in printing mode,
is in MYSPACE, or is being edited.
{show-if}

Shows its content if the context meets any of the specified requirements.

In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but
not the "bar" label would look like this:

labels=foo, -bar

If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:

labels="foo-bar"

type(s) - (optional) the (list of) page types. May be:

page

news

comment

spacedescription

display(s) - (optional) the (list of) display modes. May be:

default - The standard display mode.

printable - Printer, PDF or Word mode.

pdf - PDF export mode.

word - Word export mode.

preview - Edit preview mode.

space(s) - (optional) the (list of) spaces.

action(s) - (optional) the action taking place.

view - The content is editable and is currently being viewed.

edit - The content is editable and is currently being edited.

template - The content is a template being previewed.

dashboard

- The content is the dashboard.

header(s) - (optional) the list of HTTP headers from the browser to check.
Values are of the form "name:value" or "name::regexp" (note the double ":"). E.g:
"header=referrer:/index.html" will match a referrer of exactly "/index.html".
"header=referrer::.*/index.html" will match a referrer which ends with "/index.html".
Multiple headers can be checked by separating with "," and optionally adding "+" for
required or "-" for excluded.

match - If set to 'all', then all items listed must match. Defaults to 'any'.

trim - If set to 'false', the content will not be trimmed before being output (if appropriate).

prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some
macros will display underendered wiki markup when put inside this macro.

{hide-if:type=news|display=printable|space=MYSPACE|action=edit}
This text is hidden if the page is a news item, is in printing mode,
is in MYSPACE, or is being edited.
{hide-if}

Shows its content if the context does not meet any of the specified requirements.

In general, all filtering parameters are lists of optional, required or excluded values.
Optional items simply list the value, required items are prefixed with a '+', and excluded values
are prefixed with a '-'. Each value is separated by a ',' or a ';'. For example, to specify that only content which has the "foo" label but
not the "bar" label would look like this:

labels=foo, -bar

If you need to specify a value which contains any of the special characters (namely +, -, ", ; and comma), just
wrap it in a set of quotes. Eg:

labels="foo-bar"

type(s) - (optional) the (list of) page types. May be:

page

news

comment

spacedescription

display(s) - (optional) the (list of) display modes. May be:

default - The standard display mode.

printable - Printer, PDF or Word mode.

pdf - PDF export mode.

word - Word export mode.

preview - Edit preview mode.

space(s) - (optional) the (list of) spaces.

action(s) - (optional) the action taking place.

view - The content is editable and is currently being viewed.

edit - The content is editable and is currently being edited.

template - The content is a template being previewed.

dashboard

- The content is the dashboard.

header(s) - (optional) the list of HTTP headers from the browser to check.
Values are of the form "name:value" or "name::regexp" (note the double ":"). E.g:
"header=referrer:/index.html" will match a referrer of exactly "/index.html".
"header=referrer::.*/index.html" will match a referrer which ends with "/index.html".
Multiple headers can be checked by separating with "," and optionally adding "+" for
required or "-" for excluded.

default - The child page title (if it already exists but is not a child of the current page then a number will be appended)

template - the name of the template to apply to the child page

LAYOUTID:resource.ext - a resource in a specific layout

@current:resource.ext - a resource in the current layout

@parent:resource.ext - a resource in the current layouts parent

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

templatename - the name of a space or global template

If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available

_default_ - The HTML ID (must be unique for the entire web page) associated with an item in the menu

id - alternative (original) way of specifying the html id

class - The CSS class name to assign to div wrapping the menu

classname - The CSS class name to assign to items in the menu

electric - true (or number) - Pop-up menus will automatically open when the mouse hovers over their parent item, or their parent item gets keyboard focus, false - Pop-up menus will only be displayed when the parent item is clicked or when the the parent item is selected and the left arrow key (or spacebar) is pressed (default true)

timeout - Defines the number of milliseconds to wait before menus are automatically shown when the "electric" parameter is set to true

vertical - false - Items on the top level of the menu bar are shown horizontally, true - Items on the top level of the menu bar are shown vertically (ideal for putting menus in sidebars) (default false)

context - see userguide

tooltips - true - Tooltips, if specified in linked menu items, are shown when the mouse hovers over a menu item, false - Tooltips are not shown, useful when your target audience is using a slow internet connection or slow computer (default true)

shadows - see userguide

smooth - true - Shadows will look smoother in most browsers (requires an additional image to be loaded), false - Basic shadows will be used (slightly faster loading of pages) (default true)

blink - false - Menu items do not blink when clicked, true - Menu items blink a few times when clicked to give more visual feedback to the end-user (default false)

lazy - false - After the web page loads, the entire menu is "built" immediately, true - After the web page loads, only the top level of the menu is "built" and subsequent levels (i.e. pop-up menus) are only built when they are first displayed (default false)

toolbar - false - The top level of the menu displays normally, true - Additional styling is applied which makes items on the top level of the menu take up less space, ideal for toolbars. Note that some menu styles (e.g. the Longhorn style) don't currently support this feature (default false)

clone - see userguide

focus - automatically focus the menu (default false)

scrolling - true - If a menu is too big to fit in the browser window, scroll buttons will appear at either end to allow the user to "scroll" the menu. It's a really nice feature!, false - Menus will be shown in their entirety, even if that means that part of them can't be seen within the browser window (default true)

Used to create a menu with an icon based on the current space & page watch state

Parameters:

class - The CSS class name to assign to an item in a menu

subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

{fav-menu}
{compound-menuitem:favourite|caption=%Add% this %Page% to favourites}
{compound-menuitem:favouritespace|caption=%Add% this space to favourites}
{fav-menu}

Used to create a menu with an icon based on the current space & page favourite state

Parameters:

class - The CSS class name to assign to an item in a menu

subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

tooltip - the tooltip that should be displayed by the link, use @none for blank

accesskey - the keypress that should be associated with this link

target - the target for the link (eg _blank)

space - the spacekey whose context the link generation should be calculated against

page - the title of the page whose context the link generation should be calculated against

parent - used by the exportMail link type to define the parent where the page generated from the mail shuld be created

class - the css class to be applied to the link

toggle - the html ID of the element whose visibility is to be toggled

sidebar - the name of the sidebar whose visibility is to be toggled (left/right)

link - the custom link

icon - the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)

imginside - should the icon appear inside the link (default=false)

title - page title to use with newpage menulink

template - template to use with newpage menulink

LAYOUTID:resource.ext - a resource in a specific layout

@current:resource.ext - a resource in the current layout

@parent:resource.ext - a resource in the current layouts parent

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

templatename - the name of a space or global template

If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available

view - Used only for newpage menulink in conjunction with builder templates, takes the user to the viewpage rather tha editpage (default - false)

layout - the layoutId to use when the link is used

latch - whether the layout should be latched when the link is used

class - The CSS class name to assign to an item in a menu

id - The HTML ID (must be unique for the entire web page) associated with an item in the menu

autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)

custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)

tooltip - the tooltip that should be displayed by the link, use @none for blank

accesskey - the keypress that should be associated with this link

target - the target for the link (eg _blank)

space - the spacekey whose context the link generation should be calculated against

page - the title of the page whose context the link generation should be calculated against

parent - used by the exportMail link type to define the parent where the page generated from the mail shuld be created

class - the css class to be applied to the link

toggle - the html ID of the element whose visibility is to be toggled

sidebar - the name of the sidebar whose visibility is to be toggled (left/right)

link - the custom link

icon - the icon to use as one of SPACEKEY:pagename^filename.ext/custom url/inbuilt icon (use 'noicon' to prevent an icon being displayed)

size - the size of the icon to use

imginside - should the icon appear inside the link (default=false)

title - page title to use with newpage menulink

template - template to use with newpage menulink

LAYOUTID:resource.ext - a resource in a specific layout

@current:resource.ext - a resource in the current layout

@parent:resource.ext - a resource in the current layouts parent

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

templatename - the name of a space or global template

If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available

view - Used only for newpage menulink in conjunction with builder templates, takes the user to the viewpage rather tha editpage (default - false)

layout - the layoutId to use when the link is used

latch - whether the layout should be latched when the link is used

checkexists - whether userspace menulink should check to see if the user has a personal space (default false)

force - force the comments or children link to be displayed when there are no comments or children to the page (default false)

forceicon - force the icon to be displayed irrespective of the layout (default false)

location - the webui location to use with webui links

key - the webui key to use with webui links

linkId - the html id to be applied to the link

flag - Will only be rendered if any of the flags have been set using set-flag.

notflag - Will not be rendered if any of the flags have been set using set-flag.

Used to display a chunk of wiki-markup dependant on what is being displayed

Parameters:

context - comma separated list of contexts (the kind of page being displayed eg: page, blogpost, dashboard) where the content should be shown

mode - comma separated list of modes that the content is being viewed as (eg: view, edit) where the content should be shown

decorator - comma separated list of decorators (eg: printable) where the content should be shown

action - comma separated list of actions (eg: viewpage/login/logout) where the content should be shown

spacekey - the space against which permission checks will be made (default current space)

pagetitle - the page against which permission checks will be made (default current page)

space - comma separated list of spaces if the content is within one of these spaces then it will be shown, the type of space can also be checked through the @global and @personal meta keys, the presence of @child and @parent spaces may also be tested for

exists - the name of a confluence page whose existance defines whether the content should be shown (@parent can be used to show data if the page not at the root level, @child/@children can be used to show data if the page has children, @childless can be used to show data if the page has no children)

pluginkey - the key of a plugin which must be enabled for the content to be shown

spacelabel - comma separated list of labels applied to the space for which the content should be shown

teamlabel - comma separated list of team-labels applied to the space for which the content should be shown

label - comma separated list of labels for which the content should be shown (recursable)

metadata - comma separated list of metadata name:value pairs where the content should be shown (recursable)

hastitle - the title that the page must have for the content to be shown (recursable)

restriction - display content if the page has a restriction in place (none/view/edit/vieworedit/viewandedit - recursable)

useragent - comma separated list of strings which if found in the user agent will display the content

attachment - comma separated list of filenames, one of which must be attached to the current page for the content to be displayed (use attachment= with no value to show based on whether there are any attachments)

olderthan - show if current page was modfied before the given time period from the current date, eg olderthan=1y6m1d1h (year/month/day/hour)

newerthan - show if current page was modfied after the given time period from the current date, eg newerthan=1y6m1d1h (year/month/day/hour)

ip - comma separated list of ip addresses to which the content should be shown

layout - a comma separated list of layouts to match the currently used layout, or @DEFAULT for the space default layout

flag - a comma separated list of flags to check, will only show if at least one of the flags is present

notflag - a comma separated list of flags to check, will only show if none of the flags are present

parameters - a comma separated list of parameter name:value pairs where the content should be shown

resource - a comma separated list of layout resource identifiers, one of which must be attached to the layout for the content to be shown (eg: @current::filename.ext, LAYOUTID::filename.ext, @parent::filename.ext)

Used to hide a chunk of wiki-markup dependant on what is being displayed

Parameters:

context - comma separated list of contexts (the kind of page being displayed eg: page, blogpost, dashboard) where the content should be hidden

mode - comma separated list of modes that the content is being viewed as (eg: view, edit) where the content should be hidden

decorator - comma separated list of decorators (eg: printable) where the content should be hidden

action - comma separated list of actions (eg: viewpage/login/logout) where the content should be hidden

spacekey - the space against which checks will be made (default current space)

pagetitle - the page against which checks will be made (default current page)

space - comma separated list of spaces if the content is within one of these spaces then it will be hidden, the type of space can also be checked through the @global and @personal meta keys, the presence of @child and @parent spaces may also be tested for

exists - the name of a confluence page whose existance defines whether the content should be hidden (@parent can be used to hide data if the page not at the root level, @child/@children can be used to hide data if the page has children, @childless can be used to hide data if the page has no children)

pluginkey - the key of a plugin which must be enabled for the content to be hidden

spacelabel - comma separated list of labels applied to the space for which the content should be hidden

teamlabel - comma separated list of team-labels applied to the space for which the content should be hidden

label - comma separated list of labels for which the content should be hidden (recursable)

metadata - comma separated list of metadata name:value pairs where the content should be hidden (recursable)

hastitle - the title that the page must have for the content to be hidden (recursable)

restriction - hide content if the page has a restriction in place (none/view/edit/vieworedit/viewandedit - recursable)

useragent - comma separated list of strings which if found in the user agent will hide the content

attachment - comma separated list of filenames, one of which must be attached to the current page for the content to be hidden (use attachment= with no value to hide based on whether there are any attachments)

olderthan - hide if current page was modfied before the given time period from the current date, eg olderthan=1y6m1d1h (year/month/day/hour)

newerthan - hide if current page was modfied after the given time period from the current date, eg newerthan=1y6m1d1h (year/month/day/hour)

ip - comma separated list of ip addresses from which the content should be hidden

layout - a comma separated list of layouts to match the currently used layout, or @DEFAULT for the space default layout

flag - a comma separated list of flags to check, will only hide if at least one of the flags is present

notflag - a comma separated list of flags to check, will only hide if none of the flags are present

parameters - a comma separated list of parameter name:value pairs where the content should be hidden

resource - a comma separated list of layout resource identifiers, one of which must be attached to the layout for the content to be hidden (eg: @current::filename.ext, LAYOUTID::filename.ext, @parent::filename.ext)

Very similar to the include macro in that it is used to display the contents of another page, but in this case rendered within the context of the current page

Parameters:

_default_ - the page title or layout resource that should be imported

LAYOUTID::resource.ext - a resource in a specific layout

@current::resource.ext - a resource in the current layout

@parent::resource.ext - a resource in the current layouts parent

SPACEKEY::pagename - a specific page in a specific space

pagename - a specific page in the current space

templatename - the name of a space or global template

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

If a page is not found in the current space using the name given, then import will look for a resource in the current layout with pagename.wiki as the filenamem, if no resource is found then a space template with that name will be checked for, if none is found then a global template of that name will be used if available
In none of the above can be found then an empty string is returned

space - an alternate way of specifying the space (default param takes precedence)

page - an alternate way of specifying the page (default param takes precedence)

flag - a comma separated list of flags to check, will only display if at least one of the flags is present

notflag - a comma separated list of flags to check, will only display if none of the flags are present

Used to render a chunk of wiki-markup from the perspective of another page

Parameters:

direction - the direction that the macro should look in when searching for the page to render with (REQUIRED)

ancestor/ancestors/up - search for the page to render with amongst the ancestors of the start page

descendant/descendants/down - search for the page to render with amongst the descendants of the start page

sibling/siblings - search for the page to render with amongst the siblings of the start page

children - search for the page to render with amongst the children of the start page

none - dont search, just use the start page

startPage - the page to start the search from

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

reverse - List the pages in reverse order

count - The number of pages that should be displayed

start - Offset from the start for listing the pages

searchMode - list/single (default = single - Find the first page that matches)

Used to render a chunk of wiki-markup from the perspective of an ancestor page

Parameters:

startPage - the page to start the search from

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

reverse - List the pages in reverse order

count - The number of pages that should be displayed

start - Offset from the start for listing the pages

searchMode - list/single (default = single - Find the first page that matches)

Used to render a chunk of wiki-markup from the perspective of an descendant page

Parameters:

startPage - the page to start the search from

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

reverse - List the pages in reverse order

count - The number of pages that should be displayed

start - Offset from the start for listing the pages

searchMode - list/single (default = single - Find the first page that matches)

Used to render a chunk of wiki-markup from the perspective of a sibling page

Parameters:

startPage - the page to start the search from

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the page must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

reverse - List the pages in reverse order

count - The number of pages that should be displayed

start - Offset from the start for listing the pages

searchMode - list/single (default = single - Find the first page that matches)

direction - the direction that the macro should look in when searching for the pages to render with (REQUIRED)

ancestor/ancestors/up - search for the page to render with amongst the ancestors of the start page

descendant/descendants/down - search for the page to render with amongst the descendants of the start page

sibling/siblings - search for the page to render with amongst the siblings of the start page

children - search for the page to render with amongst the children of the start page

none - dont search, just use the start page

startPage - the page to start the search from

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

excerpt - include the excerpt in the output (default false)

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

space - comma separated list of spaces, one of which the page must be in

title - comma separated list of titles which the page must have

label - comma separated list of labels which the page must have at least one

metadata - comma separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a value is specified then the key must have that value, if only the key is specified then any value is valid

default - if specified, and a page is not found, then this page will be used instead

SPACEKEY:pagename - a specific page in a specific space

pagename - a specific page in the current space

@self - the current page

@current - same as @self

@parent - the parent of the current page

@parentparent - the parent of the current page's parent'

@space - the currently viewed space showing all top-level pages

@orphan - same as @space

@root - the root of the current page's tree

@home - the homepage of currently viewed space

sort - The order that the pages should be listed in (creation/modified/recent/confluence - default confluence)

Allows you to define a link that creates a new page based on a name given by the user at runtime

parent - the name of parent to the new page. May be one of the following:

@self - the current page (default)

@parent - the parentto the current page

pagename - any predefined page

space - the space that the parent page exists within (defaults to current page's space)

fallback - the spacekey AND page to fallback to (specified as SPACEKEY:pagename)

boilerplate - the boilerplate to inject into the new page

template - the template to be copied into the new page

prefix - a prefix to be applied to the page title given by the user

postfix - the suffix to be applied to the name given by the user

target - If set to 'edit', once the page is created the user will be prompted to enter any template variables, and then taken to the edit screen rather than the 'view' screen.

title - A static title to be used (cannot be used with prefix, postfix, or prompt). This title can contain the following parameters - %parenttitle%, which will insert the title of the parent page, and %ident%, which will insert the lowest number needed to make the page title unique. This allows you to create numbered child pages without user prompting.

addspace - whether to insert spaces between the suffix & postfix and the name given by the user or not (default = true)

prompt - The text to use when asking the user for the new page title(default = Please enter the new page name)

Embraces a block of text within a fully customizable panel. The optional parameters you can define are the following ones:

title: Title of the panel

borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)

borderColor: The color of the border this panel uses

borderWidth: The width of the border this panel uses

bgColor: The background color of this panel

titleBGColor: The background color of the title section of this panel

Example:

My Title

a block of text surrounded with a panel
yet another line

{sub-section:myId} Some content {sub-section}

{sub-section:myId|showComment=false|comment=This is a new version|showMinorChange=false|minorChange=true} Content {sub-section}

{sub-section:myId|metadata=Author}Jean-Maxime Guay{sub-section}

Used to create editable sub-sections

Parameters:

default - (required) The ID used to identify the sub-section on the page, all sub-sections with the same id will end up with the same content after editing, hence this ID should be unique for the page. The ID is case-sensitive and must be specified directly after the : (colon).

showComment - (optional) Show/Hide the comment textbox in the sub-section. Either true or false. Default to true.

comment - (optional) Set the text of the version comment (no quote). Default : sub-section:ID edited.

showMinorChange - (optional) Show/Hide the minorEdit checkbox in the sub-section. Either true or false. Default to true.

minorChange - (optional) Either true or false. A minor change won't send a notification to watchers. Default to false.

metadata - (optional) The key of the metadata in which the wikimarkup will be stored. Default: no metadata set.

All the parameters (keys and values) are case insensitive except the id.
Sub-sections use Asynchronous JavaScript and XML (AJAX).

charoff - Specifies the alignment offset to the first character to align on

colspan - Indicates the number of columns this cell should span

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

height - Specifies the height of the table cell

nowrap - Whether to disable or enable automatic text wrapping in this cell

rowspan - Indicates the number of rows this cell should span

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

charoff - Specifies the alignment offset to the first character to align on

colspan - Indicates the number of columns this cell should span

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

height - Specifies the height of the table cell

nowrap - Whether to disable or enable automatic text wrapping in this cell

rowspan - Indicates the number of rows this cell should span

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

Performs setup operations for some of the composition macros. Some macros
require that this has been put at the top of a page for them to work. It allows page-wide
settings for macros. Its contents is a list of properties, as listed below.

import.css - The path to the CSS file to import. May be a page attachment (eg. "^style.css")
or a regular URL.

cloak.memory.duration - The number of days to remember the state of the page.
Set to 0 to disable memory altogether. Defaults to 7 days.

cloak.toggle.type - (optional) The type of toggle to display. May be:

default - (default) Blue arrows pointing up or down.

custom - Allow custom images as the icons. You must set 'cloak.toggle.open'
and 'cloak.toggle.close' when using this option.

text - Allow any regular text as the icons. You must set 'cloak.toggle.open'
and 'cloak.toggle.close' when using this option.

wiki - Allow regular wiki text (except links). You must set 'cloak.toggle.open'
and 'cloak.toggle.close' when using this option.

none - No icon will be output at all. You will probably want to make sure that
'cloak.toggle.zone' is set to true with this option.

cloak.toggle.open - If 'cloak.toggle.type' is set to 'text' or 'custom', this what
the toggle will contain when the cloak contents can be expanded.
E.g. If in 'text' mode, a good value might be '+'. If in 'custom' mode, either an absolute URL
('http://.../open.gif'), a relative URL ('/.../open.gif') or a Confluence attachment link
('[SPACEKEY:][Page]^open.gif') must be provided.

cloak.toggle.close - If 'cloak.toggle.type' is set to 'text' or 'custom', this is
what the toggle will contain when the cloak contents can be hidden.
E.g. If in 'text' mode, a good value might be '-'. If in 'custom' mode, either an absolute URL
('http://.../close.gif'), a relative URL ('/.../close.gif') or a Confluence attachment link
('[SPACEKEY:][Page]^close.gif') must be provided.

cloak.toggle.exclusive - (optional) If true, all cloaked sections will be
exclusive - that is, only the current section will be visible at any given time. Defaults to 'false'.

cloak.toggle.zone - (optional) If true, the paragraph or heading any toggle
icons are placed in can also be clicked to toggle the associated cloak section. Defaults to 'true'.

deck.memory.duration - The number of days to remember the state of the decks on the page.
Set to 0 to disable memory altogether. Defaults to 7 days.

deck.class - The custom CSS class to apply to all decks

deck.tab.location - 'top', 'bottom' or 'none'. The location of the tab bar.

deck.width/deck.height - The width and/or height the content will be constrained to (not including any tabs).
If not set, the tabs expand to display their content.

deck.startHidden - If set to 'false', the cards will be initially visible on the page until setup is complete. Defaults to 'true'.

deck.loopCards - If 'true', the deck will loop back to the beginning from the last card and vice versa. Defaults to 'false'.

deck.nextAfter - The number of seconds the slides will stay visible before moving to the next one.
By default the current slide will not transition until prompted by the user.

deck.effect.type - The effect to use when moving to a new slide. May be 'fade' or 'none' (the default).

deck.effect.duration - The number of seconds the transition will take to complete. Eg. '1.5'. Defaults to 1.

{float:right|width=50px|background: #F0F0F0|border: solid navy}
This will float to the right.
{float}

Creates a weekly booking sheet with the list of items able to be booked by
logged-in users. All options below such as width, background and padding support valid
CSS options for the properties of the same name.

[default]/side - (required) The side the content will float on (left or right).

width - (optional) The width of the floating content (eg. '100px').

background - (optional) The background colour or picture settings.

border - (optional) The border settings.

margin - (optional) The margin settings.

padding - (optional) The padding settings.

{cloak:id=Cloaked Content}
This section will be cloaked until it is toggled.
{cloak}

Creates a cloaked section which can be toggled
between being visible and hidden.Note: Requires that {composition-setup}
is placed above it in the page.

id - (required) The unique ID of the cloaked section.

visible - (optional) If 'true', the section will be visible initially.
Defaults to 'false'.

Creates a new deck of 'cards' - sections of content
which are displayed one at a time. By default, tabs similar to those in the default Confluence
theme are displayed.Note: Requires that {composition-setup}
is placed above it in the page.

id - (required) The unique ID of the deck section.

tabLocation Either 'top', 'bottom' or 'none'. Defaults to 'top'.

class - The custom CSS class the deck will be placed in.

width/height - The width and/or height the content will be constrained to (not including any tabs).
If not set, the tabs expand to display their content.

startHidden - If set to 'false', the cards will be initially visible on the page until setup is complete. Defaults to 'true'.

loopCards - If 'true', the deck will loop back to the beginning from the last card and vice versa. Defaults to 'false'.

nextAfter - The number of seconds the slides will stay visible before moving to the next one.
By default the current slide will not transition until prompted by the user.

effectType - The effect to use when moving to a new slide. May be 'fade' or 'none' (the default).

effectDuration - The number of seconds the transition will take to complete. Eg. '1.5'. Defaults to 1.

card - (required) Either the label of the card, or one of the following special labels:

@first - Show the first card in the deck.

@last - Show the last card in the deck.

@next - Show the next card after the currently-visible one. If the deck loops, it will show the first card if the current card is the last.

@prev - Show the card previous to the currently-visible one. If the deck loops, it will show the last card if the current card is the first.

scrollTo - (optional) If set to false, the browser will not scroll to the deck. Defaults to true.

Confluence Content

Ways to include, summarise or refer to other Confluence content.

Notation

Comment

!quicktime.mov!

!spaceKey:pageTitle^attachment.mov!

!quicktime.mov|width=300,height=400!

!media.wmv|id=media!

Embeds an object in a page, taking in a comma-separated of properties.

Default supported formats:

Flash (.swf)

Quicktime movies (.mov)

Windows Media (.wma, .wmv)

Real Media (.rm, .ram)

MP3 files (.mp3)

Other types of files can be used, but may require the specification of the "classid", "codebase" and "pluginspage" properties in order to be recognised by web browsers.

Common properties are:

width - the width of the media file

height - the height of the media file

id - the ID assigned to the embedded object

Due to security issues, files located on remote servers are not permittedStyling
By default, each embedded object is wrapped in a "div" tag. If you wish to style the div and its contents, override the "embeddedObject" CSS class. Specifying an ID as a property also allows you to style different embedded objects differently. CSS class names in the format "embeddedObject-ID" are used.

showEditLinks
If the current user has permission, show quick links to edit or remove the bookmark.

showLabels
The labels for the bookmark.

showListHeader
The bookmark list header (with the rss feed link).

max
The maximum number of bookmarks to display. Defaults to 15.

showSpace
The space the bookmark is saved in

showViewLink
A link to the actual bookmark page

{pagetree}

{pagetree:root=PageName}

{pagetree:root=PageName|sort=natural|excerpt=true|reverse=false}

{pagetree:root=@home|startDepth=3}

{pagetree:searchBox=true}

{pagetree:expandCollapseAll=true}

Provides page hierachal tree within a space. If no parameters are specified the root of the tree will
be the home page, a different root page can be specified by providing the page to the root
parameter.

root: - (optional) page where the tree would be rooted from. Meta root names @self, @parent, @home can also be used.

sort: - (optional) sorts the tree node. It my be one of the following: bitwise, creation, modified, natural, position. Default sorting is position

excerpt: - (optional) true/false flag that indicate if a page excerpt would be included in the tree display (default is false).

reverse: - (optional) true/false flag that allows you to reverse the order of the display (default is false).

searchBox: - (optional) true/false flag that allows you to add a search box in the tree that would search from the root page (default is false).

expandCollapseAll: - (optional) true/false flag that allows you to add an expand all and a collapse all row (default is false).

startDepth: - (optional) a number that indicates the initial depth that the tree would display (default value is 1).

{pagetreesearch}

{pagetreesearch:rootPage=PageName}

{pagetreesearch:rootPage=Space:PageName}

Provides a search box to search a page hierachal tree within a space.

If no parameters are specified the root of the tree will be the current
page, a different root page can be specified by providing the page to the rootPage parameter.

showZeroCounts - (optional) If all the selected columns are zero, or empty should the contributor or page be displayed in the table. Default is false.

Page Searching Options
The following parameters control what pages are used to build the contributors list.

page The page to count statistics from. If no spaces or labels are specified this will default to the current page.

labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)

spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The following shortcut space names can also be used:

showCount - (optional) Show the count for each user. Default is false.

showLastTime - (optional) Show the last time a contribution was made by each user for any content specified by the include parameter. Default is false.

Page Searching Options
The following parameters control what pages are used to build the contributors list.

page The page to count statistics from. If no spaces or labels are specified this will default to the current page.

labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.)

spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The followingshortcut space names can also be used:

scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)

children include statistics from the immediate children of the page

descendants include statistics from all descendants of the page

Advanced Options

showPages - show a list of pages returned above the list. Useful for debugging.

noneFoundMessage - override the default message that is displayed when no contributors are found.

{viewfile:presentation.ppt}

{viewfile:space=dog|page=testpage|name=worddocument.doc}

{viewfile:spreadsheet.xls|grid=false|sheet=Sheet 1|row=4|col=5}

{viewfile:slideshow.pdf|width=200|height=150}

Embeds the content of a file attachment into a Confluence page.
Supported formats:

Microsoft Word Documents

- Embedded as html

Microsoft Excel Spreadsheets

- Embedded as html

Microsoft Powerpoint Presentations

- Embedded in a flash slideshow control or as a single image for individual pages

Adobe PDF files

- Embedded in a flash slideshow control or as a single image for individual pages

space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.

page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.

date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post

name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}

Macro arguments specific to Excel spreadsheets

grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.

sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook

row - (optional)the last row in the worksheet to render. The default is the last row with content.

col - (optional)the last column in the worksheet to render. The default the last column with content.

Macro arguments specific to Powerpoint and PDF presentations

slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.

height - (optional)overrides the default height of the flash control or image.

width - (optional)overrides the default width of the flash control or image.

{children}

{children:all=true}

{children:depth=x}

{children:depth=x|style=h3}

{children:excerpt=true}

{children:page=Another Page}

{children:page=/}

{children:page=SPACEKEY:}

{children:page=SPACEKEY:Page Title}

{children:first=x}

{children:sort=<mode>|reverse=<true or false>}

Displays the children and descendants of the current page. Specify 'all=true' to show all descendants of this page, or depth=x (where x is any number > 0) to show that many levels of descendants.

The 'style' attribute can be any of 'h1' through 'h6'. If you specify a style, the top level of child pages will be displayed as headings of that level, with their children then displayed as lists below. A great way to throw together a quick contents page!

You can view the children of a different page in the same space with {children:page=Another Page Title}.

If you specify a page of '/', you will list all the pages in the space with no parent (i.e. the top-level pages), excluding the current page

If you specify a page of 'FOO:' (the colon is required), you will list all the pages with no parent in the space with key "FOO".

Specify 'excerpt=true' to also display the first line of the page's excerpt (see the excerpt macro) if it exists.

Example:

child

another child

child

first grandchild

another child

The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date. Use the reverse attribute to optionally reverse the sorting.

The 'first' attribute allows you to restrict the number of children displayed at the top level.

{search:query=my_query}

{search:query=my_query|maxLimit=x}

Does an inline site search.

query: your query

maxLimit=x: (where x is any number > 0) to limit the search result to a number of results.

content - lets you choose whether to display each blog post in its entirety (the default), just short excerpts from each item (see the excerpt macro), or just a list of post titles.

time - lets you choose how far back to look for blog posts. For example, "time=12h" would show you those items made in the last twelve hours, and "time=7d" would show items made in the last week. (The default is no limit)

label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.

spaces - (optional) spaces to search.Accepted values:

space keys (case-sensitive)

@self: current space

@personal: personal spaces

@global: global spaces

@favorite/@favourite: user's favourite spaces

@all/*: all spaces (that the user has permission to view)

Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.

type - (optional) search for types of content. Accepted values:

page: basic pages

comment: comments on pages or blogs

blogpost/news: blog posts

attachment: attachments to pages or blogs

userinfo: personal information

spacedesc: space descriptions

personalspacedesc: personal space descriptions

mail: emails in a space

Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.

max/maxResults - (optional) the maximum number of results to return. Defaults to 100.

sort - (optional) the sorting to apply to the results.Accepted values:

title: by content title

creation: by time of creation

modified: by time of last modification (creation is the "first" modification)

reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

{excerpt}Confluence is a knowledge-sharing application that enables teams to communicate more effectively{excerpt}

{excerpt:hidden=true}This excerpt will be recorded, but will not be displayed on the page.{excerpt}

Marks some part of the page as the page's 'excerpt'. This doesn't change the display of the page at all, but other macros (for example children, excerpt-include and blog-posts) can use this excerpt to summarise the page's content.

hidden: If the value of "hidden" is true, then the contents of the excerpt macro will not appear on the page.

{excerpt-include:Home}

{excerpt-include:Home|nopanel=true}

{excerpt-include:blogPost=/2006/12/28/News Page}

Includes the excerpt from one page (see the excerpt macro) within another. The included page must be in the same space as the page on which the macro is used.

nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.

{popular-labels}

{popular-labels:style=heatmap|count=15}

Renders a list (or heatmap) of the most popular labels ordered by popularity (or name).

count - (optional) Specify the number of labels to be displayed. If not specified, a default of 100 is used.

spaceKey - (optional) Restrict the popular labels to a certain space.

style - (optional) Allows 'heatmap'. Specifying a heatmap style will use different font sizes depending on their rank of popularity, ordered by label names. If not specified, a default list style is used ordered by popularity (highest first).

Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.

showLabels - (optional) display the labels for each results (enabled by default)

showSpace - (optional) display space name for each result (enabled by default)

title - (optional) add a title above the results list

max/maxResults - (optional) the maximum number of results to display (default is 5)

excerpt - (optional) display first line of excerpt for each result

space/spaces - (optional) spaces to search.Accepted values:

space keys (case-sensitive)

@self: current space

@personal: personal spaces

@global: global spaces

@favorite/@favourite: user's favourite spaces

@all/*: all spaces (that the user has permission to view)

Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.

label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.

sort - (optional) the sorting to apply to the results.Accepted values:

title: by content title

creation: by time of creation

modified: by time of last modification (creation is the "first" modification)

reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100%

space/spaces - (optional) spaces to search.Accepted values:

space keys (case-sensitive)

@self: current space

@personal: personal spaces

@global: global spaces

@favorite/@favourite: user's favourite spaces

@all/*: all spaces (that the user has permission to view)

Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces. Defaults to the current space (@self).

label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.

Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces. Defaults to all types. In shared mode, the personal information type is excluded from the defaults.

{recently-used-labels}

{recently-used-labels:scope=space|count=15}

Renders a list (or table) of labels most recently used in a specified scope.

count - (optional) Specify the number of labels to be displayed. If not specified, a default of 10 is used.

scope - (optional) Allows 'global', 'space' and 'personal'. If not specified, the 'global' scope is used. The global scope will show labels that were recently used within this confluence instance. The space scope will show labels that were recently used in the current space. The personal scope will show you personal labels that you recently used.

style - (optional) Allows 'table'. Specifying a table style will render the most recently used labels in a table form.

title - (optional) Allows you to specify a heading for the table view of this macro. See the 'style' option above.

Renders the list of pages associated with the specified label as a navigable map.
A label must be specified for this macro. The following parameters are all optional:

title - the title for this navigation map.

wrapAfter - the number of cells to span horizontally before wrapping to the next line. (default: 5)

cellWidth - width of individual cells in the map in pixels. (default: 90px)

cellHeight - height of individual cells in the map in pixels. (default: 60px)

theme - if you want to create your own look and feel for the navmap (say one with rounded corners), you can do so by adding a file to the WEB-INF/classes/templates/macros directory. The file name convention to use is: navmap-mytheme.vm. You can use whatever name you like in place of mytheme. Just make sure you specify this when calling the macro using theme=mytheme.

Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100%

spaces - (optional) comma separated list of space keys

labels - (optional) comma separated list of labels (content associated with at least one of these will be listed)

Specifying the online value allows you to filter the user list by the user online status. Setting online=true will show only online users, whereas setting online=false will show only offline users.

If you've configured this macro to display groups which are black listed by the administrator, you will get a warning panel at the top. The warning will be automatically displayed by default. To disable the warning, you can specify showWarning=false.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Parameters

(default) - The user id/screen name.

service - The name of the service to check. May be 'aim', 'gtalk', 'icq', 'msn', 'sametime', 'skype', 'wildfire' or 'yahoo'.

showid - (optional) If 'false', the user's id will not be shown.

{sql:dataSource=TestDS|output=wiki}
select * from test
{sql}

There are *{sql:dataSource=TestDS|table=false} select count(*) from test01 {sql}* rows in table test01

{sql:dataSource=TestDS|p1=%test%|showsql=true}
select * from test01 where a1 like ?
{sql}

Displays the result table(s) or values from an SQL statement(s), usually a query.
Consider using the sql-query macro for simple queries.
Data from single or multiple results sets are formatted usually as a table for display.
Multiple SQL statements (semi-colon separated) can be specified within a single sql macro body
(subject to support provided by specific databases).
This macro supports common table capabilities with other table
based macros (table-plus, csv, and excel).

This macro may have restricted use for security reasons. See your administrator for details.

Recursive use:
Four identical macros sql, sql1, sql2, and sql3 are provided to enable recursive use of the macro.

dataSource - Required parameter. Formerly known as the jndi parameter.
For compatibility the jndi parameter will be still be used if the dataSource parameter is missing.
Specify the datasource name defined in the application server.
Do not use the standard prefix (java:comp/env/jdbc/) as it is added automatically if necessary.
Specific values of this parameter may be restricted for security reasons. See your administrator for details.

output - Determines how the output is formated:

html - Data is output as a HTML table (default).

wiki - Data is output as a Confluence wiki table. Use this option if you want data within the table to be formated by the Confluence wiki renderer.

script - Location of sql statement. Default is the macro body only.

#filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.

global page template name - Data is read from a global page template.

space:page template name - Data is read from a space template.

^attachment - Data is read from an attachment to the current page.

page^attachment - Data is read from an attachment to the page name provided.

space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.

heading - Number of rows to be considered heading rows (default is 1 row). Specify heading=false or heading=0 to not show any heading lines.

columnLabel - By default, database column names are used as column labels. Specify columnLabel=true to have database column
labels used for column labels. Note that most databases default the column label to be the column name when no explicit column label is provided.
Fly-over text for a column label will be the column name when columnLabel=true.
Fly-over text for a column label will be the database column label when columnLable=false or by default.

escape - When wiki output is requested (output=wiki), some special characters (like '|', '[', ']', '{', '}') in data may cause undesirable formatting of the table.
Set escape=true to allow these special characters to be escaped so that it will not affect the formatting.
The default is false so that data that has wiki markup will be handled correctly.

convertNull - Default is true. Converts SQL NULL values to blank. Set to false to have NULL values show up as 'null'.

table - Default is true. Set to false to not format the data in a table.
This option can be used to run queries that produce single values that you want to include in text.

noDataError - Default is false. Set to true to show an macro error when no data is returned from the query.

expandArray - Default is true to have array fields expanded one entry per line for vertical row orientation.

showSql - Default is false. Set to true to show a panel with the sql statement.

macros - Default is false. Set to true to execute any macros so their value can be passed to the SQL query.

SQL parameter markers - SQL supports parameter markers in statements - these are identified by ?'s.
Parameters p1, p2, ... are substititued for the parameter markers.
This can be used to parameterize complex scripts stored as attachments or files.

p1 - first parameter marker

p2 - second parameter marker

... - ...

autoCommit - Advanced use only. Default is true.
Set to false for sql that explicitly controls its own rollbacks and commits.

transactionIsolation - Advanced use only.
Set the transaction isolation level for the sql statements.
The default will be used unless this parameter is set to a valid value from the following list:

READ_COMMITTED (default) - any changes made inside a transaction are not visible outside it until the transaction is committed.

READ_UNCOMMITTED - allows transactions to see uncommitted changes to the data.

REPEATABLE_READ - rows that are read retain locks so that another transaction cannot change them when the transaction is not completed.

SERIALIZABLE - Tables are locked for the transaction so that WHERE conditions cannot be changed by other transactions that add values to or remove values from a table

NONE - Database does not support transactions

{sql-query:dataSource=TestDS|output=wiki}
select * from test
{sql}

Displays a result table or values from an SQL select statement.
The statement must produce a single result set. Use the sql macro for more complex select or other
statements. The sql-query macro is recommended for better performance.

This macro supports the same parameters as the sql macro, the primary difference is to restrict
what statements can be run.

This macro may have restricted use for security reasons. See your administrator for details.

Recursive use:
Four identical macros sql-query, sql-query1, sql-query2, and sql-query3 are provided to enable recursive use of the macro.

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

{junitreport:url=file:///test-reports/TestRep.xml}

Displays the results of a series (or single) JUnit test.

Success Rate

Tests

Failures

Time(s)

Time(s)

93%

14

1

0

1.531

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

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

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

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

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

Another Item(
Dec 30, 2003 06:53)
And part of the item content here...

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

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

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

The vote macro allows Confluence users to vote on any topic of interest.
Users are allowed to select only one of the given choices and vote one time,
and the results will not be visible to them until they have voted. Users
that have not logged in will be prompted to do so before allowing them to
cast a vote. This macro was created to support quick, informal votes on
various topics. The macro has a title and a series of choices, each choice
starting on its own line.

Parameter

Required

Default

Description

true

This is the title of the ballot and must be the first paramter.

voters

false

all users

This is a comma seperated list of usernames to who are allowed to
cast a vote. Users not in this list will not be allowed to vote, but
if they are viewers will be shown the results of the vote. If this parameter
is not specified, all users with access to the page are considered voters.

viewers

false

all users

This is a comma seperated list of usernames to who are allowed to see the survey results.
Users not in this list will be allowed to vote but
after doing so will simply be shown which item they voted for. If a user is in this
list but is not a voter, they will be taken straight to the results. If this parameter is not specified,
all users will be able to see the results.

changeableVotes

false

false

This parameter, if set to true, will allow the voters to change their vote
after it has been cast.

{survey:changeableVotes=true|voters=user1,user2|viewers=user3}
Knowledge - This is the knowledge category.
Communication - This is the communication category.
{survey}

The survey macro allows Confluence users to be surveyed on several categories.
For each category, users are allowed to select only one of the given choices,
and the results will not be visible to them until they have voted. Users
that have not logged in will be prompted to do so before allowing them to
cast a vote. This macro was created to support surveys of confluence users
on several categories and will provide them with the chance to give a
rating (1 to 5) for each category as well as a comment.

The body of this macro defines the categories that the users will be polled
on. Each line of the body will be treated as a seperate category and
should be written in the format "title - description". The title is
always required but the dash and the description are optional.

Parameter

Required

Default

Description

title

false

default no title

If a Title is specified the Survey gets a Box around which makes it looking more compact
and feeling the votes are belonging more together.

voters

false

all users

This is a comma seperated list of usernames to who are allowed to
cast a vote. Users not in this list will not be allowed to vote, but
if they are viewers will be shown the results of the vote. If this parameter
is not specified, all users with access to the page are considered voters.

viewers

false

all users

This is a comma seperated list of usernames to who are allowed to see the survey results.
Users not in this list will be allowed to vote but
after doing so will simply be shown which item they voted for. If a user is in this
list but is not a voter, they will be taken straight to the results. If this parameter is not specified,
all users will be able to see the results.

changeableVotes

false

false

This parameter, if set to true, will allow the users to change their responses
after they have been cast.

choices

false

default 1-5

A comma separated List of choices. This will override the Default (1-5) List, but can still be overriden by
a '-' separated list in each single line.

showComments

false

true

Show comments-menu (the whole set: show, add, edit, delete)

locked

false

false

Dont allow any further voting. Show a lock Symbol to indicate that.
Image for Survey will only be displayed if you have the title-flag also. (It is still shown on the vote-elements)