User for inserting comments into wiki markup, without argumrnts 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

Generates an 'Add Page' link which, when clicked, can take the user directly to a template and/or set the page parent.

• template - (optional) the name of the template to use when creating the page.
• live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false.
• parent - (optional) the name of the parent page (empty by default). May also have the following markers:
  • @self - (default) the parent will be the page the macro is in.
  • @parent - the parent will be the parent of the page the macro is in.
  • @home - the parent will be home page for the Space the page is in.
• title - (optional) if you want popup text to appear when the mouse is hovered over the link, enter it here.
• labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates.

Displays a graphic indication of whether an AIM user is online. You must supply a valid AIM screen name as the default argument.

Specifying showid=false will cause the macro to only output the image, not the user's AIM screen name in text format.

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

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.

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

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

See Also: User Guide and Examples

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 the timeSeries parameter.

    • 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
  • domainAxisUpperBound - domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter
  • 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
  • domainAxisLabelAngle - angle for the domain axis label in degrees
  • 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. The default is to show only the pie section key value. The format is a string with special replacement variables:
    • %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. This advanced capability is for automation or use in combination with the cache macro. For attachment to be used, the user must be authorized to add attachments to the page specified.
    • ^attachment - The chart is saved as an attachment to the current page.
    • 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; they're 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):

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
M	Month in year	Month	July; Jul; 07
w	Week in year	Number	27
W	Week in month	Number	2
D	Day in year	Number	189
d	Day in month	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue
a	Am/pm marker	Text	PM
H	Hour in day (0-23)	Number	0
k	Hour in day (1-24)	Number	24
K	Hour in am/pm (0-11)	Number	0
h	Hour in am/pm (1-12)	Number	12
m	Minute in hour	Number	30
s	Second in minute	Number	55
S	Millisecond	Number	978
z	Time zone	General time zone	Pacific Standard Time; PST; GMT-08:00
Z	Time zone	RFC 822 time zone	-0800

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

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless it's 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 isn't 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.

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

Defines a single column.

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

Displays a list of content marked with the specified labels.

• key - (optional) restrict content to a certain space.
• type - (optional) restrict content to a certain type (all included by default)
• 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
• maxResults - (optional) the maximum number of results to display (default is 5)
• excerpt - (optional) display first line of excerpt for each result
• operator - (optional) show content matching with OR:any labels, AND:all labels (OR by default)

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

See Also: User Guide and Examples

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 Specifiy 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 labels 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 statiscs from all decendants 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.

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 edits by anonymous users. 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 Specifiy 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 labels 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 statiscs from all decendants of the page

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

See Also: User Guide and Examples

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

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

Displays a dynamic tasklist. Tasks are added to the list and updated while viewing the page.

The single parameter is the title of the task list. Make sure you don't have two task-lists in the same page with the same title.

Example:

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

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

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

Displays a graphic indication of whether an ICQ user is online. You must supply a valid ICQ UIN as the default argument.

Specifying showid=false will cause the macro to only output the image, not the user's ICQ UIN in text format.

Specifying image=X will cause the macro to use ICQ image set X. Examples of image sets can be found here. The default image set is 5.

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

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.

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

Creates a list of pages which link to the current page. Wiki content may be included as the body to be shown if no links exist.

Display Options

• page - The page to search on.
• mode - The mode in which incoming links are displayed. Available modes:
• list - Links are displayed in a bullet-pointed list.
• flat - Links are displayed in a single row, with a separator between each item.
• separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
• brackets - Each item is surrounded by square brackets ('[' and ']').
• braces - Each item is surrounded by curly braces ('{' and '}').
• parens - Each item is surrounded by parentheses ('(' and ')').
• pipe - Each item is separated by a pipe ('|').
• other - The value is the separator.
• style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
• icons - displays the Confluence page-type icon (default)
• none - no bullet point displayed
• other CSS styles - disc, square, upper-roman, lower-roman, etc
• excerpt - Will output any excerpts which have been set on the linking page.
• sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
• natural title - Sorted by the unicode-safe natural order of the content title. (Default)
• exact title - Sorted by the exact content title.
• creation date - Sorted by the creation date of the content.
• modification date - Sorted by the last-modified date of the content.
• space key - Sorted by the space key the content is contained in.
• space name - Sorted by the unicode-safe natural order of the space name.
• maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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"

This will work for all filter properties below.

• scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
• >children - The direct children of the specified page. Eg. 'scope=My Page>children'
• >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
• >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
• labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
• spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
• @all - All spaces, both personal and global
• @personal - All personal spaces
• @global - All non-personal spaces
• @favourites - All the current user's favourite spaces
• types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
• page - Wiki pages
• news - Blog/News posts
• comment - Page or blog comments
• spacedescription - Space description
• userinfo - User profile
• attachment - An attachment
• mail - Mail archive
• mailto - A 'mailto' link
• url - An external URL.
• unresolved - An unresolved link.

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

