Available Macros

Skip to end of metadata
Go to start of metadata
Available macros are subject to change without notice.
{add-page:template=My Template|parent=Page Parent}Click to add page{add-page}

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

  • source - (optional) the name of the template or page to copy when creating the page.
  • type - (optional) the source type, either 'template' (default) or '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.
  • allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created.
  • prefix - (optional) (Since 2.8.0) The %injectable% prefix to apply to the page name. The user will not be able to modify this section of the name while creating it. Eg: 'prefix=%page:title% - ' will add the current page title plus ' - ' to the start of the page name.
  • postfix - (optional) (Since 2.8.0) The %injectable% postfix to apply to the page name. The user will not be able to modify this section of the name while creating it. Eg: 'postfix= - %page:title%' will add the current page title plus ' - ' to the end of the page name.
{add-page-form:template=My Template|parent=Page Parent}Click to add new page{add-page-form}

Generates an 'Add Page' form with a field for the title.

  • source - (optional) the name of the template or page to copy when creating the page.
  • type - (optional) the source type, either 'template' (default) or '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.
  • labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates.
  • allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created.
  • nameWidth - (optional) The width of the title text field. Eg. '250px' or '70%'.
  • prefix - (optional) (Since 2.8.0) The %injectable% prefix to apply to the page name. The user will not be able to modify this section of the name while creating it. Eg: 'prefix=%page:title% - ' will add the current page title plus ' - ' to the start of the page name.
  • postfix - (optional) (Since 2.8.0) The %injectable% postfix to apply to the page name. The user will not be able to modify this section of the name while creating it. Eg: 'postfix= - %page:title%' will add the current page title plus ' - ' to the end of the page name.
{add-page-form2} Alias for 'add-page-form'.
{add-page-restriction:edit=group,user,group|view=group,user,group}

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

{add-replacement:name}value{add-replacement}

Allows additions to be made to menulink replacements

Parameters:

  • default - The replacement text

See Also: User Guide and Examples

{aim} Old style aim macro
{align:mode|class=myclass}content{align}

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

