Biggest heading

Bigger heading

Big Heading

Normal Heading

Small Heading

Smallest Heading

Example:

Some block quoted text

Quote a block of text that's longer than one paragraph.

here is quotable
content to be quoted

Example: look ma, red text!

Example: pagetitle

If such a page doesn't already exist, it will allow you to create the page in the current space. Create page links will have a after them.

Example: anewpage

Example: link alias

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

Example:

• /2004/01/12/Blog Post
  
• my link name

Examples:

• /2004/01/12/Blog Post
• my link name

Examples:

• Re: Webwork 2 Upgrade
• my link name

Examples:

• spacekey
• custom link title
• [nosuchspace:]

Examples:

• User Full Name
• custom link title
• [~nosuchuser]

Examples:

• confluence@Google
• custom link text

Note: the [] around external links are optional in the case you do not want to use any alias for the link.

Examples:

• http://confluence.atlassian.com
• Atlassian

Example: legendaryservice@atlassian.com

This only works on Internet Explorer
Creates a link to file on your computer or on a network share that you have mapped to a drive

Redirects the browser to the specified page or URL. Note: To allow editing of a page once it has been redirected, add '?redirect=false' to the query string.

• [default]/location - (required) The page or URL to redirect to.
• delay - (optional) The number of seconds to delay before redirecting.

Creates an alias for the current page. Any references to the alias will be redirected to this page.

• [default] - The alias. Must follow standard page naming conventions.
• parent - (optional) The parent the alias should have. May be set to any page in the current space. It will default to having no parent. It may also be one of two special parent markers:
  • @self - the parent will be the page being aliased.
  • @parent - the parent will be the parent of the page being aliased.

A macro that allows you to quickly create links to content at http://confluence.atlassian.com.

• Default parameter — The link to the content relative to http://confluence.atlassian.com.
• Macro body — The link text, interpreted as wiki markup.

Example:

• some
• bullet
• indented
• bullets
• points

Example:

• different
• bullet
• types

Example:

1. a
2. numbered
3. list

# a
# numbered
#* with
#* nested
#* bullet
# list

* a
* bulletted
*# with
*# nested
*# numbered
* list

Example:

1. a
2. numbered
   • with
   • nested
   • bullet
3. list

• a
• bulletted
  1. with
  2. nested
  3. numbered
• list

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.

What you need to type	What you will get
{dynamictasklist:Arthurs To-Do's}

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

• allowAnonymous - false stops anonymous from rating this content (default: true)
• allowUsers - false stops logged in users from rating this content (default: true)
• theme - the theme to use (basic, v2 - default: v2)

The {rate-search} macro uses a smart list to find content based around the rating stats.
Examples:

Generic

• maxResults - the maximum number of results to return
• spaces - the comma separated list of spaces to search through
• minRates - the minimum number of rates needed for inclusion in the results

Theme: v2 (default)

• hideSpace - if true, hides the output of the space in the listings

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:

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

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

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.

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

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.

The code given here produces a table that looks like:

Defines a single column.

• width: - (optional) the width of the column.

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.

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.

Converts csv and other deliminated data into a table. CSV is not a formal standard, but the best reference is The Comma Separated Value (CSV) File Format. The support in this macro comes close to following this pseudo-standard. For more details see SCRP-16. This macro shares common table capabilities with other table based macros (excel, table-plus, and sql).

• 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 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.
• border - The border width in pixels. Defaults to normal table border width.
• width - The table width in pixels. Default is 100%.
• 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.
• width - The table width in pixels. Default is 100%.
• border - The border width in pixels. Defaults to normal table border width.
• 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

Common table capabilities

A javascript enabled browser is required to enable these capabilities. A number of table based macros (table-plus, csv, excel, and sql) share these common capabilities.

• Column sorting - sort a column by clicking on column heading. Clicking again will reverse the order. Auto sorting before display
• Row highlighting on mouse over - row is highlighted when mouse goes over any row element for non-heading rows
• Column attributes - ability to set the display attributes (color, font) on a column basis
• Auto numbering - ability to automatically add a leading column with the data row count.
• Auto totaling - ability to automatically add a footing row that totals all numeric columns.

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.

Example:

// Some comments here
public String getFoo()
{
  return foo;
}

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

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

Displays a chart using data from the supplied table or tables.

• Chart type parameters - These parameters change what type of chart to display and the way the chart looks.
  • type - The type of chart to display. The following chart types are available:

    Standard charts

    • pie (default)
    • bar
    • line
    • area

    XY plots - The standard XY plot has numerical x and y axes.The x values may optionally be time based. See timeSeries.

    • xyArea
    • xyBar
    • xyLine
    • xyStep
    • xyStepArea
    • scatter
    • timeSeries

    Other charts

    • gantt - beta - See Gantt Charts.
    
    
  • orientation - A bar, line, or area chart will be displayed vertically (y axis is vertical) unless 'orientation=horizontal' is specified.
  • 3D - A pie, bar, or line chart will be shown in 3D if 3D=true is specified.
  • stacked - A bar or area chart will be shown with stacked values if stacked=true is specified.
  • showShapes - Shapes will be shown at each data point in a line chart unless showShapes=false.
  • opacity - A percent value between 0 (not visible) and 100 (non-transparent) that determines how opaque the foreground areas and bars display. Defaults are:
    • 75 percent for 3D charts
    • 50 percent for non-stacked area charts
    • 100 percent for all other charts
• Display control parameters
  • width - The width of the chart in pixels (default is '300')
  • height - The height of the chart in pixels (default is '300')
  • 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.
  • dataOrientation - The data tables will be interpreted as columns (horizontally) representing domain and x values unless 'dataOrientation=vertical'.
  • 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
    • up45 - 45 degrees going upward
    • up90 - 90 degrees going upward
    • down45 - 45 degrees going downward
    • down90 - 90 degrees going downward
  • dateTickMarkPosition - placement of the date tick mark
    • start (default) - tick mark is at the start of the date period
    • middle - tick mark is in the middle of the date period
    • end - tick mark is at the end of the date period
• Pie chart customization parameters
  • pieSectionLabel - Format for how pie section labels are displayed. :
    • %0% is replaced by the pie section key.
    • %1% is replaced by the pie section numeric value.
    • %2% is replaced by the pie section percent value.
    Example 1: "%0% = %1%" would display something like "Independent = 20"
    Example 2: "%0% (%2%)" would display something like "Independent (20%)"
  • 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.

Colors

Date Format

Copied from Java SimpleDateFormat specification.

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):

• 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:

       GMTOffsetTimeZone:
               GMT Sign Hours : Minutes
  
       Sign: one of
               + -
       Hours:
               Digit
               Digit Digit
  
       Minutes:
               Digit Digit
       Digit: one of
               0 1 2 3 4 5 6 7 8 9

  Hours must be between 0 and 23, and Minutes must be between 00 and 59. The format is locale independent and digits must be taken from the Basic Latin block of the Unicode standard.

  For parsing, RFC 822 time zones are also accepted.