Links to a page in the current space. If the page doesn't exist or is untitled, it generates a 'Add Page' link which, when clicked, can take the user directly to a template and/or set the page parent.

The title may also contain substitution markers, indicated with '%' surrounding a Supplier key chain value. Eg:

{link-page:name=%content:title% - %global:current user > user:full name%}your page{link-page}

This will link to a page with the name being the parent page's title, followed by " - " followed by the current user's name.

• [default]/name - (optional) the title of the page. If not supplied, clicking the link will always create a new page.
• template - (optional) the name of the template to use when creating the page.
• live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false.
• parent - (optional) the name of the parent page (empty by default). May also have the following markers:
  • @self - (default) the parent will be the page the macro is in.
  • @parent - the parent will be the parent of the page the macro is in.
  • @home - the parent will be home page for the Space the page is in.
• title - (optional) if you want popup text to appear when the mouse is hovered over the link, enter it here.
• labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates.

Creates a link to special Confluence locations. All locations are non-case-sensitive.

• [default] - The location to link to. See the list of locations below.
• space - (optional) The spacekey to link to.
• page - (optional) The name of the page/news item/etc to link to.
• popup - (optional) If 'true', the link will open in a popup window.
• popupWidth - (optional) The width of the popup window. Defaults to 600px.
• popupHeight - (optional) The height of the popup window. Defaults to 400px.
• popupScroll - (optional) If false, no scrollbar is displayed. Defaults to true.
• target - (optional) The name of the popup window to open.
• title - (optional) if you want popup text to appear when the mouse is hovered over the link, enter it here.

• admin - The administration section.
• dashboard - The Dashboard.
• global templates - The global templates page.
• homepage - The user's homepage.
• login - The login page.
• logout - The logout page.
• signup - The signup page.
• notation guide - The notation guide.
• rss feed builder - The RSS Feed Builder (Confluence 2.x)
• spaces - The list of spaces the user has access to. (Confluence 1.4)
• user profile - The currently logged in user's profile.
• user history - The currently logged in user's history.

Space Locations
You can specify which space to link to by setting the 'space=key' parameter, or it will default to the current space.

• add news - Add a news post.
• browse space - Go to the 'Browse Space' view.
• mail - The mail page.
• news - The news page.
• pages alphabetical - The list of pages in alphabetical order.
• pages tree - The hierarchical view of pages in the space.
• pages updated - The recently updated pages list.
• space attachments - The attachments list for the space.
• space templates - The space templates list.
• popular labels - A page listing popular page labels in the space. (Confluence 2.x)
• all labels - A page listing all labels across the space. (Confluence 2.x)

RSS Feeds
Again, you can specify the space, or the current one will be used as the default.

• rss comments - New comments are added to this feed.
• rss news - News items for the space are added to the feed.
• rss new pages - Any new pages in the space are added to the feed.
• rss updated pages - Any updated pages in the space are added to the feed.

Page Locations
You can specify the space key as above, and you can specify the page or news item with the 'page=Page Name' parameter.

• @parent - Links to the page's parent, if it has one.
• @self - Links to the page the macro is on.
• add comment - Opens the 'add comment' section of the page.
• page comments - Jumps to the page comments.
• page attachments - The attachments tab for the page.
• page children - Jumps to the page children list.
• page edit - The edit tab for the page.
• page history - The page history view.
• page info - The page info view.
• page source - The page source view
• pdf export - Export the page to PDF.
• word export - Export the page in Microsoft Word format.
• print - The print view for the page.

Links to a page or URL, popping it up into a new window.

• [default]/href - The name of the page, or the URL.
• type - Either 'normal' (the default) or 'popup'. If set to popup, many of the settings below will default to those appropriate for a popup window.
• width - The width of the new window.
• height - The height of the new window.
• scrollbars - If false, the scrollbar will be hidden.
• menubar - If false, the menubar will be hidden.
• location - If false, the location bar will be hidden.
• statusbar - If false, the status bar will be hidden.
• resizable - If false, the window will not be resizable.
• title - The title of the window. Use this to open multiple links in the same popup window.
• tip - The tip to display while the mouse is hovering over the link.
• icon - If false, the link will not have an 'open new window' icon.

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.

Show search results keystroke by keystroke.

• id: - (optional) to uniquely identify the livesearch when there are multiple livesearch macros in one page
• spaceKey: - (optional) this option searches within a single space.

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

Prints a list of all enabled macros in this installation.

This is useful where you wish to let your users see exactly which macros are available for them to use.

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.

Table of Contents
Documentation	Meeting Minutes	Staff Directory

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

Creates a list of pages which do not have any other pages linking to them. Wiki content may be included as the body to be shown if no links exist.

Display Options