{anchor:anchorname} Creates a bookmark anchor inside the page. You can then create links directly to that anchor. So the link [My Page#here] will link to wherever in "My Page" there is an {anchor:here} macro, and the link [#there] will link to wherever in the current page there is an {anchor:there} macro.
{attachment-data:Field Name|include=.*jpg,.*gif}

Creates a set of list options linking to the attachments on the specified content the filter options. Must be contained inside a list-data macro.

  • [default]/name - The name of the field.
  • include - (optional) A regular expression specifying which file names to include. E.g. ".*gif" for all GIF files.
  • exclude - (optional) A regular expression specifying which file names to exclude. E.g. ".*zip" for all ZIP files.
{attachment-options:content=A Page}

Creates a set of list options linking to the attachments on the specified content the filter options. Must be contained inside a list-data macro.

  • content - (optional) If specified, the page or other content the files are attached to. Defaults to the current page.
  • include - (optional) A regular expression specifying which file names to include. E.g. ".*gif" for all GIF files.
  • exclude - (optional) A regular expression specifying which file names to exclude. E.g. ".*zip" for all ZIP files.
{attachments:patterns=.*doc|old=true}

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.

{bgcolor:red|class=myclass}content{bgcolor}
{bgcolor:#FF0000}content{bgcolor}

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

{blog} An alias to blog-posts.
{blog-archive}

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

{blog-calendar}
{blog-calendar:space=spacekey|date=@today}

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

{blog-list}

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

{blog-post} An alias to blog-posts.
{blog-posts:max=5}

{blog-posts:max=5|content=excerpts}

{blog-posts:max=5|content=titles}

{blog-posts:time=7d|spaces=@all}

{blog-posts:max=15|time=14d|content=excerpts}

{blog-posts:labels=confluence,atlassian}

{blog-posts:labels=+atlassian,+confluence,+content}

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.

{blog-roll}

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

{blog-rss}

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

{blog-rss-feed}

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

{blogpost} An alias to blog-posts.
{blogposts} An alias to blog-posts.
{blogs} An alias to blog-posts.
{boilerplate} Imports the current value of a template directly into the page. (Deprecated)
{bookmark} Macro to create a bookmark on a bookmark page

{bookmarks}

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

{added-by}

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

See Also: User Guide and Examples

{builder-breadcrumbs}

Inserts the confluence breadcrumb trail into a builder panel

Parameters:

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

See Also: User Guide and Examples

{builder-children}

Inserts the confluence children display into a builder panel

See Also: User Guide and Examples

{builder-comments}

Inserts the confluence comments display and editor into a builder panel

See Also: User Guide and Examples

{builder-favicon}

Inserts the confluence favourite icon into a builder panel

See Also: User Guide and Examples

{builder-hide:context=page,blogpost|mode=view|decorator=printable} ... content ... {builder-hide}

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

{builder-hide2} Used for showing/hiding content based on the context at the theme level
{builder-hide3} Used for showing/hiding content based on the context at the theme level
{builder-hide4} Used for showing/hiding content based on the context at the theme level
{builder-hide5} Used for showing/hiding content based on the context at the theme level
{builder-hide6} Used for showing/hiding content based on the context at the theme level
{builder-hide7} Used for showing/hiding content based on the context at the theme level
{builder-hide8} Used for showing/hiding content based on the context at the theme level
{builder-hide9} Used for showing/hiding content based on the context at the theme level
{builder-infopanel}

Inserts the confluence info-panel display into a builder panel

See Also: User Guide and Examples

{builder-labels}

Inserts the confluence quick label editor into a builder panel

See Also: User Guide and Examples

{builder-comments}

Inserts the confluence comments display and editor into a builder panel

See Also: User Guide and Examples

{builder-logo}

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

{builder-pagetitle}

Returns the title of the current page/action

See Also: User Guide and Examples

{builder-personal-sidebar}

Includes the confluence personal sidebar into a builder panel

See Also: User Guide and Examples

{builder-search}

Inserts the confluence quick-search box into a builder panel

See Also: User Guide and Examples

{builder-show:context=page,blogpost|mode=view|decorator=printable} ... content ... {builder-show}

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

{builder-show2} Used for showing/hiding content based on the context at the theme level
{builder-show3} Used for showing/hiding content based on the context at the theme level
{builder-show4} Used for showing/hiding content based on the context at the theme level
{builder-show5} Used for showing/hiding content based on the context at the theme level
{builder-show6} Used for showing/hiding content based on the context at the theme level
{builder-show7} Used for showing/hiding content based on the context at the theme level
{builder-show8} Used for showing/hiding content based on the context at the theme level
{builder-show9} Used for showing/hiding content based on the context at the theme level
{builder-sidebar:right|collapse=true}

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

{builder-spacetitle}

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

{builder-watchicon}

Inserts the confluence watch icon into a builder panel

See Also: User Guide and Examples

{builder-welcome-message} Deprecated macro - for backwards compatibility only. Use the {welcome-message} macro instead.
{calendar:id=myCalendar|title=My Calendar|defaultView=week}

Displays a calendar.

  • id - (required) The page-unique ID of the calendar.
  • title - (optional) The title of the initial sub-calendar.
  • defaultView - (optional) The view to display by default. May be 'event', 'day', 'week', or 'month' (the default).
  • firstDay - (optional) The first day of the week. Defaults to 'Monday'.
{calendar-events} Displays a list of calendar events.
{card:label=Card 1}
Card 1 contents.
{card}
{card:label=*Card 2*|default=true|accessKey=c}
Card 2 contents.
{card}

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'
{center:class=myclass}content{center}

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

See Also: User Guide and Examples

{change-history} Show the history of version comments.
{chart:title=Fish Sold}
|| Fish Type || 2004 || 2005 ||
|| Herring | 9,500 | 8,300 |
|| Salmon | 2,900 | 4,200 |
|| Tuna | 1,500 | 1,500 |
{chart}

{chart:type=line|title=Temperatures in Brisbane|yLabel=Celcius
|dataDisplay=true|dataOrientation=vertical}
|| Month || Min || Max ||
| January | 31.3 | 37.5 |
| February | 26.8 | 32.7 |
| March | 25.1 | 28 |
| April | 18.7 | 25.3 |
{chart}

{chart:type=timeSeries|dateFormat=MM.yyyy|timePeriod=Month|
dataOrientation=vertical|rangeAxisLowerBound=0|colors=blue,gray}
|| Month || Revenue ||
| 1.2005 | 31.8 |
| 2.2005 | 41.8 |
| 3.2005 | 51.3 |
| 4.2005 | 33.8 |
| 5.2005 | 27.6 |
| 6.2005 | 49.8 |
| 7.2005 | 51.8 |
| 8.2005 | 77.3 |
| 9.2005 | 73.8 |
| 10.2005 | 97.6 |
| 11.2005 | 101.2 |
| 12.2005 | 113.7 |

|| Month || Expenses ||
| 1.2005 | 41.1 |
| 2.2005 | 43.8 |
| 3.2005 | 45.3 |
| 4.2005 | 45.0 |
| 5.2005 | 44.6 |
| 6.2005 | 43.8 |
| 7.2005 | 51.8 |
| 8.2005 | 52.3 |
| 9.2005 | 53.8 |
| 10.2005 | 55.6 |
| 11.2005 | 61.2 |
| 12.2005 | 63.7 |
{chart}

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


    • 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

Colors can be specified by name or hex value. See Web-colors. The following are the valid color names that will automatically be converted.
Color Hexadecimal Color Hexadecimal Color Hexadecimal Color Hexadecimal
black #000000 silver #c0c0c0 maroon #800000 red #ff0000
navy #000080 blue #0000ff purple #800080 fuchsia #ff00ff
green #008000 lime #00ff00 olive #808000 yellow #ffff00
teal #008080 aqua #00ffff gray #808080 white #ffffff

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

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

{cheese} Cheese is a really cool thing
{children}

{children:all=true}

{children:depth=x}

{children:depth=x|style=h3}

{children:excerpt=true}

{children:page=Another Page}

{children:page=/}

{children:page=SPACEKEY:}

{children:page=SPACEKEY:Page Title}

{children:first=x}

{children:sort=<mode>|reverse=<true or false>}
Displays the children and descendants of the current page. Specify 'all=true' to show all descendants of this page, or depth=x (where x is any number > 0) to show that many levels of descendants.

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

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

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

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

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

Example:

  • child
  • another child
  • child
    • first grandchild
  • another child

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

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

{clickable:tooltip|link}content{clickable}

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

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

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

  • id - (required) The unique ID of the cloaked section.
  • visible - (optional) If 'true', the section will be visible initially. Defaults to 'false'.
{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.
Default highlighted code

{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.
VisualBasic.Net highlighted code

{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.
Highlighted code, including 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.
Highlighted code, collapsed

{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.
Highlighted code, excluding 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.
Highlighted code, alternative firstline

{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.
Highlighted code, including ruler

{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.
Highlighted code, including ruler

{colgroup}Some content{colgroup}

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

{color:red}
look ma, red text!
{color}
Changes the color of a block of text.

Example: look ma, red text!

{column:width=50%}
Text in this column.
{column}

Defines a single column.

  • width: - (optional) the width of the column.
Must be defined in a section macro.

{composition-setup:defaults=Home^composition.properties}
cloak.memory.duration = 3 #days
cloak.toggle.type = custom
cloak.toggle.open = ^open.gif
cloak.toggle.close = ^close.gif
{composition-setup}

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.
{compound-menuitem:destination|caption=link text}

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

{content-by-user:fred}

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

{content-options:parent=A Page}

Creates a set of list options linking to content matching the filter options. Must be contained inside a list-data macro.

  • parent - (optional) Only immediate children of the specified page will be listed.
  • ancestor - (optional) Any decendent of the specified page will be listed.
  • spaces - (optional) Only lists pages from the specified list of spaces.
  • branches - (optional) Specifies the type of pages that will be listed. May be one of:
    • all - All page types are returned.
    • parents - Only pages with children are listed.
    • children - Only pages with no children are listed.
  • labels - (optional) Only list pages which contain (or do not contain) certain labels
  • {contentbylabel:labels=dogs,cats}
    {contentbylabel:labels=dogs,cats|space=PETS}
    {contentbylabel:labels=dogs,cats|type=page,blogpost}
    {contentbylabel:labels=dogs,cats|showLabels=false|showSpace=false}
    {contentbylabel:labels=dogs,cats|excerpt=true}
    {contentbylabel:labels=+dogs,+cats}
    {contentbylabel:labels=+lebowski,+bowling,-walter|space=@all|type=page,-blogpost}

    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.

    {contributors:order=edits}

    {contributors:include=authors,labels|mode=list|showCount=true}

    {contributors:order=editTime|limit=6}

    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.

    {contributors-summary:order=edits|limit=3|showAnonymous=true}

    {contributors-summary:columns=edits|order=editTime}

    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

    {copyright:class=myclass}2005 [Adaptavist.com Ltd|http://adaptavist.com].{copyright}

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

    See Also: User Guide and Examples

    {create-child:page title|render=true}

    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

    sp

    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

    {create-space-button: size=large | width=32 | height=32}

    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

    {date-data:List Field|format=dd-MMMM-yyyy}

    Allows editing of date field. Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • format - (required) The format of the date content. May contain any of the following special characters:
      • y - The year (eg. 'yy' = '05', 'yyyy' = 2005).
      • M - The month (eg. 'MMMM' = 'April', 'MMM' = 'Apr', 'MM' = '04').
      • d - The day (eg. 'dd' = '09', 'd' = '9').
      • H - The hour - 24 hour time (eg. 'HH' = '13').
      • h - The hour - 12 hour time (eg. 'hh' = '01').
      • m - The minute (eg. 'mm' = '23').
      • s - The second (eg. 'ss' = '14').
      • a - AM/PM (eg. 'a' = 'PM').
  • minYear - (optional) The minimum year that is allowed. May be absolute (eg. '1980') or relative to the current year (eg. '-5'). Defaults to '-10'.
  • maxYear - (optional) The maximum year that is allowed. May be absolute (eg. '2020') or relative to the current year (eg. '+15'). Defaults to '+10'.
  • required - (optional) If 'true', the field cannot be empty.
  • Tabbed deck
    {deck:id=My Deck}
    {card:label=Card 1}
    Card 1 contents.
    {card}
    {card:label=Card 2}
    Card 2 contents.
    {card}
    {deck}

    Slideshow
    {deck:id=My Deck|effectType=fade|nextAfter=5|loopCards=true|tabLocation=none}
    {card:label=Card 1}
    !image1.png!
    {card}
    {card:label=Card 2}
    !image2.png!
    {card}
    {deck}

    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.
    {details} Record (and display) details about a page
    {detailssummary} Show a tabular view of a series of details stored in pages in the same space
    {display-footnotes}

    Displays the footnotes defined by ocurrences of the {footnote} macro elsewhere on the page

    Parameters:

    • reset - Set to true to reset the count of footnotes

    See Also: User Guide and Examples

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {div:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{div}

    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

    {doc:/display/DOC/Confluence+Documentation+Home}Confluence Documentation{doc}

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

    {dynamictasklist:thingsToDo}
    {dynamictasklist:thingsToDo|showAssignee=false}
    {dynamictasklist:thingsToDo|promptOnDelete=false}

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

    • showAssignee - (optional) If set to true the assignee will be shown in the tasks.
    • width - (optional) The width of the tasklist (default is 640px). To set the width to 400 pixels, set the parameter value to 400px.
    • enableLocking - (optional) If set to true, tasks can be locked so other users can not modify.
    • autoLockOnComplete (optional) Used in conjunction with enableLocking. Tasks will auto lock when it is completed.
    • promptOnDelete - (optional) If set to false there will not be any confirmation prompt when deleting a task.

    Example:
    What you need to type What you will get
    {dynamictasklist:Arthurs To-Do's}
    {editinwordlink} Adds a hyperlink for editing in Word
    {editmenu}

    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

    {eval-data:Evaluated Field} ${Foo} + ${Bar} {eval-data} {eval-data:Evaluated Field} round(${Foo} / ${Bar}, 2) {eval-data}

    Evaluates mathematical equations, optionally using values from other field data in the same scaffold. Other fields can be referenced by putting them inside '${}' markers. The examples to the left add and divide the current values of the 'Foo' and 'Bar' fields, respectively. Must be contained inside a scaffold macro.

    Parameters

    • [default]/name - (required) The name of the field.
    • format - (optional) The format the number should be output in when not being edited. See java.text.DecimalFormat for details.

    Functions

    • round([number], [places]) - Rounds the number to the specified number of decimal places. Eg: round(1.4634, 2) rounds to 1.46.
    • sumtable([table], [column]) - Sums the values of the specified column in the specified table. Eg: sumtable("My Table", "Number Column").
    • avgtable([table], [column]) - Averages the values of the specified column in the specified table. Eg: avgtable("My Table", "Number Column").
    {excel:file=^Report.xls}


    {excel:file=Year 2005^Report.xls|sheets=First Quarter, Second Quarter}


    {excel:file=excel/Report.xls|sheets=1,2,4}

    Displays one or more worksheets from Microsoft Excel spreadsheets (Excel 97, 2000, 2003 workbooks). Each worksheet is shown as a table. This macro supports common table capabilities with other table based macros (table-plus, csv, and sql).

    • file - A required parameter unless url is specified. It specifies the location of the Excel file.
      • ^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.
      • filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • encoding - File encoding for an external file if different from the system default handling. Example: *UTF-8*.
    • url - Only required if file is not specified. Specifies the URL of an Excel file. Use of this parameter may be restricted for security reasons. See your administrator for details.
    • sheets - By default, each sheet in the workbook will produce a table. Use the sheets parameter to control what sheets will be shown and ordering. The parameter value can be a comma separated list of sheet names (case sensitive) or sheet numbers (1-based counting)
    • columns - By default, all columns will be shown. Use the columns parameter to control the columns to show. Column ordering is not currently supported. The parameter value can be a comma separated list of column numbers (1-based counting). Hidden columns will show if listed in the columns parameter.
    • 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.
    • 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%.
    • showHidden - By default, hidden sheets, rows, and columns will not be shown. Set showHidden=true to show all data.
    • showSheetName - By default, the sheet name will not be shown. Set showSheetName=true to show a the sheet name before the table.
    • formatCell - By default, no special formating will be applied to the cells. Set formatCell=true to process each cell for special properties. Currently supported properties are:
      • html - Font and background color.
      • wiki - None at this time.
    • formatColumn - By default, the format for a column will be used to apply formating for all cells in the column. Set formatColumn=false to not use the column formating information from the excel sheet. Note that this parameter is ignored if formatCell=true or columnAttributes are specified.
    • 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.
    • 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.
    • hyperlinks - Default is true. Set to false to disable inclusion of cell hyperlinks.
    • ignoreTrailingBlankRows - By default, all trailing blank rows will be ignored. Set ignoreTrailingBlankRows=false to show these blank rows.
    • ignoreTrailingBlankColumns - By default, all trailing blank columns will be ignored. Set ignoreTrailingBlankColumns=false to show these blank columns.
    • language - If provided, the language and country specification will be used to provide 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.
    • disableAntiXss - Default is false. Set to true to stop encoding of html special characters found in table content. For security reasons, use of this parameter is restricted to authorized users. See your administrator for details.
    {excerpt}Confluence is a knowledge-sharing application that enables teams to communicate more effectively{excerpt}

    {excerpt:hidden=true}This excerpt will be recorded, but will not be displayed on the page.{excerpt}
    Marks some part of the page as the page's 'excerpt'. This doesn't change the display of the page at all, but other macros (for example children, excerpt-include and blog-posts) can use this excerpt to summarise the page's content.
    • hidden: If the value of "hidden" is true, then the contents of the excerpt macro will not appear on the page.
    {excerpt-data:Excerpt Field}{excerpt-data}

    Allows editing of page's excerpt text via a text field. All the options for {text-data} will work here. Must be contained inside a scaffold macro.

    {excerpt-include:Home}

    {excerpt-include:Home|nopanel=true}

    {excerpt-include:blogPost=/2006/12/28/News Page}
    Includes the excerpt from one page (see the excerpt macro) within another. The included page must be in the same space as the page on which the macro is used.
    • nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
    {fancy-bullets:myimage.jpg}
    * list
    ** sublist
    {fancy-bullets}

    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 - Select from a range of bullet types (eg; disc, circle, square, decimal, and more)
    • id - a unique id (must be supplied when using fancy bullets outside of a page)
    • padding - the padding to apply to the list items

    See Also: User Guide and Examples

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

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

    Parameters:

    • class - The CSS class name to assign to an item in a menu
    • subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
    • id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
    • subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
    • autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
    • custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
    • 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

    {favpages} List the pages in your favourites list.
    {first-child:page title}

    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

    {flash:file=^example.swf}


    {flash:file=example.swf}


    {flash:file=example.swf|play=false|loop=false|bgcolor=#00FF00}


    {flash:file=EXAMPLE:Example page^example.swf|showAsLink=true|title=Flash example}


    {flash:url=http://.../example.swf}


    {flash:file=example.swf}


    Show flash based content on a confluence page.

    • file - Location of flash file. One of the file or url parameters must be specified.
      • filename - Data is read from the file located in confluence home directory/flash/filename. Subdirectories can be 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.
    • url - URL of flash file. Only used if file parameter is not provided. Use may be restricted by administrator.
      • http://... - Data is read from the URL specified.
    • width - The table width in pixels. Default is 100%.
    • height - The table height in pixels. Default is 100%.
    • showAsLink - Instead of showing content, setting this to true will show a link to the flash content on the page. Default is false. If showAsLink is not specified, a deprecated parameter setting of show=link will have the same affect as showAsLink=true.
    • title - Title to use for the link when show=link is specified. Default is the name of the flash file or url.
    • Other flash specific parameters - All other parameters are passed through to flash. See Flash reference information. Here is is a partial list.
      • ID - Identifies the Flash movie to the host environment (a web browser, for example) so that it can be referenced using a scripting language. OBJECT-specific.
      • NAME - Identifies the Flash movie to the host environment (a web browser, typically) so that it can be referenced using a scripting language such as JavaScript or VBScript. EMBED-specific.
      • SWLIVECONNECT - (true, false) Specifies whether the browser should start Java when loading the Flash Player for the first time. The default value is false if this attribute is omitted. If you use JavaScript and Flash on the same page, Java must be running for the FSCommand to work.
      • PLAY - (true, false) Specifies whether the movie begins playing immediately on loading in the browser. The default value is true if this attribute is omitted.
      • LOOP - (true, false) Specifies whether the movie repeats indefinitely or stops when it reaches the last frame. The default value is true if this attribute is omitted.
      • MENU (true, false)
        • True displays the full menu, allowing the user a variety of options to enhance or control playback.
        • False displays a menu that contains only the Settings option and the About Flash option.
      • QUALITY - (low, high, autolow, autohigh, best )
      • SCALE - (showall, noborder, exactfit)
        • Default (Show all) makes the entire movie visible in the specified area without distortion, while maintaining the original aspect ratio of the movie. Borders may appear on two sides of the movie.
        • No Border scales the movie to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the movie.
        • Exact Fit makes the entire movie visible in the specified area without trying to preserve the original aspect ratio. Distortion may occur.
      • ALIGN - (l, t, r, b)
        • Default centers the movie in the browser window and crops edges if the browser window is smaller than the movie.
        • Left, Right, Top, and Bottom align the movie along the corresponding edge of the browser window and crop the remaining three sides as needed.
      • SALIGN - (l, t, r, b, tl, tr, bl, br)
        • L, R, T, and B align the movie along the left, right, top or bottom edge, respectively, of the browser window and crop the remaining three sides as needed.
        • TL and TR align the movie to the top left and top right corner, respectively, of the browser window and crop the bottom and remaining right or left side as needed.
        • BL and BR align the movie to the bottom left and bottom right corner, respectively, of the browser window and crop the top and remaining right or left side as needed.
      • WMODE - (window, opaque, transparent) Sets the Window Mode property of the Flash movie for transparency, layering, and positioning in the browser.
        • Window movie plays in its own rectangular window on a web page.
        • Opaque the movie hides everything on the page behind it.
        • Transparent the background of the HTML page shows through all transparent portions of the movie, this may slow animation performance.
      • BGCOLOR - (#RRGGBB, hexadecimal RGB value) Specifies the background color of the movie. Use this attribute to override the background color setting specified in the Flash file. This attribute does not affect the background color of the HTML page.
      • BASE - [base directory] or [URL]. Specifies the base directory or URL used to resolve all relative path statements in the Flash Player movie. This attribute is helpful when your Flash Player movies are kept in a different directory from your other files.
    {float:right|width=50px|background: #F0F0F0|border: solid navy}
    This will float to the right.
    {float}

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

    • [default]/side - (required) The side the content will float on (left or right).
    • width - (optional) The width of the floating content (eg. '100px').
    • background - (optional) The background colour or picture settings.
    • border - (optional) The border settings.
    • margin - (optional) The margin settings.
    • padding - (optional) The padding settings.
    {footnote}text of footnote{footnote}

    Creates a footnote to be displayed by the {display-footnotes} macro

    See Also: User Guide and Examples

    {gadget} Renders Gadgets in Confluence
    {gallery}

    {gallery:columns=3}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    {get-data:Text Field}Default value{get-data}
    {get-data:name=Number Field|format=$#,{get-data:A Group.Date Field|format=d MMM, yyyy|default=Never}

    Displays stored field data. Numbers and dates may be formatted nicely.

    • [default]/name - (required) The name of the field. May be a 'field path' (e.g. 'Group Name.Field Name')
    • default - (optional) The default value to display (rendered as wiki directly) if the field is not set. Alternately, the default can be set as the body of this macro.
    • format - (optional) The number format (e.g. '#, to use when parsing the value being set. The parameter will be ignored for data types other than 'number' or 'date'.
    • render - (optional) Defaults to 'wiki'. May be set to 'none' to display any content unrendered.
    • separator - (optional) If the item/key points to a list of results, the type of separator to display between each item. Defaults to 'comma'. May be one of the following:
      • bracket - Square brackets ('[', ']') surrounding each item.
      • brace - Braces ('{', '}') surrounding each item.
      • comma - A comma (',') between each item.
      • paren - Parenthases ('(', ')') 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.
    {global-reports: width=x}

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

    {google-calendar}
    http://www.google.com/calendar/feeds/rAndOmleTT3r5g0h3r3@group.calendar.google.com/public/basic http://www.google.com/calendar/ical/m0r3raNd0ml3tTer5@group.calendar.google.com/public/basic.ics {google-calendar}

    Displays the specified Google Calendars in Confluence. Any of the standard Google calendar links (XML, ICAL, HTML) will work. You can have multiple calendars listed, one per line. You can also comment lines out by prefixing them with '//'.

    Parameters

    • mode - The mode the calendar is in. Either 'month', 'week', or 'agenda'. Defaults to 'month'.
    • controls - The controls to show. Either 'all' (which displays Title, Navigation buttons, Date, Print icon, Tabs, Calendar list, Time zone), 'navigation' (which displays just the navigation button and Date) or 'none'. Defaults to 'navigation'.
    • title - The title to display. Only visible when controls is set to 'all'. Defaults to the name of the calendar.
    • width - The width of the calendar in either pixels ('500' - no 'px') or percentage ('100%'). Defaults to 100%
    • height - The height of the calendar in pixels ('600' - no 'px'). Defaults to '610'.
    • bgcolor - The background color of the calendar. Defaults to '#FFFFFF'.
    • firstDay - The first day of the week. Eg. 'Monday'. Defaults to 'Sunday'.
    • colors - A comma-separated list of colors for events, listed in the same order the calendars appear in the macro body. Colors must be one of the following values: Must be one of the following hexadecimal RGB color values:
      #A32929 #B1365F #7A367A #5229A3
      #29527A #2952A3 #1B887A #28754E
      #0D7813 #528800 #88880E #AB8B00
      #BE6D00 #B1440E #865A5A #705770
      #4E5D6C #5A6986 #4A716C #6E6E41
      #8D6F47 #853104 #691426 #5C1158
      #23164E #182C57 #060D5E #125A12
      #2F6213 #2F6309 #5F6B02 #8C500B
      #8C500B #754916 #6B3304 #5B123B
      #42104A #113F47 #333333 #0F4B38
      #856508 #711616 &nbps; 
    {group-data:name=My Group}scaffold data{group-data}

    Groups the contained data together under the specified name.

    • [default]/name - (required) The name of the scaffold.
    {gtalk} Old style gtalk macro
    {hidden-data}
    Only visible when editing: {number-data:My Number}{number-data}
    {hidden-data}

    {hidden-data:whenEmpty=My Number}
    Only visible when a number is set: {number-data:My Number}{number-data}
    {hidden-data}

    Hides its contents when viewing a page, but reveils it when editing. Must be contained inside a scaffold macro.

    • whenEmpty - (optional) If present, the field value specified will be checked, and the contents of this hidden-data macro will be hidden if the field is empty.
    • whenNotEmpty - (optional) If present, the field value specified will be checked, and the contents of this hidden-data macro will be hidden if the field is not empty.
    • whenHasRows - (optional) If present, the table/repeation section specified will be checked, and the contents of this hidden-data macro will be hidden if it has any rows.
    • whenNoRows - (optional) If present, the table/repeation section specified will be checked, and the contents of this hidden-data macro will be hidden if it has no rows.
    {hide-from:user=bob|group=a-group,another-group|space=MYSPACE:edit}
    This text is only hidden from bob, users in a-group or another-group, and users who can edit the MYSPACE Space.
    {hide-from}

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

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

    user=foo, -bar

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

    user="foo-bar"
    • user - (optional) the (list of) users who cannot see the content. May also be one of the following special values:
      • @self - the user current user.
      • @anonymous - no user is logged in.
      • @authenticated - any user is authenticated.
    • group - (optional) the (list of) groups who cannot see the conent.
    • space:perm - (optional) the (list of) spaces where, if the user can view the space, they cannot see the content. The user's permission type to that space may be added also.
      • view - (default) the user has permission to view the space.
      • edit - the user has permission to edit pages.
      • admin - the user has administration access.
      • news - the user has permission post a news entry.
    • trim - (optional) if 'true' (the default), the content will be trimmed of whitespace at its beginning and end. (default).
    • match - (optional) specify the match type.
      • any - (default) the content is hidden if the user matches any of the criteria.
      • all - the content is hiddent if the user matches *all* the criteria.
    • prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some macros will display underendered wiki markup when put inside this macro.
    {hide-if:type=news|display=printable|space=MYSPACE|action=edit}
    This text is hidden if the page is a news item, is in printing mode, is in MYSPACE, or is being edited.
    {hide-if}

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

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

    labels=foo, -bar

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

    labels="foo-bar"
    • type(s) - (optional) the (list of) page types. May be:
      • page
      • news
      • comment
      • spacedescription
    • display(s) - (optional) the (list of) display modes. May be:
      • default - The standard display mode.
      • printable - Printer, PDF or Word mode.
      • pdf - PDF export mode.
      • word - Word export mode.
      • preview - Edit preview mode.
    • space(s) - (optional) the (list of) spaces.
    • action(s) - (optional) the action taking place.
      • view - The content is editable and is currently being viewed.
      • edit - The content is editable and is currently being edited.
      • template - The content is a template being previewed.
      • dashboard
      • - The content is the dashboard.
    • header(s) - (optional) the list of HTTP headers from the browser to check. Values are of the form "name:value" or "name::regexp" (note the double ":"). E.g: "header=referrer:/index.html" will match a referrer of exactly "/index.html". "header=referrer::.*/index.html" will match a referrer which ends with "/index.html". Multiple headers can be checked by separating with "," and optionally adding "+" for required or "-" for excluded.
    • 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.
    {highlight:blue|class=myclass}content{highlight}
    {highlight:#0000FF}content{highlight}

    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

    {html}

    The HTML macro allows you to use HTML code within a Confluence page.

    Note that the HTML macro will only be available if it has been enabled by your Confluence administrator.

    Example:

    {html}<a href="www.host.com">click here</a>{html}
    {html-include:url=http://www.host.com}

    The {html-include} macro allows you to include the contents of an HTML file in a Confluence page.

    CAUTION: Including unknown HTML inside a webpage is dangerous. Because HTML can contain active scripting components, it would be possible for a malicious attacker to present a user of your site with script that their web browser would believe came from you. Such code could be used, for example, to steal a users authentication cookie and give the attacker their Confluence login password.

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

    {HTMLcomment}HTML comment text{HTMLcomment} {HTMLcomment:hidden}HTML comment text{HTMLcomment}

    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

    {i18n:key}

    Retrieves the value of an i18n key

    Parameters:

    • default - the 118n key to be retrieved

    See Also: User Guide and Examples

    {icq} Old style icq macro
    {iframe}Some content{iframe}

    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

    {im:myscreenname|service=AIM}
    {im:me@hotmail.com|service=MSN|showid=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', 'jabber', 'msn', 'sametime', 'skype', 'wildfire' or 'yahoo'.
    • showid - (optional) If 'false', the user's id will not be shown.

    {image:resource.ext}
    {image:layout::resource.ext}

    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

    {img:src=http://domain.com/path/file.ext}

    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 and tags to figure out how it works
    • 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

    {import:SPACEKEY:pagetitle} {import:spacekey=SPACEKEY|pagetitle=page title}

    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

    {include:Home}

    {include:FOO:Home}

    {include:spaceKey=FOO|pageTitle=Home}
    Includes one page within another (this example includes a page called "Home"). Pages from another space can be included by prefacing the page title with a space key and a colon.

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

    {include-blog:2009/06/22/test news}

    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

    {incoming-links}No links exist{incoming-links}

    {incoming-links:style=square|excerpt=true}

    {incoming-links:scope=Another Page>children}

    {incoming-links:scope=A Different Page>descendents}

    {incoming-links:spaces=MYSPACE}

    {incoming-links:page=Another Page|types=page,comment}

    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.
    {index}

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

    {info:title=Be Careful}
    This macro is useful for including helpful information in your confluence pages
    {info}

    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
    {jiraissues:url=http://jira.xml.url}

    {jiraissues:url=http://jira.xml.url|
    columns=type;key;summary}

    {jiraissues:url=http://jira.xml.url|
    count=true}

    {jiraissues:url=http://jira.xml.url|
    cache=off}

    {jiraissues:url=http://jira.xml.url?
    os_username=johnsmith&os_password=secret}

    {jiraissues:url=http://jira.xml.url|
    anonymous=true}
    Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

    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:

    Atlassian JIRA (This file is an XML representation of some issues)
    Key Summary Assignee Status Res Updated
    TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
    TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
    TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
    TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

    {jiraissues:url=http://jira.xml.url}

    {jiraissues:url=http://jira.xml.url|
    columns=type;key;summary}

    {jiraissues:url=http://jira.xml.url|
    count=true}

    {jiraissues:url=http://jira.xml.url|
    cache=off}

    {jiraissues:url=http://jira.xml.url?
    os_username=johnsmith&os_password=secret}

    {jiraissues:url=http://jira.xml.url|
    anonymous=true}
    Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter.

    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:

    Atlassian JIRA (This file is an XML representation of some issues)
    Key Summary Assignee Status Res Updated
    TEST-100 Add JIRA support John Gordon Open UNRESOLVED 01/Jan/04
    TEST-103 Add JUnit Support Robert Matson In Progress UNRESOLVED 25/Dec/03
    TEST-108 Add RSS Support Bill Watson In Progress UNRESOLVED 23/Dec/03
    TEST-109 Add Search Support Fred Morit Closed FIXED 03/Jan/04

    {jiraportlet:url=http://jira.portlet.url} Imports and displays JIRA 3 portlet into a Confluence page.

    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.

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

    {junitreport:url=file:///test-reports/TestRep.xml}
    Displays the results of a series (or single) JUnit test.

    Success Rate Tests Failures Time(s) Time(s)
    93%
    14 1 0 1.531

    {label-options:label1, label2, label3}

    Creates a list of labels to attach to the current page. Must be contained inside a list-data macro.

    • (default)/names - The list of labels which are available to select.
    {li:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{li}

    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

    {link-page:template=My Template|parent=Page Parent}Click to add page{link-page}
    {link-page:Page Title|template=My Template}A Specific Page{link-page}

    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.
    • source - (optional) the name of the template or page to copy when creating the page.
    • type - (optional) the source type, either 'template' (default) or '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.
    • allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created.
    • prefix - (optional) (Since 2.8.0) The %injectable% prefix to apply to the page name. The user will not be able to modify this section of the name while creating it. Eg: 'prefix=%page:title% - ' will add the current page title plus ' - ' to the start of the page name.
    • postfix - (optional) (Since 2.8.0) The %injectable% postfix to apply to the page name. The user will not be able to modify this section of the name while creating it. Eg: 'postfix= - %page:title%' will add the current page title plus ' - ' to the end of the page name.
    {link-to:dashboard}Go to Dashboard{link-to}
    {link-to:news|space=ANOTHERSPACEKEY}Go to another space's news{link-to}
    {link-to:page source|popup=true}View page source{link-to}

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

    Parameters
    • [default] - The location to link to. See the list of locations below.
    • space - (optional) The spacekey to link to.
    • page/content - (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.
    Global Locations
    • 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
    • page hierarchy - The page in context of the page hierarchy.
    • pdf export - Export the page to PDF.
    • word export - Export the page in Microsoft Word format.
    • print - The print view for the page.
    {link-window:Another Page}Open Another Page in Another Window{link-window}

    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.
    • target - The title of the target 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.
    {list-ancestors:direction=ancestors|label=test}

    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

    {list-data:List Field}
    {list-option:Label}Value{list-option}
    {list-data}

    Allows selecting one or more options. Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • type - (optional) The type of field to display. May be one of the following:
      • select - (default) A selectable list is displayed.
      • check - A list of checkable items are displayed.
  • maxResults - (optional) The maximum number of items which will be in the list.
  • required - (optional) If 'true', a non-empty item must be selected. Defaults to 'false'.
  • blank - (optional) If 'true', a blank item is added to the list. Only applies to select lists.
  • blankText - (optional) The text to put in the blank option, if it is enabled.
  • multiple - (optional) If 'true', multiple options may be selected.
  • width - (optional) The width of the field. Any CSS width is allowed. Note: Only applies when type is 'select'.
  • height - (optional) The height of the field. Any CSS height is allowed. Note: Only applies when type is 'select'.
  • separator - (optional) If multiple items are selected, the type of separator to display between each item. Defaults to one item per line. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item.
    • brace - Braces ('{', '}') surrounding each item.
    • 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.
    {list-descendants:direction=ancestors|label=test}

    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

    {list-option:Label}*Wiki Text*{list-option}

    Defines a simple option for a list. Must be contained inside a list-data macro.

    • [default] - (required) The non-wiki label for the option.
    {list-pages:direction=ancestors|label=test}

    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

    {list-siblings:direction=ancestors|label=test}

    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

    {list-spaces:all}

    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

    {listlabels:spaceKey=@all}

    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.

    documentation, staff, events, books, music

    {live-template:Template Name}

    Imports and executes the specified template to the current page. This is different to creating a page using a template because it will always display the latest version of the template, rather than copying the original version.

    • [default]/name - (required) The template to import and display.
    {livesearch:id=1|spaceKey=KEY}

    Show search results keystroke by keystroke.

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

    {loremipsum} Insert paragraphs of "lorem ipsum" space-filler text
    {lozenge:title=Adaptavist.com|link=http://adaptavist.com|color=red}Click to visit...{lozenge}

    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

    {lucidchart} $macro.description
    {macro-list}

    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.

    {mail-captcha} Mail Captcha Block Macro
    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-submit}  {mail-clear:Clear The Mail Form}
    {mail-form}

    The {mail-clear} macro allows the user to reset the mail form.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-submit}
    {mail-form}

    The {mail-form} macro is the encompassing form within which all the other macros must be placed. The other macros will have undocumented behaviour in cases where they are placed outside of a {mail-form} macro. The form can either be linked to a configuration by id, have it's settings provided in parameters and encapsulated macros, or indeed both where the settings override that of the configuration.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-input:type=hidden|name=confUser|vtlValue=}
      {mail-textarea:name=message}{mail-textarea}
      {mail-input:type=text|name=from|cssStyle=width: 500px|validation=email|vtlValue=|required=true}
      {mail-submit}
    {mail-form}

    The {mail-input} macro provides an input field synonymous to a HTML input field and has no body.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-label:for=message}TextArea Label{mail-label}
      {mail-textarea:name=message|id=message}{mail-textarea}
      {mail-submit}
    {mail-form}

    The {mail-label} macro provides a label element synonymous to a HTML label element, its body is wiki rendered and is used as the label element's contents.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-select:name=exampleSelect|id=exampleSelect}
        {mail-option:value=optionOne|selected=true}Option One{mail-option}
        {mail-option:value=optionTwo}Option Two{mail-option}
      {mail-select}
      {mail-submit}
    {mail-form}

    The {mail-option} macro provides an option field synonymous to a HTML option field, its body is wiki rendered and is the outputted label for the option.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-select:name=exampleSelect|id=exampleSelect}
        {mail-option:value=optionOne|selected=true}Option One{mail-option}
        {mail-option:value=optionTwo}Option Two{mail-option}
      {mail-select}
      {mail-submit}
    {mail-form}

    The {mail-select} macro provides an select field (drop-down list) synonymous to a HTML select field, with options defined in it's body by the {mail-option} macro.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-submit}
    {mail-form}

    The {mail-submit} macro provides an submit button synonymous to a HTML submit button. While there is no requirement for a button to exist, there wouldn't be any other way for the user to submit the form.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-submit-img:src=http://www.domain.com/images/sendButton.png|alt=Send}
    {mail-form}

    The {mail-submit-img} macro allows the use of an image rather than the submit button provided by the {mail-submit} macro.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-submit}
      {mail-success:render=wiki}
        {tip:title=Message Accepted}Thank you -- we will be in touch shortly.{tip}
      {mail-success}
    {mail-form}

    The {mail-success} macro sets or overrides what is on successful submission. The body is rendered according to the render parameter, if there is no renderer specified then it is outputted as raw HTML.

    See Also: Plugin Homepage and Documentation

    {mail-form:destination=email@domain.com}
      {mail-textarea:name=message}{mail-textarea}
      {mail-submit}
    {mail-form}

    The {mail-textarea} macro provides an textarea field synonymous to a HTML textarea field, with the unrendered body being it's value.

    See Also: Plugin Homepage and Documentation

    {menu} {menuitem}[link]{menuitem} {menu}

    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

    {menubar} {menu} {menuitem}[link]{menuitem} {menu} {menubar}

    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

    {menuicon:iconname|size=16px|tooltip=my icon}

    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

    {menuitem}[link]{menuitem}

    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

    {menulink:destination}link text{menulink}

    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

    {menuseparator}

    Inserts a separator into a menu

    Parameters:

    • class - The CSS class name to assign

    See Also: User Guide and Examples

    {move-target:target}

    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

    {move-to:target=targetdiv} ... content ... {move-to}

    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

    {msn} Old style msn macro (if there was one)
    {multimedia} Insert audio and video files that are attached to any page (e.g. SWF, MOV, MP3, AVI).
    {navmap:mylabel}
    {navmap:mylabel|wrapAfter=3|cellWidth=110|cellHeight=20|theme=mytheme}

    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.

    {network} The network macro displays a summary of a user's network in a Confluence page.
    {news} An alias to blog-posts.
    {nl} Suppress rendering of a CamelCase link
    {noformat}
    pre-formatted piece of text
    so *no* further _formatting_ is done here
    {noformat}
    Makes a pre-formatted block of text with no syntax highlighting. All the optional parameters of {panel} macro are valid for {noformat} too.

    • nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel.
    Example:
    pre-formatted piece of text
    so *no* further _formatting_ is done here

    {note:title=Be Careful}
    The body of the note here..
    {note}

    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..
    {number-data:Number Field}0{number-data}

    Allows entering of a whole number value (eg 1, 4000). Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • type - (optional) The type of field to display. May be one of the following:
      • line - (default) A single-line number field.
      • select - A single-selection drop-down list box. Note: this type requires that there is a maximum range of 1000 between the min-value and max-value.
    • decimal - (optional) If 'true', the field will allow decimal values to be entered. Warning: Decimals are by their nature imprecise, and may result in some arithmatic errors at times. Only use them if necessary, and don't expect min-value and max-value to always be precise as boundaries.
    • minValue - (optional) The minimum value the number may be (inclusive).
    • maxValue - (optional) The maximum value the number may be (inclusive).
    • step - (optional) The amount each option should step when in 'select' mode. Eg. a step of 2 will produce options 1, 3, 5, etc. Defaults to 1.
    • format - (optional) The format the number should be output in when not being edited. See java.text.DecimalFormat for details.
    • required - (optional) If 'true', the field cannot be empty.
    {ol:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{ol}

    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

    {orphaned-links}No links exist{orphaned-links}

    {orphaned-links:style=square|excerpt=true}

    {orphaned-links:scope=Another Page>children}

    {orphaned-links:scope=A Different Page>descendents}

    {orphaned-links:spaces=MYSPACE}

    {orphaned-links:types=page,comment}

    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.

    {outgoing-links}No links exist{outgoing-links}

    {outgoing-links:style=square|excerpt=true}

    {outgoing-links:scope=Another Page>children}

    {outgoing-links:scope=A Different Page>descendents}

    {outgoing-links:spaces=MYSPACE}

    {outgoing-links:types=page,comment}

    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.
    {page-info:displaytype|page=Home|dateformat:ddMMYY HHmm}

    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

    {pagetree}

    {pagetree:root=PageName}

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

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

    {pagetree:searchBox=true}

    {pagetree:expandCollapseAll=true}

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

    • root: - (optional) page where the tree would be rooted from. Meta root names @self, @parent, @home can also be used.
    • sort: - (optional) sorts the tree node. It my be one of the following: bitwise, creation, modified, natural, position. Default sorting is position
    • excerpt: - (optional) true/false flag that indicate if a page excerpt would be included in the tree display (default is false).
    • reverse: - (optional) true/false flag that allows you to reverse the order of the display (default is false).
    • searchBox: - (optional) true/false flag that allows you to add a search box in the tree that would search from the root page (default is false).
    • expandCollapseAll: - (optional) true/false flag that allows you to add an expand all and a collapse all row (default is false).
    • startDepth: - (optional) a number that indicates the initial depth that the tree would display (default value is 1).
    {pagetree2:rootpage}
    {pagetree2:@home|iconStyle=builder}

    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

    {pagetreesearch}

    {pagetreesearch:rootPage=PageName}

    {pagetreesearch:rootPage=Space:PageName}

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

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

    {pagetreesearch}

    {pagetreesearch:rootPage=Your Page Name}

    {pagetreesearch:rootPage=space:pageName}

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

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

    {panel}Some text{panel}

    {panel:title=My Title}Some text with a title{panel}

    {panel:title=My Title| borderStyle=dashed| borderColor=#ccc| titleBGColor=#F7D6C1| bgColor=#FFFFCE}
    a block of text surrounded with a *panel*
    yet _another_ line
    {panel}
    Embraces a block of text within a fully customizable panel. The optional parameters you can define are the following ones:
    • title: Title of the panel
    • borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)
    • borderColor: The color of the border this panel uses
    • borderWidth: The width of the border this panel uses
    • bgColor: The background color of this panel
    • titleBGColor: The background color of the title section of this panel

    Example:

    My Title
    a block of text surrounded with a panel
    yet another line

    {popular:spaces=@all}

    {popular:spaces=dog,cat|types=page,blogpost}

    {popular:timespan=1m|events=create,view,update|max=20}

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

    {popular-labels}

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

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

    • count - (optional) Specify the number of labels to be displayed. If not specified, a default of 100 is used.
    • spaceKey - (optional) Restrict the popular labels to a certain space.
    • style - (optional) Allows 'heatmap'. Specifying a heatmap style will use different font sizes depending on their rank of popularity, ordered by label names. If not specified, a default list style is used ordered by popularity (highest first).

    {pre:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{pre}

    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

    {privacy-mark:Tooltip}

    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

    {privacy-policy:page|class=myclass}statement{privacy-policy}

    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

    {profile} The profile macro displays a summary of a user's profile in a Confluence page.
    {profile-username}

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

    See Also: User Guide and Examples

    {quote}
    here is quoteble
    content to be quoted
    {quote}

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

    Example:
    here is quotable
    content to be quoted
    {random-excerpt:SPACEKEY:pagetitle}

    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

    {recently-updated}
    {recently-updated: spaces=sales,marketing | labels=timesheets,summaries}
    {recently-updated: labels=+confluence,-jira | spaces=@all}
    {recently-updated: spaces=NOVELS,SHORTSTORIES | sort=creation | reverse=true}

    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.

    {recently-updated-dashboard}
    {recently-updated-dashboard: spaces=sales,marketing | labels=timesheets,summaries}

    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.

    {recently-used-labels}

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

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

    • count - (optional) Specify the number of labels to be displayed. If not specified, a default of 10 is used.
    • scope - (optional) Allows 'global', 'space' and 'personal'. If not specified, the 'global' scope is used. The global scope will show labels that were recently used within this confluence instance. The space scope will show labels that were recently used in the current space. The personal scope will show you personal labels that you recently used.
    • style - (optional) Allows 'table'. Specifying a table style will render the most recently used labels in a table form.
    • title - (optional) Allows you to specify a heading for the table view of this macro. See the 'style' option above.

    {reg-tm:class=myclass}Adaptavist{reg-tm}

    Inserts a registered trade mark: Adaptavist

    See Also: User Guide and Examples

    {related-labels}

    {related-labels:labels=labelone, labeltwo}

    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.

    {repeating-data:Repeating Data|order=desc|initialRows=5}
    Something: {text-data:Something}{text-data} Something Else: {number-data:Something Else}{number-data} {repeating-data}

    Defines a repeating section. The contents of the macro will be repeated 0-n times, depending how many have been added in edit mode. Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • order - (optional) If set to 'desc', the rows will list from bottom to top.
    • initialRows - (optional) The number of times the section should be repeated initially.
    {rollover:class=test}{div}content{div}{rollover} {table}{tr}{rollover:class=test}{td}content{td}{rollover}{tr}{table}

    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

    {roundrect:title=Some Title}Some content{roundrect}

    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

    {roundrect2} Duplicate Round Rectangle Macro (for nesting)
    {roundrect3} Duplicate Round Rectangle Macro (for nesting)
    {rss:url=http://host.com/rss.xml}

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

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

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

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

    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.

    {sametime} Old style sametime macro
    {scaffold} Marks a section as being part of the scaffolding. (Deprecated)
    {search:query=my_query}

    {search:query=my_query|maxLimit=x}
    Does an inline site search.
    • query: your query
    • maxLimit=x: (where x is any number > 0) to limit the search result to a number of results.
    • 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.
    PDF File file-containing-home.pdf ( download)
    {search-box}
    {search-box:all=true}

    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)
    • all - Search all spaces - overrides spaces list (true/false)

    See Also: User Guide and Examples

    {section}

    {column:width=30%}
    Column one text goes here
    {column}

    {column:width=70%}
    Column two text goes here
    {column}

    {section}


    {section:border=true}
    ...
    {section}

    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.

    {set-data:Text Field}Default value{set-data}
    {set-data:Number Field|type=number}123.45{set-data}
    {set-data:Date Field|type=date|format=d MMM, yyyy}1 Jan, 2007{set-data}
    {set-data:Page Field|type=content|value=My Page Title}
    {set-data:User Field|type=user|value=administrator}

    Allows entering of text in a single- or multiple-line text field. Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • value - (required) The value to set. You can alternatively use the body of the macro, which is useful if setting more complex wiki markup.
    • type - (optional) The type of field to display. May be one of the following:
      • text - (default) Text data.
      • number - An integer or decimal value.
      • date - A date.
      • boolean - A true/false value.
      • content - A link to a single Confluence page/news item. E.g. 'SPACEKEY:My Page' or just 'My Other Page'.
      • attachment - A link to a page/news item attachment. E.g. '^mypicture.jpg'.
      • user - A link to a registered user. This is their username, not their full name. E.g. 'joebloe' or 'administrator'.
    • format - (optional) The number format (e.g. '#, to use when parsing the value being set. The parameter will be ignored for data types other than 'number' or 'date'. This is basically required when the data type is 'date', since the default date format is unlikely to be used when setting a date.
    • hidden - (optional) When set to 'true', the value being set will not be displayed to the page viewer.
    {set-flag:flagname}

    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

    {shortcut-list}

    Prints a list of all configured shortcuts in this installation.

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

    {show-card:deck=My Deck|card=A Card}Show A Card{show-card}
    {show-card:deck=My Deck|card=@next|scrollTo=false}Show next card{show-card}

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

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

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

    labels=foo, -bar

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

    labels="foo-bar"
    • type(s) - (optional) the (list of) page types. May be:
      • page
      • news
      • comment
      • spacedescription
    • display(s) - (optional) the (list of) display modes. May be:
      • default - The standard display mode.
      • printable - Printer, PDF or Word mode.
      • pdf - PDF export mode.
      • word - Word export mode.
      • preview - Edit preview mode.
    • space(s) - (optional) the (list of) spaces.
    • action(s) - (optional) the action taking place.
      • view - The content is editable and is currently being viewed.
      • edit - The content is editable and is currently being edited.
      • template - The content is a template being previewed.
      • dashboard
      • - The content is the dashboard.
    • header(s) - (optional) the list of HTTP headers from the browser to check. Values are of the form "name:value" or "name::regexp" (note the double ":"). E.g: "header=referrer:/index.html" will match a referrer of exactly "/index.html". "header=referrer::.*/index.html" will match a referrer which ends with "/index.html". Multiple headers can be checked by separating with "," and optionally adding "+" for required or "-" for excluded.
    • 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.
    {show-to:user=bob|group=a-group,another-group|space=MYSPACE:edit}
    This text is only visible to bob, users in a-group or another-group, and users who can edit the MYSPACE Space. {show-to}

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

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

    user=foo, -bar

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

    user="foo-bar"
    • user - (optional) the (list of) users who cannot see the content. May also be one of the following special values:
      • @self - the user current user.
      • @anonymous - no user is logged in.
      • @authenticated - any user is authenticated.
    • group - (optional) the (list of) groups who can see the conent.
    • space:perm - (optional) the (list of) spaces where, if the user can view the space, they can see the content. The user's permission type to that space may be added also.
      • view - (default) the user can view the space.
      • edit - the user can edit pages.
      • admin - the user has administration access.
      • news - the user can post a news entry.
    • trim - (optional) if 'true' (the default), the content will be trimmed of whitespace at its beginning and end. (default).
    • match - (optional) specify the match type.
      • any - (default) the content is displayed if the user matches any of the criteria.
      • all - the content is displayed if the user matches *all* the criteria.
    • prerender - (optional) if 'true', the macros will be 'pre-rendered'. This is essentially a workaround for an issue where some macros will display underendered wiki markup when put inside this macro.
    {skype} Skype macro that is consistent with syntax of other old style im macros
    {skypeme} Old style skypeme macro
    {slide:Fruit Is Good}
    * Bananas are fruit
    * Fruit is healthy
    * Therefore, bananas are healthy
    {slide}

    {slide:title=More stuff|hide=true}
    * this slide still needs work
    {slide}

    Provides the slide content for the slideshow macro.

    Parameters

    • title - The title of the slide show. Default is blank. Can also be specified as the default paramter.
    • hide - Default to false. Set hide to true to hide the content from the slideshow.
    {slideshow:Bananas|subtitle=My Favourite Fruit}

    {slide:Fruit Is Good}
    * Bananas are fruit
    * Fruit is healthy
    * Therefore, bananas are healthy
    {slide}

    {slide:Colours}
    * Unripe ones are {color:green}green{color}
    * Good ones are {color:yellow}yellow{color}
    * Bad ones are {color:brown}brown{color}
    {slide}
    {slide:More stuff}
    h2. A Heading
    * Point
    * *Another* _point_ [home]

    h3. Third Level
    # one
    # two
    {slide}

    {slide:Charts Are Fun}
    {chart:title=My fruits|type=bar|dataOrientation=horizontal|width=500}
    |||Fruit||Banana||Apple||Raisin||
    |Rank||10|5|1|
    {chart}
    {slide}
    {slideshow}

    Provides the ability to collaborate with others in creating slide shows using simple Confluence markup. This takes advantage of the versioning and sharing capabilities of Confluence to make creating and maintaining slide shows productive. Confluence content can be easy included in the flow of the slide show. Slide re-use is simple. Viewers can quickly review the content in full screen or inline mode with no additional software. Parameters can be provided and they will be used to replace parameters in the body prior to rendering.

    Parameters

    • title - The title of the slide show. Can also be specified as the default paramter. Default is the title of the page.
    • subtitle - An additional title for the slide show. Default is blank.
    • authors - A comma separated list of author names. User ids will automatically convert to real names with profile links. Names containing commas must be enclosed double quotes ("). Default is the user that created the slide show page.
    • theme - Defaults to the default theme. Valid theme names are default and simple.
    • showInline - Default is true. Set to false to hide inline display of charts on the page.
    • showLabel - Default is Show. Text for the show and inline buttons.
    • hideLabel - Default is Hide. Text for the show and inline buttons.
    • inlineLabel - Default is inline. Text for the inline button.
    • authorsLabel - Default is blank. Text in front of the list of authors.
    {sm:class=myclass}Builder Hosting{sm}

    Inserts a service mark: Builder HostingSM

    See Also: User Guide and Examples

    {sorted-children:parent|sort=sortmode}

    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

    {space-description:spacekey}

    Displays the description of the named space

    Parameters:

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

    See Also: User Guide and Examples

    {space-details} Renders a table containing space details.
    {spacebookmarkslink} A macro that generates the links in the information panel in the .bookmarks page.
    {spacejump} This macro allows for creating links to jump to a page with the same name as the current one in a different space.
    {spaces:width=x}

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

    {spaces-list} Lists all spaces in Confluence. (deprecated - use {spaces} instead)
    {span:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{span}

    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

    {span2} Span Macro
    {span3} Span Macro
    {status-list} A Macro to list the Status Updates of a user
    {strike:class=myclass}stikeout{strike}

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

    See Also: User Guide and Examples

    {style:media=x,y,z|import=url}
    style sheet
    {style}

    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

    {sub-submenu} {menuitem}[link]{menuitem} {sub-submenu}

    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

    {submenu} {menuitem}[link]{menuitem} {submenu}

    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

    {table}Some content{table}

    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

    {table-cell}Some content{table-cell} {td}Some content{td}

    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

    {table-data:Editable Table}
    || Name || Value || Expires || | {text-data:Name} | {number-data:Value} | {data-data:Expires|format=dd-MMM-yyyy} | {table-data}

    Defines an editable table. Should contain a single header row ('||') and a single data row ('|'). The header row will be displayed once at the start of the table. The data row will be repeated for each row in the table. Make sure there are spaces around the '|' characters marking table cell boundaries. Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • order - (optional) If set to 'desc', the rows will list from bottom to top.
    • initialRows - (optional) The number of times the section should be repeated initially.
    {th}Some content{th}

    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

    {table-row}Some content{table-row} {tr}Some content{tr}

    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

    {tasklist} $macro.description
    {tbody}Some content{tbody}

    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

    {td} Creates an HTML table cell (td) tag
    {text-data:Text Field}Default value{text-data}

    Allows entering of text in a single- or multiple-line text field. Must be contained inside a scaffold macro.

    • [default]/name - (required) The name of the field.
    • type - (optional) The type of field to display. May be one of the following:
      • line - (default) A single-line text field.
      • password - A single-line password field.
      • area - A multi-line text area field.
    • content - (optional) The type of content in the field. May be one of the following:
      • wiki - (default) The content is wiki markup.
      • text - The content is plain text.
      • noformat - The content will appear inside a {noformat} section.
      • quote - The content will be quoted.
      • code:language - The content will be rendered as code, with an optional programming language such as Java or XML. E.g. 'content=code:JavaScript'.
    • minLength - (optional) The minimum number of characters that may be entered.
    • maxLength - (optional) The maximum number of characters that may be entered.
    • pattern - (optional) The regular expression the text must match.
    • patternInfo - (optional) If the pattern is specified, this is displayed if the saved value does not match it.
    • required - (optional) If 'true', the field cannot be empty.
    {th} Creates an HTML table heading (th) tag
    {thead}Some content{thead}

    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

    {tip:title=Handy Hint}
    Join the Confluence Mailing-List!
    {tip}

    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!
    {tm:class=myclass}Builder Theme{tm}

    Inserts a trade mark: Builder HostingTM

    See Also: User Guide and Examples

    {toc:style=disc|indent=20px}
    {toc:outline=true|indent=0px|minLevel=2}
    {toc:type=flat|separator=pipe|maxLevel=3}

    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.
    {toc-zone:separator\=brackets|location=top}
    h1. First Heading
    blah blah blah...
    {toc-zone}

    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.
    h1. {toggle-cloak:id=Cloaked Content} Cloaked Content

    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.
    {topusers:spaces=@all}

    {topusers:spaces=dog,cat|types=page,blogpost}

    {topusers:timespan=1w|period=daily|events=create,view,update|display=icon,title,count}

    A macro to show active users.

    • spaces: - (optional) a comma-separated list of spaces to restrict content to. By default the current space will be used.
    • display: - (optional) a comma-separated list of items to display (title, count by default). Allowed values are 'icon', 'title', 'count'.
    • events: - (optional) a comma-separated list of events to restrict top users based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
    • columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
    • 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 minute. 1w (1 week) is used by default.
    • period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.

    {tr} Creates an HTML table row (tr) tag
    {ul:class=name|style=css|align=align|title=title|id=id|dir=dir|lang=lang}content{ul}

    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

    {undefined-links}No links exist{undefined-links}

    {undefined-links:style=square|excerpt=true}

    {undefined-links:scope=Another Page>children}

    {undefined-links:scope=A Different Page>descenents}

    {undefined-links:spaces=MYSPACE}

    {undefined-links:types=page,comment}

    Creates a list of pages which are linked to but have not yet been created. 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.
    {usage:spaces=@all}

    {usage:spaces=dog,cat|types=page,blogpost}

    {usage:period=hourly|timespan=1d|events=create,view,update}

    A macro to show usage statistics.

    • 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).
    • events: - (optional) a comma-separated list of events to restrict content usage based on certain events (view events by default). Allowed events values are 'view', 'create', 'remove' and 'update'.
    • columns: - (optional) the type of column to display (event by default). Allowed column values are 'event', 'space' and 'type'.
    • timespan: - (optional) restrict the timespan of popularilty 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 minute. 1d (1 day) is used by default.
    • period: - (optional) the periodic interval to display (daily by default). Allowed period values are 'daily','weekly', 'monthly', 'yearly', 'hourly' and 'minutely'.

    {use-layout:layoutId}

    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

    {user-options:groups=a-user-group}

    Creates a set of list options linking to users matching the filter options. Must be contained inside a list-data macro.

    • groups - (optional) Only users in the specified groups will be listed.
    • spaces - (optional) Only users with the required access to the specified spaces will be listed. Permissions can be specified for each space. Eg:
      • SPACEKEY:view - (default) Only users with view access to the SPACEKEY will be listed.
      • SPACEKEY:edit - Only users with edit access to the space will be listed.
      • SPACEKEY:admin - Only users with administration access to the space will be listed.
      • SPACEKEY:blog - Only users who can post a blog (aka News) message will be listed.
    • users - (optional) Only users specified will be listed.
    • match - (optional) If set to 'all', the user must match all settings specified. Defaults to 'any'.
    {userlister}

    {userlister:groups=confluence-administrators}

    {userlister:online=true}

    {userlister:groups=confluence-users|online=true}

    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.

    {version-history:page=Home|dateFormat:ddMMYY HHmm|reverse=true|first=5}

    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

    {viewdoc} Inserts Microsoft Word content into the page
    {viewfile:presentation.ppt}

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

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

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

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

    • Microsoft Word Documents
    • - Embedded as html
    • Microsoft Excel Spreadsheets
    • - Embedded as html
    • Microsoft Powerpoint Presentations
    • - Embedded in a flash slideshow control or as a single image for individual pages
    • Adobe PDF files
    • - Embedded in a flash slideshow control or as a single image for individual pages
    • space: - (optional)the space key for the attachment. The default is the space of the page calling the macro.
    • page: - (optional)the page or blog post that contains the attachment. The default is the page calling the macro.
    • date: - (optional)the date of the blog post that contains the attachment in the form mm/dd/yyyy. Only applicable if the file is attached to a blog post
    • name: - (required)the filename of the attachment. Can also be specified as the first argument using macro shorthand. {viewfile:filename.ext}
    Macro arguments specific to Excel spreadsheets
    • grid - (optional)If true, the worksheet gridlines will be rendered. The default is true.
    • sheet - (optional)The name of the worksheet to render. The default is the first sheet in the workbook
    • row - (optional)the last row in the worksheet to render. The default is the last row with content.
    • col - (optional)the last column in the worksheet to render. The default the last column with content.
    Macro arguments specific to Powerpoint and PDF presentations
    • slide - (optional)instead of an entire slideshow, you can specify a slide index (0-based). the slide at the specified index will be rendered as a jpg image in the page.
    • height - (optional)overrides the default height of the flash control or image.
    • width - (optional)overrides the default width of the flash control or image.

    {viewmenu}

    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

    {viewpdf} Inserts a PDF document into the page as an interactive presentation
    {viewppt} Inserts an interactive Microsoft Powerpoint presentation into the page
    {viewxls} Inserts Microsoft Excel content into the page
    {visio:^diagram.vsd}

    {visio:page^diagram.vsd|height=400|bgColor=silver}

    {visio:space:page^diagram.vsd|page=true|pageTab=true|toolbar=true}

    {visio:file=space:page^diagram.vsd|pageIndex=2|zoom=.5}

    Displays a Visio diagram on a Confluence page. Diagram must be attached to a Confluence page. The user must have view permission to the page the attachment in on. This uses an IE Visio viewer control and needs IE, IE Tab in Firefox, or IE Tab in Chrome for rendering. The Visio viewer browser control is required and will be installed on first use based on user acceptance.

    • file - A required parameter that is equivalent to the default parameter. It specifies the location of the Visio file.
      • ^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.
    • width - The width of the Visio diagram in pixels or percent. Default is 100%.
    • height - The height of the Visio diagram in pixels. Default is 700.
    • bgColor - Background color of the diagram. Default is 'white'. See Colors.
    • pageView - Show Visio page view. Default is 'false'.
    • pageColor - Page color shown in page view. Default is 'silver'. See Colors.
    • grid - Grid is shown in page view. Default is 'false'.
    • pageTabs - Show Visio page tabs. Default is 'false'.
    • pageIndex - Initial page number to show. Default is '0' to show page when diagram was saved.
    • scrollBars - Show diagram scroll bars. Default is 'false'.
    • toolbar - Show toolbar. Default is 'false'.
    • contextMenu - Allows showing of viewer control menu with right click. Default is 'true'.
    • propertyDialog - Allows showing of the properties dialog from the context menu. Default is 'true'.
    • zoom - Zoom value. Default is '-1'. Specify a zoom percentage as a fraction (for example, 0.5 for 50% and 1.0 for 100%) or use any of the following values:
      • -1 = Whole page view
      • -2 = Page width view
      • -3 = Last zoom percentage
    • highQuality - Show diagram in highest quality (slower to display). Default is 'true'.
    • alerts - Show viewer control errors. Default is 'true'.
    • ieMessage - Message to display when IE render is not available to show the diagram. Use blank to not show a message. Otherwise a default message will show.
    • codebase - Advanced users only. Allows customization of the Microsoft Visio Viewer control being used.
    {warning:title=Warning}
    Insert warning message here!
    {warning}

    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!
    {watch-menu}[link]{watch-menu}

    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

    {watchlink:space=ds|page=Home|descendents=false|class=watchlink}Watch Demonstration Home Page{watchlink}

    The {watchlink} macro creates a link on the page that allows you to set a watch on another page.

    Parameters:

    • space - Is the key of the space that contains the page to be watched.
    • page - The title of the page to be watched.
    • descendents - Whether to watch just the specified page (false), or to watch all of it's descendants too (true). (true/false)
    • class - Allows you to specify a class attribute on the generated link markup, to allow custom styling in CSS.

    See Also: User Guide and Examples

    {web-widget} Alternative syntax to the widget macro.
    {webui-list}

    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

    {welcome-message}

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

    {widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E}
    {widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E | width=500 | height=400}

    Widget Connector

    • url - (required) The URL to the widget you want to display in Confluence
    • {widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E}
    • width & height - (optional) Specify the width and height of your widget
    • {widget:url=http://au.youtube.com/watch?v=cOE8ukQoz6E | width=500 | height=400}
    {wikimenu}
    * menu
    ** submenu
    *** submenuitem
    {wikimenu}

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

    See Also: User Guide and Examples

    {wildfire} Old style wildfire macro
    {with-ancestor:label=test} ... content ... {with-ancestor}

    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
    {with-descendant:label=test} ... content ... {with-descendant}

    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
    {with-page:direction=ancestors|label=test} ... content ... {with-page}

    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
    {with-sibling:label=test} ... content ... {with-sibling}

    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
    {word:file=^Report.doc}


    {word:file=Year 2005^Report.doc|section=1,2}


    {word:file=word/Report.xls}

    Displays one or more sections from Microsoft Word document (Word 97, 2000, 2003).

    Warning - this macro is alpah-level and not for production use. It only partially handles word documents with simple constructs.

    • file - A required parameter unless url is specified. It specifies the location of the Word document.
      • ^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.
      • filename - Data is read from the file located in confluence home directory/script/filename. Subdirectories can be specified.
    • url - Only required if file is not specified. Specifies the URL of an Excel file. Use of this parameter may be restricted for security reasons. See your administrator for details.
    • sections - By default, each section in the document will be included. Use the sections parameter to control what sections of the document will be shown. The parameter value can be a comma separated list of section numbers (1-based counting)
    {yahoo} Old style yahoo macro
    Labels:
    support support Delete
    macros macros Delete
    confluence confluence Delete
    needs needs Delete
    sierra sierra Delete
    Enter labels to add to this page:
    Please wait 
    Looking for a label? Just start typing.