• RFC 822 time zone: For formatting, the RFC 822 4-digit time zone format is used:

       RFC822TimeZone:
               Sign TwoDigitHours Minutes
       TwoDigitHours:
               Digit Digit

  TwoDigitHours must be between 00 and 23. Other definitions are as for general time zones.

  For parsing, general time zones are also accepted.

Provides an advanced style search interface, obtaining the results inline using AJAX / DWR.

See Also: Plugin Homepage and Documentation

The page-info is used for retrieving information about the current page

• displayType - required - selects the kind ad style of data displayed
  • created-user - displays the user who created the page
  • created-date - displays the date the page was created
  • modified-user - displays the user who last modified the page
  • modified-users - displays a list of all the users who have modified the page
  • modified-date - displays the date the page was last modified
  • participants - displays a list of the users who have modified or commented on the page
  • commenters - displays a list of the users who have commented on the page
  • current-version - displays the most recent version number for the page
  • versions - displays a comma separated list of version numbers, clickable to take you to view that version
  • diffs - displays a list of version numbers, clickable to take you to view the differences between that version and the next version
  • labels - displays a list of labels, clickable to take you to view that label
  • title - displays the title of the specified page
  • tinyurl - displays a tinyurl link to the specified page
  • pageID - displays the ID of the specified page
• page - optional - selects the page for which information is being retrieved, if unspecified the current page is used
• dateFormat - optional - selects the format for displaying dates, only effective with those displaytypes that display a date, defaults as specififed in confluence general config
• prefix - optional - selects the prefix applied to lists
• reverse - optional - reverses the order of the items found (versions & diffs only)
• count - optional - sets the number of items to be displayed (versions & diffs only)
• type - optional - displays lists of information as a flat comma separated list (default), or as an unordered list
• wrap - optional - wraps lists in a span (default true)
• caption - optional - caption to use with tinyurl links (@tinyid, @tinyurl, @title - default=title)

See Also: User Guide and Examples

Displays version history data about a page in a tabular format

• page - selects the page for which information is being retrieved, if unspecified the current page is used
• dateFormat - selects the format for displaying dates, only effective with those displaytypes that display a date, defaults as specififed in confluence general config
• reverse - displays data in reverse revision order when set to true
• first - limits the number of entries displayed

See Also: User Guide and Examples

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.

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.

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.
• label(s) - (optional) the list of labels to check the page has. E.g: "labels=one, two" or "labels=+one, -two"
• 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.

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.
• label(s) - (optional) the list of labels to check the page has. E.g: "labels=one, two" or "labels=+one, -two"
• header - (optional) The (list of) headers.
• 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.

Includes HTML data into a Confluence page. HTML and BODY tags are removed when output=html so the display of the Confluence page is not disrupted.

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

• output - Determines how the output is formated:
  • html - Data is output as HTML (default).
  • wiki - Data is surrounded by a {noformat} macro.
• script - Location of HTML data. Default is the macro body only. If a location of data is specified, the included data will follow the body data.
  • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • #http://... - Data is read from the URL specified.
  • ^attachment - Data is read from an attachment to the current page.
  • page^attachment - Data is read from an attachment to the page name provided.
  • space:page^attachment - Data is read from an attachment to the page name provided in the space indicated.
• noPanel - When output=wiki, show the data within a panel (default) unless nopanel=true.

Transforms XML to a Confluence page via an XSLT style sheet. Note that macro parameters not recognized by the xslt macro are automatically passed through to the xslt engine.

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

• output - Determines how the output is formated:
  • html - Data is output as a HTML (default).
  • wiki - Data is output as Confluence wiki text. Use this option if you want the data to be formated by the Confluence wiki renderer.
• source - Location of source XML code. Default is the macro body.
  • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • #http://... - Data is read from the URL specified.
  • 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.
• style - Location of source XSL code. Required if source XML is in the macro body, otherwise defaults to the macro body.
  • #filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
  • #http://... - Data is read from the URL specified.
  • 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.

{newcode}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code. The language defaults to Java.

{newcode:vbnet}
Public Module Test
  Public Sub Main()
    Console.WriteLine("Hello World!");
  End Sub
End Module
{newcode}

{newcode:language=vbnet}
Public Module Test
  Public Sub Main()
    Console.WriteLine("Hello World!");
  End Sub
End Module
{newcode}

Specify the language using the default parameter of the "lang" parameter.

{newcode:title=Test title}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, including a title.

{newcode:collapse=true}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a collapsed version of syntax highlighted version of the code.

{newcode:linenumbers=false}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, without line numbers.

{newcode:firstline=10}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, without an alternative number as the first line.

{newcode:ruler=true}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, with a ruler to indicate the columns.

{newcode:theme=django}
public class Test {
  public static void main (String[] args) {
    System.out.println("Hello World!");
  }
}
{newcode}

Shows a syntax highlighted version of the code, without an alternative theme.

Indcludes the content of the first child of a page based on a sort order

Parameters:

• location - The location to list (default - all)
• bundled - show bundled plugin links (default - true)
• icons - show icons for links (default - true)
• name - show link name (default - true)
• description - show link desricption (default - false)
• divider - divider between name & description (default ' - ')
• separators - show separators between locations (default - true)

See Also: User Guide and Examples

Used to force the collapse/display of the sidebars on a page-by-page basis

Parameters:

• default - the sidebar to be affected (left/right)
• collapse - should the sidebar be collapsed? (true/false)
• force - override any cookie stored value for the state (true/false - default false)

See Also: User Guide and Examples

creates a child page to the current page (if it doesnt already exist)

Parameters:

• 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
  
• render - pre-render the child page (default false)
• parent - The parent page (default = @self)
  • 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 - an alternate way of specifying the parent space (default param takes precedence)
• page - an alternate way of specifying the parent page (default param takes precedence)

See Also: User Guide and Examples

Used to display a menubar

Parameters:

• _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)

See Also: User Guide and Examples

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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• size - the size of the icon to use
• 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.

See Also: User Guide and Examples

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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• size - the size of the icon to use
• 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.

See Also: User Guide and Examples

Used to create a menu

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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• 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.

See Also: User Guide and Examples

Used to create a submenu

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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• 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.

See Also: User Guide and Examples

Used to create a submenu

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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• 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.

See Also: User Guide and Examples

Used to create a menuitem

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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• 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.

See Also: User Guide and Examples

Used to create a menuitem which contains a menulink and icon

Parameters:

• caption - the text to use in the link
• default - the piece of confluence functionality you wish to link to
  • RSS - go to rss feed editor
  • activity - show site/space activity
  • advanced - go to advanced config page
  • browse - link to browse space
  • builderadmin - link to builder administration
  • children - show/hide children toggle
  • colourscheme - go to colour scheme selector
  • comments - show/hide comments toggle
  • chooselayout - choose the layout
  • copy - copy the current page
  • custom - define a custom link
  • dashboard - go to dashboard
  • edit - edit the current page
  • emailpage - link to email page action
  • exportMail - export email to page
  • exportPDF - export page to pdf
  • exportWord - export page to word doc
  • favourite - add page to favourites
  • favouritespace - add space to favourites
  • first - the first sibling page
  • firstchild - the first child page
  • globaltemplates - display list of global templates
  • globallabels - show global labels heatmap
  • history - show account history
  • home - go to space home page
  • index - go to space index
  • information - show page information
  • labels - show labels heatmap
  • last - the last sibling page
  • lastchild - the last child page
  • login - go to login screen
  • logout - log out
  • mail - show space email
  • managelayouts - link to manage layouts
  • map - go to space map
  • move - move a page
  • newcomment - add a comment
  • newnews - create a new blogpost
  • newpage - create a new page
  • news - view space news
  • newspace - create a new space
  • next - the next sibling page
  • normalView - view page as normal
  • notationguide - link to the macro notation guide
  • pageView - view the page in normal mode
  • pageattachments - show page attachments
  • parent - the current page's parent
  • people - show the people directory
  • prev - the previous sibling page
  • printableView - view page as printable
  • profile - show user profile
  • recent - view recently updated in space
  • remove - delete the current page
  • search - links to the search screen
  • signup - create a new account
  • siteadmin - go to site administration
  • spaceadmin - go to space administration
  • spaceattachments - display space attachments
  • spacetemplates - display list of space templates
  • tinyurl - link to the current page using the tiny url syntax
  • trimcomments - trim the comments of the current page
  • toggleSidebar - toggle the visibility of a sidebar
  • toggleVisibility - toggle the visibility of an html element
  • use-layout - change the layout
  • userspace - show user's space
  • viewSource - view the page source
  • viewattachments - show page attachments without checking attachment permission
  • watch - watch current page/space
  • watchspace - watch current space
  • webui - show a webui link, requires location & key parameters
  • wikipage - link to the page specified by the page & space parameters