• page - The page to search on.
• mode - The mode in which links are displayed. Available modes:
• list - Links are displayed in a bullet-pointed list.
• flat - Links are displayed in a single row, with a separator between each item.
• separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
• brackets - Each item is surrounded by square brackets ('[' and ']').
• braces - Each item is surrounded by curly braces ('{' and '}').
• parens - Each item is surrounded by parentheses ('(' and ')').
• pipe - Each item is separated by a pipe ('|').
• other - The value is the separator.
• style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
• icons - displays the Confluence page-type icon (default)
• none - no bullet point displayed
• other CSS styles - disc, square, upper-roman, lower-roman, etc
• excerpt - Will output any excerpts which have been set on the linking page.
• sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
• natural title - Sorted by the unicode-safe natural order of the content title. (Default)
• exact title - Sorted by the exact content title.
• creation date - Sorted by the creation date of the content.
• modification date - Sorted by the last-modified date of the content.
• space key - Sorted by the space key the content is contained in.
• space name - Sorted by the unicode-safe natural order of the space name.
• maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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"

This will work for all filter properties below.

• scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
• >children - The direct children of the specified page. Eg. 'scope=My Page>children'
• >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
• >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
• labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
• spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
• @all - All spaces, both personal and global
• @personal - All personal spaces
• @global - All non-personal spaces
• @favourites - All the current user's favourite spaces
• types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
• page - Wiki pages
• news - Blog/News posts
• comment - Page or blog comments
• spacedescription - Space description
• userinfo - User profile
• attachment - An attachment
• mail - Mail archive
• mailto - A 'mailto' link
• url - An external URL.
• unresolved - An unresolved link.

Creates a list of pages, websites and email addresses the current page links to. Wiki content may be included as the body to be shown if no links exist.

Display Options

• page - The page to search on.
• mode - The mode in which links are displayed. Available modes:
• list - Links are displayed in a bullet-pointed list.
• flat - Links are displayed in a single row, with a separator between each item.
• separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators:
• brackets - Each item is surrounded by square brackets ('[' and ']').
• braces - Each item is surrounded by curly braces ('{' and '}').
• parens - Each item is surrounded by parentheses ('(' and ')').
• pipe - Each item is separated by a pipe ('|').
• other - The value is the separator.
• style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles:
• icons - displays the Confluence page-type icon (default)
• none - no bullet point displayed
• other CSS styles - disc, square, upper-roman, lower-roman, etc
• excerpt - Will output any excerpts which have been set on the linking page.
• sort - Allows the sort order to be specified. More than one sort may be specified and they will be processed in order. Also, each sort item may be followed by 'desc' to indicate the item should be sorted in descending order. Eg. "modification date desc, natural title". Valid options are:
• natural title - Sorted by the unicode-safe natural order of the content title. (Default)
• exact title - Sorted by the exact content title.
• creation date - Sorted by the creation date of the content.
• modification date - Sorted by the last-modified date of the content.
• space key - Sorted by the space key the content is contained in.
• space name - Sorted by the unicode-safe natural order of the space name.
• maxResults - Outputs up to this number of results. Default is unlimited.

Filtering Options

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"

This will work for all filter properties below.

• scope - List of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
• >children - The direct children of the specified page. Eg. 'scope=My Page>children'
• >descendents - All descendents of the specified page. Eg. 'scope="My Page">descendents'
• >ancestors - All ancestors of the specified page. Eg. 'scope=My Page>ancestors'
• labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label.
• spaces - Will only list linking pages in the specified spaces. Spaces should be comma-separated. May also be one of the following special values:
• @all - All spaces, both personal and global
• @personal - All personal spaces
• @global - All non-personal spaces
• @favourites - All the current user's favourite spaces
• types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include:
• page - Wiki pages
• news - Blog/News posts
• comment - Page or blog comments
• spacedescription - Space description
• userinfo - User profile
• attachment - An attachment
• mail - Mail archive
• mailto - A 'mailto' link
• url - An external URL.
• unresolved - An unresolved link.

A macro to show popular content.

• spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
• types: - (optional) a comma-separated list of content types to restrict content to (page content by default).
• labels: - (optional) a comma-separated list of labels to restrict content to.
• display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
• timespan: - (optional) restrict the timespan of usage from today minus the given value. The timespan value should be a number followed by one of the following: 'w' for week, 'd' for day and 'm' for month. 1w (1 week) is used by default.
• events: - (optional) a comma-separated list of events to restrict content popularity based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
• max: - (optional) the maximum number of popular content to display (10 by default).
• style: - (optional) the style to display the popular content in (table by default). Allowed style values are 'list', 'table' and 'flat'.

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

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

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

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 99%

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

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.

Inserts a registered trade mark: Adaptavist^�

See Also: User Guide and Examples

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.

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

Generates a set of scroll bar links within the same page hierarchy, one previous and one next (if they exist).

• up - (optional) if 'false', no link to the parent page will be created (default is true).
• icons - (optional) if 'false', no icons will be generated (default is true).
• class - (optional) set the CSS class the scrollbar table will be set to.