• 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)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (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.

See Also: User Guide and Examples

Inserts a separator into a menu

Parameters:

• class - The CSS class name to assign

See Also: User Guide and Examples

Inserts a gif/png icon from the embedded library, see the userguide for more details

Parameters:

• size - the size the icon should be displayed at
• tooltip - the alternate description that should be used for the icon
• force - force the menu icon to be displayed regardless of menu settings

See Also: User Guide and Examples

Generates a link to the specified piece of confluence functionality, see the userguide for more information

Parameters:

• default - the piece of confluence functionality you wish to link to
  • RSS - go to rss feed editor
  • activity - show site/space activity
  • advanced - go to advanced config page
  • browse - link to browse space
  • builderadmin - link to builder administration
  • children - show/hide children toggle
  • colourscheme - go to colour scheme selector
  • comments - show/hide comments toggle
  • chooselayout - choose the layout
  • copy - copy the current page
  • custom - define a custom link
  • dashboard - go to dashboard
  • edit - edit the current page
  • emailpage - link to email page action
  • exportMail - export email to page
  • exportPDF - export page to pdf
  • exportWord - export page to word doc
  • favourite - add page to favourites
  • favouritespace - add space to favourites
  • first - the first sibling page
  • firstchild - the first child page
  • globaltemplates - display list of global templates
  • globallabels - show global labels heatmap
  • history - show account history
  • home - go to space home page
  • index - go to space index
  • information - show page information
  • labels - show labels heatmap
  • last - the last sibling page
  • lastchild - the last child page
  • login - go to login screen
  • logout - log out
  • mail - show space email
  • managelayouts - link to manage layouts
  • map - go to space map
  • move - move a page
  • newcomment - add a comment
  • newnews - create a new blogpost
  • newpage - create a new page
  • news - view space news
  • newspace - create a new space
  • next - the next sibling page
  • normalView - view page as normal
  • notationguide - link to the macro notation guide
  • pageView - view the page in normal mode
  • pageattachments - show page attachments
  • parent - the current page's parent
  • people - show the people directory
  • prev - the previous sibling page
  • printableView - view page as printable
  • profile - show user profile
  • recent - view recently updated in space
  • remove - delete the current page
  • search - links to the search screen
  • signup - create a new account
  • siteadmin - go to site administration
  • spaceadmin - go to space administration
  • spaceattachments - display space attachments
  • spacetemplates - display list of space templates
  • tinyurl - link to the current page using the tiny url syntax
  • trimcomments - trim the comments of the current page
  • toggleSidebar - toggle the visibility of a sidebar
  • toggleVisibility - toggle the visibility of an html element
  • use-layout - change the layout
  • userspace - show user's space
  • viewSource - view the page source
  • viewattachments - show page attachments without checking attachment permission
  • watch - watch current page/space
  • watchspace - watch current space
  • webui - show a webui link, requires location & key parameters
  • wikipage - link to the page specified by the page & space parameters
• 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.

See Also: User Guide and Examples

Used for simplifying menu configuration by allowing the view menu to be edited separately, and then injected into another menu using this macro.

Parameters:

• hideanon - hide the menu to anonymous users (default false)

See Also: User Guide and Examples

Used for simplifying menu configuration by allowing the edit menu to be edited separately, and then injected into another menu using this macro.

Parameters:

• hideanon - hide the menu to anonymous users (default false)

See Also: User Guide and Examples

Allows menus to be created using wiki markup or macros which return an unordered list

See Also: User Guide and Examples

Allows additions to be made to menulink replacements

Parameters:

• default - The replacement text

See Also: User Guide and Examples

Inserts the confluence space/site logo into a builder panel

Parameters:

• global - force macro to display global logo
• class - HTML classname to apply
• tooltip - tooltip to give the logo
• space - the space whose logo should be shown

See Also: User Guide and Examples

Inserts the confluence breadcrumb trail into a builder panel

Parameters:

• forceexpansion - When true, breadcrumbs will always be expanded.

See Also: User Guide and Examples

Returns the title of the current page/action

See Also: User Guide and Examples

Includes the confluence personal sidebar into a builder panel

See Also: User Guide and Examples

Inserts the confluence quick label editor into a builder panel

See Also: User Guide and Examples

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)
• recurse - check the page's parents for the value (default false)
• withuser - username that user/group/permission checks should be run against (inc @anonymous, @creator, @author, @current - default = @current)
• user - comma separated list of usernames that should view the content (inc @anonymous, @creator & @author)
• group - comma separated list of groups whose members should should view the content (inc @anonymous, @creator & @author)
• permission - comma separated list of permissions who can view the content (view, comment, label, createpage, createnews, edit, remove, attach, export, createspace, spaceadmin, siteadmin)
• 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
• locale - a comma separated list of locales (eg: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr__MAC") 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)

See Also: User Guide and Examples

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)
• recurse - check the page's parents for the value (default false)
• withuser - username that user/group/permission checks should be run against (inc @anonymous, @creator, @author, @current - default = @current)
• user - comma separated list of usernames that should not view the content (inc @anonymous, @creator & @author)
• group - comma separated list of groups whose members should not should view the content (inc @anonymous, @creator & @author)
• permission - comma separated list of permissions who cannot view the content (view, comment, createpage, createnews, edit, remove, attach, export, createspace, spaceadmin, siteadmin)
• 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
• locale - a comma separated list of locales (eg: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr__MAC") 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)

See Also: User Guide and Examples

Inserts the confluence favourite icon into a builder panel

See Also: User Guide and Examples

Inserts the confluence watch icon into a builder panel

See Also: User Guide and Examples

Inserts the confluence comments display and editor into a builder panel

See Also: User Guide and Examples

Inserts the confluence comments display and editor into a builder panel

See Also: User Guide and Examples

Inserts the confluence children display into a builder panel

See Also: User Guide and Examples

Returns the title of the current space when executed within a space, otherwise returns the site title

Parameters:

• sitetitle - when set to true the site title is always returned
• global - when set to false nothing is returned when viewing a non-space page
• prefix - characters to prefix the title with
• postfix - characters to postfix the title with
• space - the space whose title should be shown

See Also: User Guide and Examples

Inserts the confluence info-panel display into a builder panel

See Also: User Guide and Examples

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
• render - whether to wiki-render the imported content (default true)
• output - whether to output the imported content (default true)

See Also: User Guide and Examples

Used to move a chunk of HTML from one place to another on the client-side. Useful for creating areas in panels that are populated with data from pages.

Parameters:

• target - the html id of the destination
• hidesource - whether the source should be hidden while the page loads (defaults to true)
• showtarget - whether to show the target after copying or not (defaults to true)
• server - perform the move on the server side (defaults to true)

See Also: User Guide and Examples

Used to set down a place-marker for server-side moves.

Parameters:

• target - the id of the move target (used as the destination target in the move-to macro)

See Also: User Guide and Examples

Used to set the layout used for the current page.

Parameters:

• default - the layout Id of the layout to be used
• latch - true = latch the layout for the remainder of the session / false = remove any latched layout

See Also: User Guide and Examples

Returns an unordered list of all permitted spaces

Parameters:

• default - Filter the list of spaces (all/global/personal - default all)
• teams - A comma separated list of team labels that are used to filter the list of spaces
• display - 'list' the spaces as a flat list, or display them as a 'tree' (default list)
• depth - the maximum depth of the spaces tree (only valid in tree view)
• root - the root node of the tree (@current/@global/@personal/@dashboard only valid in tree view, defaults to current space when used in a space, or dashboard when not)
• showRoot - show the root node of the tree (only valid in tree view)
• reverse - List the spaces in reverse order (only valid in list view)
• count - The number of spaces that should be displayed (only valid in list view)
• start - Offset from the start for listing the spaces (only valid in list view)

See Also: User Guide and Examples

A flexible hierarchical tree view (site map) of Confluence content

Parameters:

• _default_ - The root of the pagetree (defaults to space)
  • 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
  • @dashboard - the Confluence dashboard showing all spaces the user has access to
• space - the space that should be used for the root of this pagetree (optional)
• page - the name of the page that should be use for the root of this pagetree (optional)
• target - the target window that the pages should open into (eg. _blank or _self)
• showIcons - whether to show icons in the tree (default true)
• selectionMode - the default click selection mode: node (default) or row
• autoCollapse - automatically collapse other nodes when a node is expanded: false (default) or true
• indent - indent each layer of the tree: true (default) or false
• showRoot - display the root node: true (default) or false
• branchStyle - the branch style (may be deprecated in future release)
• plus-lines: +/- buttons, dotted lines
• plus-nolines: +/- buttons, no lines
• ball-lines: yellow sphere buttons, dotted lines
• ball-nolines: yellow sphere buttons, no lines
• arrow: green arrow buttons, no lines
• iconStyle - the icon style:
  • computer - computer style icons
  • website - website style icons
  • builder - Adaptavist's Builder style icons
  • bookshelf - bookshelf style icons
• class - the css class to attach to the pagetree
• openpage - open the selected page on click: true (default) or false
• allowdrag - allow pages to be moved in the space/site by dragging and dropping in the tree: false (default) or true
• treename - the name of the tree (used with pagepanel macro)
• titletip - use the page title as the tooltip
• initialDepth - restrict the expansion at startup to x levels
• sort - sort pages in natural/modified/creation date order
• reverse - reverse the chosen order

See Also: User Guide and Examples

Displays a sorted list of child pages, may also be used to generate a 'sparse tree' of parent pages and spaces.

Parameters:

• _default_ - Page whose children are to be listed
  • SPACEKEY:pagename - a specific page in a specific space
  • pagename - a specific page in the current space
  • @self - the current page (default)
  • @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
  • @dashboard - the Confluence dashboard showing all spaces the user has access to
• space - an alternate way of specifying the space (default param takes precedence)
• page - an alternate way of specifying the page (default param takes precedence)
• showRoot - show the root page (default - false)
• showSpaceSiblings - when displaying the path from @dashboard, list the space's siblings (default - true)
• showPageSiblings - when displaying the path from @dashboard, @parent, @parentparent, @space, @orphan, @root or @home, list the parent page's siblings (default - true)
• filter - only show spaces of type global/personal/all - used with @dashboard root (default - all)
• depth - the depth of children to be shown (default - 1)
• countParentPages - include the parent pages in the depth count (default - false)
• countParentSpaces - include the parent spaces in the depth count (default - false)
• class - the css classname to apply to the list

See Also: User Guide and Examples

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)

Replacements:

• %withceoid% - the id of the page
• %withceotitle% - the title of the page
• %withceoname% - the title of the page
• %withpageid% - the id of the page
• %withpagetitle% - the title of the page
• %withpagename% - the title of the page

See Also: User Guide and Examples

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)

Replacements:

• %withancestorid% - the id of the page
• %withancestortitle% - the title of the page
• %withancestorname% - the title of the page

See Also: User Guide and Examples

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)

Replacements:

• %withdescendantid% - the id of the page
• %withdescendanttitle% - the title of the page
• %withdescendantname% - the title of the page

See Also: User Guide and Examples

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)

Replacements:

• %withsiblingid% - the id of the page
• %withsiblingtitle% - the title of the page
• %withsiblingname% - the title of the page

See Also: User Guide and Examples

Used to output a list of other pages

Parameters:

• 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)
• 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

See Also: User Guide and Examples

Used output a list of other pages

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
• 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)
• 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

See Also: User Guide and Examples

Used output a list of other pages

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
• 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)
• 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

See Also: User Guide and Examples

Used to output a list of other pages

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
• 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)
• 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

See Also: User Guide and Examples

Indcludes the content of the first child of a page based on a sort order

Parameters:

• _default_ - Page whose whose child should be shown
  • 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 - an alternate way of specifying the space (default param takes precedence)
• page - an alternate way of specifying the page (default param takes precedence)
• sort - the sort order that decides which child should be shown (creation/modified/recent/confluence)

See Also: User Guide and Examples

Adds page level restrictions to the current page (if you have permission to set permissions)

Parameters:

• edit - comma separated list of users or groups that can edit the page
• view - comma separated list of users or groups that can view the page

See Also: User Guide and Examples

Includes the content of a blog-post in a page/panel

Parameters:

• default - the blog to include in year/month/day/title format
• space - the space in which the blog can be found (default = current space)

See Also: User Guide and Examples

Generates a nested list of links to blog posts

Parameters:

• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal/@children/@children:PARENTSPACEKEY - default @current)
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of usernames/group names/@self/@creator/@owner
• sort - The order that the posts should be listed in (creation/modified/recent - default creation)
• reverse - List the blogposts in reverse order (default=true - oldest first)
• count - The number of posts that should be displayed (default = all)
• start - Offset from the start for listing the posts (default = 0)
• years - Nest list for each year (default - true)
• months - Nest list for each month (default - true)
• days - Nest list for each day (default - false)
• posts - Show links to each post (default - true)
• excerpt - Include the excerpt in the post display (default - true)
• none - Text to display when no posts have been found

See Also: User Guide and Examples

Displays a list of blog posts and excerpts

Parameters:

• default - display mode (singlespace/multispace)
• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal/@children/@children:PARENTSPACEKEY - default @current)
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of usernames/group names/@self/@creator/@owner
• sort - The order that the posts should be listed in (creation/modified/recent - default creation)
• reverse - List the blogposts in reverse order (default=false - most recent first)
• count - The number of posts that should be displayed (default=9)
• start - Offset from the start for listing the posts (default=0)
• dateFormat - Format that dates should be displayed in (default=defined by confluence settings)
• title - Show the Title of the blogpost (default=true)
• linktitle - Link the title to the blogpost (default=true)
• excerpt - Display the excerpt of the blogpost (true/false/full - default true)
• postedby - Display the date that the post was created (true/false/date default true)
• permalink - text to use for tiny url (set as blank to omit tinyURL)
• postedByCaption - text to use for posted by
• none - Text to display when no posts have been found

See Also: User Guide and Examples

Generates RSS 2.0 xml

Parameters:

• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal/@children - default @current)
• author - A comma separated list of usernames/group names/@self/@creator/@owner
• label - A comma separated list of labels that are used to filter the list of blogposts
• sort - The order that the posts should be listed in (creation/modified/recent - default creation)
• reverse - List the blogposts in reverse order (default=false - most recent first)
• count - The number of posts that should be displayed (default=9)
• start - Offset from the start for listing the posts (default=0)
• dateFormat - Format that dates should be displayed in (default=defined by confluence settings)
• feedTitle - The title of the rss feed
• feedDesc - The descripion of the rss feed
• none - Text to display when no posts have been found

See Also: User Guide and Examples

Tells builder to include an rss feed definition in the header of the document

Parameters:

• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal/@children - default @current)
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of usernames/group names/@self/@creator/@owner
• sort - The order that the posts should be listed in (creation/modified/recent - default creation)
• reverse - List the blogposts in reverse order (default=false - most recent first)
• count - The number of posts that should be displayed (default=9)
• start - Offset from the start for listing the posts (default=0)
• dateFormat - Format that dates should be displayed in (default=defined by confluence settings)
• feedTitle - The title of the rss feed
• feedDesc - The descripion of the rss feed
• none - Text to display when no posts have been found

See Also: User Guide and Examples

Displays a the blog calendar

Parameters:

• space - The space whose posts should be shown
• date - the month which should be shown (@context/@today/@creation/@modified/MMyyy - default @context)

See Also: User Guide and Examples

Inserts the confluence quick-search box into a builder panel

See Also: User Guide and Examples

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_ - Page whose children the excerpt should be randomly selected 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 - an alternate way of specifying the space (default param takes precedence)
• page - an alternate way of specifying the page (default param takes precedence)
• title - output the page title (default - true)
• link - add more link to the page whose excerpt is being displayed (default - true)
• more - text to use for the link to the page (default - 'More ...')
• label - comma separated list of labels which the content must have at least one for it to be shown
• class - the css classname to add to the outer div
• count - the number of excerpts to be shown (default 1)
• hide - whether to hide the extra excerpts or not (default false)

See Also: User Guide and Examples

Sets a flag to be read by the builder-show/hide flag parameter

Parameters:

• _default_ - the flag name
• state - the state of the flag - true/false/remove (default true)
• type - the type of flag to set request/session/user (default request)
• 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

See Also: User Guide and Examples

Returns the username of the currently viewed profile, or blank if not viewing a profile

See Also: User Guide and Examples

Inserts the confluence 'added by' display into a builder panel

See Also: User Guide and Examples

Displays the description of the named space

Parameters:

• _default_ - The space whose description should be shown (default - current)

See Also: User Guide and Examples

Retrieves the value of an i18n key

Parameters:

• default - the 118n key to be retrieved
  

See Also: User Guide and Examples

Displays a layout resource as an image

Parameters:

• default - the resource that should be displayed as an image.
  
• tooltip - the tooltip to apply to the image.
  
• class - the css class to apply to the image.
  

See Also: User Guide and Examples

Displays a list of spaces that contain blog-posts

Parameters:

• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal/@children/@children:PARENTSPACEKEY - default @current)
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of usernames/group names/@self/@creator/@owner
• count - The number of spaces that should be displayed (default=9)

See Also: User Guide and Examples

Displays a simple table of all the content (pages, comments, blog posts, user profiles and space descriptions) created by a user (here 'fred').

Displays an index of all the pages in the current space, cross linked and sorted alphabetically.

The user viewing the page must have permission to view the page being included, or it will not be displayed.

Prints a simple note to the user.

• title: - (optional) the title of the note.
• icon: - (optional) if "false", dont display the icon.

Be Careful The body of the note here..

Prints a warning note to the user.

• title: - (optional) the title of the warning.
• icon: - (optional) if "false", dont display the icon.

Warning Insert warning message here!

Prints an informational note.

• title: - (optional) the title of the information box.
• icon: - (optional) if "false", dont display the icon.

Useful Information This macro is useful for including helpful information in your confluence pages

Prints a helpful tip for the user.

• title: - (optional) the title of the tip.
• icon: - (optional) if "false", dont display the icon.

Handy Hint Join the Confluence Mailing-List!

Provides a configurable form mail system, submitting using AJAX / DWR.

See Also: Plugin Homepage and Documentation

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)
• title - a name for the new page (disables prompting)
• target - whether to go to edit or view mode
• addImg - display the + sign next to the link (default = true)

See Also: User Guide and Examples

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

pre-formatted piece of text
so *no* further _formatting_ is done here

• 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:

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

See Also: User Guide and Examples

Makes the contained content clickable. The link can be a page title (including space key if desired) or a URL.

See Also: User Guide and Examples

Inserts a graphical lozenge panel, ideal for creating buttons, etc.

Parameters:

• link - if you want to link to a page, insert the page title or url
• icon - if you want to display an icon (48x48 pixels or smaller) in the left panel, use wiki notaiton for an image. Alternatively, specify normal text to display text in the left panel.
• color - the color of the left panel: bronze, silver (default), gold, blue, cyan, green, purple, pink, red
• arrow - display or hide the arrow in the left panel: none (default if no link), blue (default if link specified), green
• title - the title of the lozenge, also used as the tooltip for links
• width - the width of the entire lozenge specified as pixels (347px default), percentage (eg. 70%) or auto to stretch to fit contents.

See Also: User Guide and Examples

Inserts a trade mark: Builder Hosting^TM

See Also: User Guide and Examples

Inserts a service mark: Builder Hosting^SM

See Also: User Guide and Examples

Inserts a registered trade mark: Adaptavist^�

See Also: User Guide and Examples

Inserts a copyright statement: � 2005 Adaptavist.com Ltd.

See Also: User Guide and Examples

Insert a style sheet in to your content.

• media - optionally specify which media types the style applies to, eg: print,aural,embossed
• import - optional URL for an external style sheet to import

See Also: User Guide and Examples

Wraps content in a span tag with optional class name and styles for the tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Sets the background color for a block of content. Colour names or hex values can be used.

There are several special pastel colours: yellow, red, blue, cyan, green (default) and purple.

See Also: User Guide and Examples

Sets the background color for a section of content such as a single word in a paragraph, etc. Colour names or hex values can be used.

There are several special pastel colours: yellow (default), red, blue, cyan, green and purple.

See Also: User Guide and Examples

Centers a block of content or text on the page or within a panel, etc.

See Also: User Guide and Examples

Attack text with a red marker just like your teacher used to at school!

See Also: User Guide and Examples

Display a privacy statement specific to a page. By default it will link to your full privacy policy on a page called "Privacy Policy

See Also: User Guide and Examples

Display a privacy indicator with optional tooltip. When clicked, the page will be focussed on a {privacy-policy} macro if present.

See Also: User Guide and Examples

Add a search box to your page:

• default - no parameters - Search the current space
• default - spacekey - Search a specific space, list of spaces, @all spaces, @personal spaces, @global spaces, @favourite spaces, @current space (default)
• teams - filter the list of spaces by team labels (only the selected space is searched)
• group - group results by space/type/@select
• lastModified - filter list of search results by last modified date (today/yesterday/lastweek/lastmonth/@select)
• type - only return objects of type (page/blogpost/mail/comment/attachment/userinfo/spacedesc/@select)
• globalText - The text to use for labeling global searches (Global Spaces)
• personalText - The text to use for labeling personal searches (Personal Spaces)
• favouritesText - The text to use for labeling global searches (Favourite Spaces)
• allText - The text to use for labeling global searches (All Spaces)
• buttonText - The text to use for the search button (Search)
• label - adds a label to the search input
• accesskey - adds an access key to the search button
• button - Display the search button (true/false)

See Also: User Guide and Examples

Inserts a graphical round rectangle, ideal for creating content areas, buttons etc.

Parameters:

• title - displays wiki content in the space above the main content area between the upper corners
• footer - displays wiki content in the space below the main content area between the lower corners
• bgcolor - the background color of the content area
• titlebgcolor - the background color of the title area (defaults to bgcolor)
• footerbgcolor - the background color of the footer area (defaults to bgcolor)
• width - the width of the entire roundrect specified as pixels (347px default), percentage (eg. 70%) or leave undefined to stretch to fit contents.
• height - the minimum height of the entire roundrect specified as pixels (347px default), percentage (eg. 70%) or leave undefined to stretch to fit contents.
• cornersize - defines the radius of the rounded corners
• hSize - overrides cornersize to allow setting of the width of the corners
• vSize - overrides cornersize to allow setting of the height of the corners
• corners - a comma separated list of flags stating which corners should be rounded: Top Left, Top Right, Bottom Left, Bottom Right (default is true,true,true,true)
• rows - a comma separated list of flags stating which rows should be displayed: Top, Middle, Bottom (default is true,true,true)
• antialias - use Adobe Flash to antialias the corners (default false)
• class - a list of classes to be applied to the roundrect table

See Also: User Guide and Examples

Wraps content in a div tag and sets the alignment mode as specified

Valid modes are left, right, center and justify. By default the {align} macro will justify your content.

See Also: User Guide and Examples

Injects a javascript CSS rollover effect into the outermost tag of the content contained by the rollover tag

Parameters:

• class - The class name for the 'normal' (roll-out) state
• over - An optional class name for the roll-over state (defaults to the '%class%-rollover'
• link - An option link to redirect the page to when the rollover is clicked
• target - An optional external target to also modify
• targetclass - An optional class name to use solely for the external target (defaults to class)
• targetover - An optional class name to use solely for the external target roll-over state(defaults to %targetclass%-rollover)

See Also: User Guide and Examples

Inserts comments into wiki markup, without arguments the macro produces an HTML comment in the output, when the 'hidden' flag is passed the comment is not output to HTML

See Also: User Guide and Examples

Creates a bulleted list that uses the specified image as the bullet

Parameters:

• _default_ - The image to use as the bullet in SPACEKEY:page^attachment format
• image - ann alternate way of defining the image
• id - a unique id
• padding - the padding to apply to the list items

See Also: User Guide and Examples

Displays a series of tests designed to put the content formatting macros through their paces

See Also: User Guide and Examples

Wraps content in a div tag with optional class name and styles for the tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code
• width - Sets the width of the element

See Also: User Guide and Examples

Wraps content in a div tag with optional class name and styles for the tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a graphical round rectangle, ideal for creating content areas, buttons etc.

Parameters:

• align - Specifies how to align the iframe according to the surrounding text
• frameborder - Specifies whether or not to display a frame border
• height - Defines the height of the iframe
• longdesc - A URL to a long description of the frame contents
• marginheight - Defines the top and bottom margins of the iframe
• marginwidth - Defines the left and right margins of the iframe
• name - Specifies a unique name of the iframe (to use in scripts)
• scroling - Define scroll bars
• src - The URL of the document to show in the iframe
• width - Defines the width of the iframe
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table cell.

Parameters:

• align - Specifies the horizontal alignment of cell content
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• span - Indicates the number of columns this colgroup should span
• valign - Specifies the vertical alignment of cell content
• width - Specifies the width of the table cell

See Also: User Guide and Examples

Inserts a table.

Parameters:

• align - Aligns the table
• bgcolor - Specifies the background color of the table
• border - Specifies the border width
• cellpadding - Specifies the space between the cell walls and contents
• cellspacing - Specifies the space between cells
• frame - Specifies how the outer borders should be displayed
• rules - Specifies the horizontal/vertical divider lines
• summary - Specifies a summary of the table for speech-synthesizing/non-visual browsers
• width - Specifies the width of the table
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table row.

Parameters:

• align - Defines the text alignment in cells
• bgcolor - Specifies the background color of the table cell. Deprecated. Use styles instead
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• valign - Specifies the vertical text alignment in cells
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table cell.

Parameters:

• abbr - Specifies an abbreviated version of the content in a cell
• align - Specifies the horizontal alignment of cell content
• axis - Defines a name for a cell
• bgcolor - Specifies the background color of the table cell
• char - Specifies which character to align text on
• 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
• valign - Specifies the vertical alignment of cell content
• width - Specifies the width of the table cell
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table heading cell.

Parameters:

• abbr - Specifies an abbreviated version of the content in a cell
• align - Specifies the horizontal alignment of cell content
• axis - Defines a name for a cell
• bgcolor - Specifies the background color of the table cell
• char - Specifies which character to align text on
• 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
• valign - Specifies the vertical alignment of cell content
• width - Specifies the width of the table cell
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a table body.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code
• align - Specifies the horizontal alignment of cell content
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• valign - Specifies the vertical alignment of cell content

See Also: User Guide and Examples

Inserts a table heading.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code
• align - Specifies the horizontal alignment of cell content
• char - Specifies which character to align text on
• charoff - Specifies the alignment offset to the first character to align on
• valign - Specifies the vertical alignment of cell content

See Also: User Guide and Examples

Creates an ordered list tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Creates an unordered list tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Creates a list item tag.

Do not include quotes in the class name or styles.

Parameters:

• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

Inserts a graphical round rectangle, ideal for creating content areas, buttons etc.

Parameters:

• alt - Defines a short description of the image
• src - The URL of the image to display
• align - Specifies how to align the image according to surrounding text
• border - Defines a border around an image
• height - Defines the height of an image
• hspace - Defines white space on the left and right side of the image
• ismap - Defines the image as a server-side image map
• longdesc - A URL to a document that contains a long description of the image
• usemap - Defines the image as a client-side image map. Look at the
• vspace - Defines white space on the top and bottom of the image
• width - Sets the width of an image
• id - A unique id for the element
• class - The class of the element
• title - Text to display in a tool tip
• style - An inline style definition
• dir - Sets the text direction
• lang - Sets the language code

See Also: User Guide and Examples

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.

Parameters:

• defaults - (optional) the link to the default property attachment. E.g. "Home^defaults.txt". This allows easy setting of defaults for multiple pages.

Properties:

• 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.tab.active.border - The border for the active tab (CSS - eg. '1px dashed black')
• deck.tab.active.background - The background for the active tab (CSS - eg. '#ff0055')
• deck.tab.inactive.border - The border for inactive tabs (CSS)
• deck.tab.inactive.background - The background for inactive tabs (CSS)
• deck.tab.spacer - The distance between tabs (eg '5px')
• deck.card.border - The border for the active card.
• deck.card.background - The background for the active card.
• 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.

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.

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 button to toggle a cloaked section between being visibile and hidden.
Note: Requires that {composition-setup} is placed above it in the page.

• id - (required) The unique ID of the cloaked section to toggle.
• exclusive - (optional) If true, all other sections at the same level will be cloaked when this is shown.

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.

Creates a new card. Must be inside a 'deck'. Only one card is visible at any given time.

• label - (required) The label to put on the tab.
• default - (optional) If true, the card will be the default. The last card in the deck marked as 'default' will be the default.
• accessKey - (optional) The key that, when combined with {{Ctrl}} will activate the card.
• class - (optional) The custom CSS class for the tab.
• nextAfter - The number of seconds the slide 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 this slide. May be 'fade' or 'none' (the default).
• effectDuration - The number of seconds the transition will take to complete. Eg. '1.5'

Shows a card in the specified deck.

• deck - (required) The id of the deck.
• 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.

• Flash (.swf)
• Quicktime movies (.mov)
• Windows Media (.wma, .wmv)
• Real Media (.rm, .ram)
• MP3 files (.mp3)

• width - the width of the media file
• height - the height of the media file
• id - the ID assigned to the embedded object

Prints a list of attachments

• patterns: - (optional) a comma separated list of regular expressions. Only file names matching one of these are displayed.
• old: - (optional) if "true", display old versions of attachments as well.
• upload: - (optional) if "true", allow the upload of new attachments.

Displays a list of bookmarks using the criteria supplied.

Searching Options

• spaces comma separated list of spaces to search for. Meta space names @all, @personal, @global can also be used. (If no labels and spaces are supplied will default to current space.)
• labels list of labels that are applied to the bookmarks. (If multiple labels are specified bookmarks only have to match one label to be included.)
• creators comma separated list of users that have created bookmarks.

Sorting Options

• sort comma separated list of attributes to sort the bookmarks by. Valid values are:
  • creation Bookmark Created Date
  • creator Bookmark Creator Name
  • title Bookmark title
  Default is by created date.
• reverseSort Reverse the order of the bookmarks. Default is false.

Display Options All options default to true.

• showAuthor The user that created the bookmark.
• showDate The relative date the bookmark was created.
• showDescription The bookmark description.
• 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

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

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.

Creates a Table of Contents for headings on the the current page.

• type - (optional) The type of output. May be one of the following:
  • list - (default) The headings are output in hierarchical list format.
  • flat - The headings are listed on a single line with a separator between them.
• class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
• style - (optional) The style of the list items if in list mode. The style may be any of the following:
  • none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
  • any CSS style - Headings are output in indented lists with the specified CSS style.
• outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
• ident - (optional) The amount to indent each list sub-heading by (default is '10px').
• separator - (optional) The type of separator to use if the style is flat. May be one of the following:
• bracket - Square brackets ('[', ']') surrounding each item. (default)
• brace - Square brackets ('[', ']') surrounding each item. (default)
• comma - A comma (',') between each item.
• paren - Parentheses ('(', ')') surrounding each item.
• pipe - A pipe ('|') between each item.
• newline - A line break after each item.
• "custom" - Any other character you wish, specified between quotes.
• minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
• maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
• include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
• exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
• printable - (optional) If set to 'false', the table of contents will not be visible when being printed.

Creates a Table of Contents for headings contained in the macro body.

• location - (optional) The location to have the table of contents output. May be 'top' or 'bottom'. If not set, it will be output at both locations.
• type - (optional) The type of output. May be one of the following:
  • list - (default) The headings are output in hierarchical list format.
  • flat - The headings are listed on a single line with a separator between them.
• class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
• style - (optional) The style of the list items if in list mode. The style may be any of the following:
  • none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
  • any CSS style - Headings are output in indented lists with the specified CSS style.
• outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
• ident - (optional) The amount to indent each list sub-heading by (default is '10px').
• separator - (optional) The type of separator to use if the style is flat. May be one of the following:
• bracket - Square brackets ('[', ']') surrounding each item. (default)
• brace - Square brackets ('[', ']') surrounding each item. (default)
• comma - A comma (',') between each item.
• paren - Parentheses ('(', ')') surrounding each item.
• pipe - A pipe ('|') between each item.
• newline - A line break after each item.
• "custom" - Any other character you wish, specified between quotes.
• minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
• maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
• include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
• exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
• printable - (optional) If set to 'false', the table of contents will not be visible when being printed.

Show search results keystroke by keystroke.

• spaceKey: - (optional) this option searches within a single space.

Creates a table of contributor information from the current page or a group of pages.

Table Options

• groupby - (optional) Specify if the table should be grouped by contributors or pages. Default value is contributors
• columns - (optional) Specify the columns that should appear in the table as a comma separated list. Default value is edits,comments,labels. Valid values:
  • edits Edit Count Column
  • edited List of pages or contributors
  • comments Comment Count Column
  • commented List of pages or contributors
  • labels Label Count Column
  • labeled List of pages or contributors
  • labellist List of labels
  • watches Watch Count Column
  • watching List of pages or contributors
  • lastupdate Last time a page was updated or a contributor changed some content.
• order - (optional) The order the contributors or pages will appear in. By default the table is ordered by the number of edits.
  • edits Orders the list with the highest number of edits first in the list
  • name Orders the list by name alphabetically
  • editTime Orders the list by the time they last edit time
  • update Order by the last update time of any content
• reverse - (optional) If true the sort order will be reversed.
• limit - (optional) Limit the number of contributors displayed to this amount
• showAnonymous - (optional) Show updates by anonymous users. Default is false.
• 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:
  • @all All Spaces
  • @global All Global Spaces
  • @personal All Personal Spaces
• contentType Valid options are:
  • pages
  • blogposts
  If not specified blog posts and pages are included.
• publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
• 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

Creates a list of contributors who have contributed to a page or a list of pages.

Display Options

• include - (optional) What type of content from the pages to base the contributor list (and the counts) on. Multiple values can be specified with a comma separated list
  • authors Include page authors (default).
  • comments Include page comments
  • labels Include page labels
  • watches Include page watches
• order - (optional) The order the contributors will appear in.
  • count Order by the total count (default)
  • name Order by the names of the contributors
  • update Order by the last update time
  Both the count and update orderings will use values from only the content specified with the include parameter.
• reverse - (optional) If true the sort order will be reversed.
• limit - (optional) Limit the number of contributors initially displayed to this amount
• mode - (optional) Sets the display mode of the macro
• inline The contributors will be displayed across the screen (default)
• list The contributors will be displayed in a list down the screen
• showAnonymous - (optional) Show edits by anonymous users. Default is false.
• 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:
  • @all All Spaces
  • @global All Global Spaces
  • @personal All Personal Spaces
• contentType Valid options are:
  • pages
  • blogposts
  If not specified blog posts and pages are included.
• publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd
• 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.

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}

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

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

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.

• query: your query
• maxLimit=x: (where x is any number > 0) to limit the search result to a number of results.
• spacekey: specify the key of the space you want to search in
• type: specify the content type (could be page, comment, blogpost, attachment, userinfo, spacedesc)
• lastModified: specify a time period in which the content was last modified: (e.g. 3d = modified in the last 3 days, 1m3d = modified in the last month and three days)
• contributor: specify the username of the contributor of the content to be retrieved

Example:

Found 2 result(s) for home

Home (My Space) This is the home page for My Space.

file-containing-home.pdf ( download)

Displays the most recent blog posts in this space.

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

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

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

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

Displays a list of content marked with the specified labels.

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

Renders a list of labels related to the current page's labels.

• labels - (optional) comma-separated list of labels whose related labels will be displayed.

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.
• width - (optional) width of table on Confluence page, defaults to 100%.
• type/types - (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
  
  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.

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.

Renders the list of all labels or labels for a specific space sorted alphabetical.

• spaceKey - (optional) list the labels in the specified space (current space by default). If '@all' is specified, labels in all spaces will be listed.

Displays a list of global spaces visible to the user, with linked icons leading to various space content functionality, within a table. The width parameter specifies the table width on the page.

• width - (optional) width of table on Confluence page, defaults to 100%.

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)
• width - (optional) width of table on Confluence page, defaults to 100%.
• types - Filter content by type. You can specify one or more types, separated by commas. 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
• showProfilePic - if true, display the profile pictures of the users who updated the content.

Renders a list of links to global reports within a table of width x (defaults to 99%).

• width - (optional) width of table on Confluence page, defaults to 50%.

Include the Confluence site welcome message. The site welcome message may be configured in the Administration -> General Configuration section.

Renders a create space button linked to the create space page.

• size - small (size of 'small' uses a smaller graphic, whereas size of 'large' uses a larger one)
• height - image height in pixels
• width - image width in pixels

Lists users registered in Confluence.

Either a group or groups value must be supplied. If you want all users in the system use groups=*.

Supplying a groups value will list only members of those groups. The groups value supports a comma separated list of group-names.

Group: confluence-administrators
Tyler Durden (tdurden@example.com)
Marla Singer (marla@example.com)
Robert Paulson (bob@example.com)

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.

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

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

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

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

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

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

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

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

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

Example:

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

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

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

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

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

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

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

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

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

Example:

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

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

Displays an rss feed within a page that can be hidden (by each user) until there is a new item to display.

• url the url of the feed to display
• maxItems (optional) the maximum number of feed entries to display.
• showTitlesOnly (optional) If true only the feed titles will be displayed, defaults to false.

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

Parameters

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

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.
• border - The border width in pixels. Defaults to normal table border width.
• width - The table width in pixels. Default is 100%.
• rowOrientation - By default, data is oriented with rows appearing vertically (in rows) and columns in columns. Specify rowOrientation=horizontal to have rows appear horizontally (as columns) and columns appear as rows.
• 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

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.

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

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

Example:

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

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

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

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

Ensures that the current page is labelled with the ones listed

See Also: User Guide and Examples

If none of the labels listed are already defined, presents the user with a choice of labels

Parameters:

• labels A comma separated list of labels. These will be added when clicked on
• title A title to show above the list of labels
• descriptions An optional description for each label that is more human readable. This list must be the same length as the labels list.

See Also: User Guide and Examples