Example:

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

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

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}

• target=[new|popup] - (Optional) by default opens in the same window
• style=[any string] - (Optional) CSS Styles
• class=[any string] - (Optional) CSS Class
• specs=[specs] - (Optional) window.open() specifications.

{link:target=popup|style=color:blue;|specs=left=10,top=10,width=300,height=300,scrollbars=no}Open popup link|Test Page 1{link}

{link:style=color:red;}Open link in new window|Test Page 1{link}

{link:style=color:green;}Green download link|^attachement1.gif{link}

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

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

• default - The child page title (if it already exists but is not a child of the current page then a number will be appended)
• template - the name of the template to apply to the child page
• portal - the name of the portal to inject into the child page
• content - the content to place into the child page
• render - pre-render the child page (default false)

See Also: User Guide and Examples

Used to display a menubar

Parameters:

• _default_ - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• id - alternative (original) way of specifying the html id
• class - The CSS class name to assign to div wrapping the menu
• classname - The CSS class name to assign to items in the menu
• electric - true (or number) - Pop-up menus will automatically open when the mouse hovers over their parent item, or their parent item gets keyboard focus, false - Pop-up menus will only be displayed when the parent item is clicked or when the the parent item is selected and the left arrow key (or spacebar) is pressed (default true)
• timeout - Defines the number of milliseconds to wait before menus are automatically shown when the "electric" parameter is set to true
• vertical - false - Items on the top level of the menu bar are shown horizontally, true - Items on the top level of the menu bar are shown vertically (ideal for putting menus in sidebars) (default false)
• context - see userguide
• tooltips - true - Tooltips, if specified in linked menu items, are shown when the mouse hovers over a menu item, false - Tooltips are not shown, useful when your target audience is using a slow internet connection or slow computer (default true)
• shadows - see userguide
• smooth - true - Shadows will look smoother in most browsers (requires an additional image to be loaded), false - Basic shadows will be used (slightly faster loading of pages) (default true)
• blink - false - Menu items do not blink when clicked, true - Menu items blink a few times when clicked to give more visual feedback to the end-user (default false)
• lazy - false - After the web page loads, the entire menu is "built" immediately, true - After the web page loads, only the top level of the menu is "built" and subsequent levels (i.e. pop-up menus) are only built when they are first displayed (default false)
• toolbar - false - The top level of the menu displays normally, true - Additional styling is applied which makes items on the top level of the menu take up less space, ideal for toolbars. Note that some menu styles (e.g. the Longhorn style) don't currently support this feature (default false)
• clone - see userguide
• focus - automatically focus the menu (default false)
• scrolling - true - If a menu is too big to fit in the browser window, scroll buttons will appear at either end to allow the user to "scroll" the menu. It's a really nice feature!, false - Menus will be shown in their entirety, even if that means that part of them can't be seen within the browser window (default true)

See Also: User Guide and Examples

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

Parameters:

• class - The CSS class name to assign to an item in a menu
• subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
• id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
• autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
• custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• size - the size of the icon to use
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

Used to create a menu

Parameters:

• class - The CSS class name to assign to an item in a menu
• subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
• id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
• autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
• custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

Used to create a submenu

Parameters:

• class - The CSS class name to assign to an item in a menu
• subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
• id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
• autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
• custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

Used to create a submenu

Parameters:

• class - The CSS class name to assign to an item in a menu
• subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
• id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
• autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
• custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

Used to create a menuitem

Parameters:

• class - The CSS class name to assign to an item in a menu
• subclass - The CSS class name to assign to a pop-up menu that's associated with an item in a menu
• id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• subid - The HTML ID (must be unique for entire web page) associated to a pop-up menu that's associated with an item in a menu
• autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
• custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• notitle - false : removes the title from submenus
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

Used to create a menuitem which contains a menulink and icon

Parameters:

• caption - the text to use in the link
• default - the piece of confluence functionality you wish to link to
  • RSS - go to rss feed editor
  • activity - show site/space activity
  • advanced - go to advanced config page
  • browse - link to browse space
  • builderadmin - link to builder administration
  • children - show/hide children toggle
  • colourscheme - go to colour scheme selector
  • comments - show/hide comments toggle
  • configuretheme - configure the theme
  • 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
  • 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
  • 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
• layout - the layoutId to use when the link is used
• latch - whether the layout should be latched when the link is used
• class - The CSS class name to assign to an item in a menu
• id - The HTML ID (must be unique for the entire web page) associated with an item in the menu
• autohide - true : the item will be removed if it doesn't contain a hyperlink, false : the item will always be shown regardless of whether it contains a hyperlink or not, disabled : the item will always be shown, but if it doesn't contain a hyperlink it will be "visually" disabled (e.g. grey text and faded icon) (default true)
• custom - false : a normal menu item, which may contain a pop-up menu if there are hierarchically lower items found, true : allows you to embed just about anything in a menu item, defaults the "autohide" setting to false and prevents you from having a pop-up menu associated with the item (default false)
• flat - false : a normal menu item designed for use in a hierarchical structure, true : a "flat" (non-hierarchical) menu item (default false)
• location - the webui location to use with webui links
• key - the webui key to use with webui links
• linkId - the html id to be applied to the link
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

Inserts a separator into a menu

Parameters:

• class - The CSS class name to assign

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

• default - the piece of confluence functionality you wish to link to
  • RSS - go to rss feed editor
  • activity - show site/space activity
  • advanced - go to advanced config page
  • browse - link to browse space
  • builderadmin - link to builder administration
  • children - show/hide children toggle
  • colourscheme - go to colour scheme selector
  • comments - show/hide comments toggle
  • configuretheme - configure the theme
  • 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
  • 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
  • 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
• layout - the layoutId to use when the link is used
• latch - whether the layout should be latched when the link is used
• checkexists - whether userspace menulink should check to see if the user has a personal space (default false)
• force - force the comments or children link to be displayed when there are no comments or children to the page (default false)
• forceicon - force the icon to be displayed irrespective of the layout (default false)
• location - the webui location to use with webui links
• key - the webui key to use with webui links
• linkId - the html id to be applied to the link
• flag - Will only be rendered if any of the flags have been set using set-flag.
• notflag - Will not be rendered if any of the flags have been set using set-flag.

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

Allows additions to be made to menulink replacements

Parameters:

• default - The replacement text

See Also: User Guide and Examples

Inserts the confluence space/site logo into a builder panel

Parameters:

• global - force macro to display global logo
• class - HTML classname to apply (use 'png' to allow PieNG to recognise PNG logos)
• space - the space whose logo should be shown

See Also: User Guide and Examples

Inserts the confluence breadcrumb trail into a builder panel

See Also: User Guide and Examples

Returns the title of the current page/action

See Also: User Guide and Examples

Includes the confluence personal sidebar into a builder panel

See Also: User Guide and Examples

Inserts the confluence quick label editor into a builder panel

See Also: User Guide and Examples

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

Parameters:

• context - comma separated list of contexts (the kind of page being displayed eg: page, blogpost, dashboard) where the content should be shown
• mode - comma separated list of modes that the content is being viewed as (eg: view, edit) where the content should be shown
• decorator - comma separated list of decorators (eg: printable) where the content should be shown
• action - comma separated list of actions (eg: viewpage/login/logout) where the content should be shown
• spacekey - the space against which permission checks will be made (default current space)
• pagetitle - the page against which permission checks will be made (default current page)
• space - comma separated list of spaces if the content is within one of these spaces then it will be shown, the type of space can also be checked through the @global and @personal meta keys
• page - 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)
• title - 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 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

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

See Also: User Guide and Examples

Inserts the confluence favourite icon into a builder panel

See Also: User Guide and Examples

Inserts the confluence watch icon into a builder panel

See Also: User Guide and Examples

Inserts the confluence comments display and editor into a builder panel

See Also: User Guide and Examples

Inserts the confluence children display into a builder panel

See Also: User Guide and Examples

Inserts the confluence welcome message into a builder panel

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

Inserts the confluence info-panel display into a builder panel

See Also: User Guide and Examples

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

Parameters:

• default - either just the page title, or the spacekey and page-title pair of the page whose content should be injected
  The page title may also be defined as @parent or @home in which cases the parent page and space home page will be used
• pagetitle - the title of the page where the content should come from (overriden by default param above)
• spacekey - the space where the content should come from (overriden by default param above)
• 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

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)

See Also: User Guide and Examples

Used to set the layout used for the current page.

Parameters:

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

See Also: User Guide and Examples

Returns an unordered list of all permitted spaces

Parameters:

• default - Filter the list of spaces (all/global/personal)
• teams - A comma separated list of team labels that are used to filter the list of spaces
• reverse - List the spaces in reverse order
• count - The number of spaces that should be displayed
• start - Offset from the start for listing the spaces

See Also: User Guide and Examples

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

Parameters:

• rootpage - 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
  • @parent - the parent of the current page
  • @space - the currently viewed space showing all top-level pages and also news items
  • @root - same as @space
  • @home - the homepage of currently viewed space (does not include news items)
  • @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

hides a block of content based on the user's level

Parameters:

• rootpage - The root of the pagetree (defaults to space)
  • SPACEKEY:pagename - a prefedined page
  • pagename - a prefedined page
  • @self - the current page
  • @parent - the parent of the current page
  • @space - the currently viewed space
  • @root - the currently viewed space
  • @home - the homepage of currently viewed space
  • @dashboard - the confluence dashboard
• space - the space that should be used for the root of this pagetree
• page - the name of the page that should be use for the root of this pagetree
• treename - the name of the tree that this panel should react to

See Also: User Guide and Examples

Displays a sorted list of children

Parameters:

• parent - Page whos 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
  • @parent - the parent of the current page
  • @space - the currently viewed space showing all top-level pages and also news items
  • @root - same as @space
  • @home - the homepage of currently viewed space (does not include news items)
• 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)
• sort - The mode to sort in (defaults to sorted)
  • sorted - Sorted using sort Id's & natural sorting
  • natural - Sorted into natural order
  • confluence - Confluence default sort order

See Also: User Guide and Examples

Sets the sort order for a page

Parameters:

• sortid - The id value on which sorting is based (usually a number)

See Also: User Guide and Examples

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

Parameters:

• direction - the direction that the macro should look in when searching for the page to render with (REQUIRED)
  • ancestor/ancestors/up - search for the page to render with amongst the ancestors of the start page
  • descendant/descendants/down - search for the page to render with amongst the descendants of the start page
  • sibling/siblings - search for the page to render with amongst the siblings of the start page
  • children - search for the page to render with amongst the children of the start page
  • none - dont search, just use the start page
• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages
• searchMode - list/single (default = single - Find the first page that matches)

Replacements:

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

See Also: User Guide and Examples

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

Parameters:

• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages
• searchMode - list/single (default = single - Find the first page that matches)

Replacements:

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

See Also: User Guide and Examples

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

Parameters:

• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages
• searchMode - list/single (default = single - Find the first page that matches)

Replacements:

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

See Also: User Guide and Examples

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

Parameters:

• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages
• searchMode - list/single (default = single - Find the first page that matches)

Replacements:

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

See Also: User Guide and Examples

Used to output a list of other pages

Parameters:

• direction - the direction that the macro should look in when searching for the pages to render with (REQUIRED)
  • ancestor/ancestors/up - search for the page to render with amongst the ancestors of the start page
  • descendant/descendants/down - search for the page to render with amongst the descendants of the start page
  • sibling/siblings - search for the page to render with amongst the siblings of the start page
  • children - search for the page to render with amongst the children of the start page
  • none - dont search, just use the start page
• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages

See Also: User Guide and Examples

Used output a list of other pages

Parameters:

• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages

See Also: User Guide and Examples

Used output a list of other pages

Parameters:

• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• reverse - List the pages in reverse order
• count - The number of pages that should be displayed
• start - Offset from the start for listing the pages

See Also: User Guide and Examples

Used to output a list of other pages

Parameters:

• startPage - the page to start the search from
  • @self - the current page (default)
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• 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
  • @self - the current page
  • @root - the root of the current page's tree
  • @parent - the parent of the current page
  • @home - the homepage of the current space
  • pagetitle - a named page (either the page title, or spacekey:title)
• sort - The order that the pages should be listed in (creation/modified/recent/title/natural/unsorted - default unsorted)
• 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

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

Parameters:

• default - The page title whose child should be shown (default @self)
• sort - the sort order that decides which child should be shown (creation/modified/recent/title/natural)

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

Used to prevent jQuery lazy loading from being used on the current page.

See Also: User Guide and Examples

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

Parameters:

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

See Also: User Guide and Examples

Generates a nested list of links to blog posts

Parameters:

• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal - default @current)
• teams - A comma separated list of team labels that are used to filter the list of spaces
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of authors 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=true - oldest first)
• count - The number of posts that should be displayed (default = all)
• start - Offset from the start for listing the posts (default = 0)
• years - Nest list for each year (default - true)
• months - Nest list for each month (default - true)
• days - Nest list for each day (default - false)
• posts - Show links to each post (default - true)
• excerpt - Include the excerpt in the post display (default - true)
• none - Text to display when no posts have been found

See Also: User Guide and Examples

Displays a list of blog posts and excerpts

Parameters:

• default - display mode (singlespace/multispace)
• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal - default @current)
• teams - A comma separated list of team labels that are used to filter the list of spaces
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of authors 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)
• title - Show the Title of the blogpost (default=true)
• linktitle - Link the title to the blogpost (default=true)
• excerpt - Display the excerpt of the blogpost (true/false/full - default true)
• postedby - Display the date that the post was created (true/false/date default true)
• permalink - text to use for tiny url (set as blank to omit tinyURL)
• postedByCaption - text to use for posted by
• none - Text to display when no posts have been found

See Also: User Guide and Examples

Generates RSS 2.0 xml

Parameters:

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

See Also: User Guide and Examples

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

Parameters:

• space - A comma separated list of spaces whose posts should be listed (SPACEKEY/@all/@current/@favourite/@global/@personal - default @current)
• teams - A comma separated list of team labels that are used to filter the list of spaces
• label - A comma separated list of labels that are used to filter the list of blogposts
• author - A comma separated list of authors 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

Displays a the blog calendar

Parameters:

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

See Also: User Guide and Examples

Inserts the confluence quick-search box into a builder panel

See Also: User Guide and Examples

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

Parameters:

• default - either just the page title, or the spacekey and page-title pair of the page whose children the excerpt should be randomly selected from
• title - output the page title (default - true)
• link - add more link to the page whose excerpt is being displayed (default - true)
• more - text to use for the link to the page (default - 'More ...')
• label - comma separated list of labels which the content must have at least one for it to be shown
• class - the css classname to add to the outer div
• count - the number of excerpts to be shown (default 1)
• hide - whether to hide the extra excerpts or not (default false)

See Also: User Guide and Examples

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

Parameters:

• _default_ - the flag name
• state - the state of the flag (default true)
• flag - a comma separated list of flags to check, will only display if at least one of the flags is present
• notflag - a comma separated list of flags to check, will only display if none of the flags are present

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

See Also: User Guide and Examples

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

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

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

Prints a simple note to the user.

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

Be Careful The body of the note here..

Prints a warning note to the user.

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

Warning Insert warning message here!

Prints an informational note.

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

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

Prints a helpful tip for the user.

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

Handy Hint Join the Confluence Mailing-List!

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

preformatted piece of text
so *no* further _formatting_ is done here

• title: Title of the panel
• borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles)
• borderColor: The color of the border this panel uses
• borderWidth: The width of the border this panel uses
• bgColor: The background color of this panel
• titleBGColor: The background color of the title section of this panel

Example:

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

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

    Standard charts

    • pie (default)
    • bar
    • line
    • area

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

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

    Other charts

    • gantt - beta - See Gantt Charts.
    
    
  • orientation - A bar, line, or area chart will be displayed vertically (y axis is vertical) unless 'orientation=horizontal' is specified.
  • 3D - A pie, bar, or line chart will be shown in 3D if 3D=true is specified.
  • stacked - A bar or area chart will be shown with stacked values if stacked=true is specified.
  • showShapes - Shapes will be shown at each data point in a line chart unless showShapes=false.
  • opacity - A percent value between 0 (not visible) and 100 (non-transparent) that determines how opaque the foreground areas and bars display. Defaults are:
    • 75 percent for 3D charts
    • 50 percent for non-stacked area charts
    • 100 percent for all other charts
• Display control parameters
  • width - The width of the chart in pixels (default is '300')
  • height - The height of the chart in pixels (default is '300')
  • dataDisplay - Default is false to not display the rendered body of the macro (usually the data tables). When dataDisplay=true or dataDisplay=after, the data will be displayed after the chart. When dataDisplay=before, the data will be displayed before the chart.
  • imageFormat - Default is png. Format of generated image. Valid formats are png and jpg. Other formats may be also be valid if installed on your server.
• Title and label customization parameters
  • title - The title of the chart.
  • subTitle - A subtitle for the chart using a smaller font.
  • xLabel - The label to use for the x (domain) axis
  • yLabel - The label to use for the y (range) axis
  • legend - A legend will be displayed unless legend=false is specified.
• Data specification parameters - The data for the chart is taken from tables found when the macro body is rendered. These options control how this data is interpreted. By default, numeric and date values are interpreted according to the Confluence global default language (locale) formats. If conversion fails, other languages defined to Confluence will be tried. Additional conversion options can be specified using the parameters below.
  • tables - Comma separated list of table ids and/or table numbers contained within the body of the macro that will be used as the data for the chart. Defaults to all first level tables. If data tables are embedded in other tables, then table selection will be required. This occurs when more complex formatting is done (for example using section and column macros).
  • columns - Comma separated list of column labels and/or column titles and/or column numbers for tables used for chart data. This applies to all tables processed. Defaults to all columns. Columns are enumerated starting at 1. Column label is the text for the column in the header row. Column title is the (html) title attribute for the column in the header row.
  • dataOrientation - The data tables will be interpreted as columns (horizontally) representing domain and x values unless 'dataOrientation=vertical'.
  • timeSeries - If 'true', the x values in an XY plot will be treated as time series data and so will be converted according date formats.
  • dateFormat - For time series data, the date format allows for additional customization of the conversion of data to date values. By default, the Confluence language defined date formats will be used. If a dateFormat is specified, it will be the first format used to interpret date values. Specify a format that matches the format of the time series data. See Date Format.
  • timePeriod - Specify the time period for time series data. Default is 'Day'. This defines the granularity of how the data is interpreted. Valid values are: Day, Hour, Millisecond, Minute, Month, Quarter, Second, Week, Year.
  • language - If provided, the language and country specification will be used to create additional number and date formats to be used for data conversion. This specification will be used before the default languages automatically used. Valid values are 2 character ISO 639-1 alpha-2 codes.
  • country - Used in combination with the language parameter. Valid values are 2 character ISO 3166 codes.
  • forgive - Default is true to try to convert numeric and date values that do not totally match any of the default or user specified formats. Specify forgive=false to enforce strict data format. Data format errors will cause the chart to not be produced.
• Color customization parameters - See Colors for how to specify colors.
  • bgColor - Color (default is 'white') to use as the background of the chart.
  • borderColor - Color of a border around the chart. Default is to not show a border.
  • colors - Comma separated list of colors used to customize category, sections, and series colors.
• Axis customization parameters - Depending on the chart type, the range and domain axis may be customized. These values are automatically generated based on the data but can be overridden by specifying one or more more of these paramters.
  • rangeAxisLowerBound - range axis lower bound
  • rangeAxisUpperBound - range axis upper bound
  • rangeAxisTickUnit - range axis units between axis tick marks
  • rangeAxisLabelAngle - angle for the range axis label in degrees
  • domainAxisLowerBound - domain axis lower bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter
  • domainAxisUpperBound - domain axis upper bound. For a date axis, this value must be expressed in the date format specified by the dateFormat parameter
  • domainAxisTickUnit - domain axis units between axis tick marks. For a date axis, this value represents a count of the units specified in the timePeriod parameter. The time period unit can be overridden by specifying a trailing character: y for years, M for months, d for days, h for hours, m for minutes, s for seconds, u - milliseconds
  • domainAxisLabelAngle - angle for the domain axis label in degrees
  • categoryLabelPosition - allows axis label text position for categories to be customized
    • up45 - 45 degrees going upward
    • up90 - 90 degrees going upward
    • down45 - 45 degrees going downward
    • down90 - 90 degrees going downward
  • dateTickMarkPosition - placement of the date tick mark
    • start (default) - tick mark is at the start of the date period
    • middle - tick mark is in the middle of the date period
    • end - tick mark is at the end of the date period
• Pie chart customization parameters
  • pieSectionLabel - Format for how pie section labels are displayed. :
    • %0% is replaced by the pie section key.
    • %1% is replaced by the pie section numeric value.
    • %2% is replaced by the pie section percent value.
    Example 1: "%0% = %1%" would display something like "Independent = 20"
    Example 2: "%0% (%2%)" would display something like "Independent (20%)"
  • pieSectionExplode - Comma separated list of pie keys that are to be shown exploded. Defaults to no exploded sections. Note: requires jFreeChart version 1.0.3 or higher.
• Attachment parameters - These are advanced options that can be used for chart versioning, automation enablement, and to improve performance. Use these options carefully! Normally, the chart image is regenerated each time the page is displayed. These options allow for the generated image to be saved as an attachment and have subsequent access re-use the attachment. This can be useful especially when combined with the cache macro to improve performance. Depending on the options chosen, chart images can be versioned for historical purposes.
  • attachment - Chart image will be saved in a attachment.
    • ^attachment - chart.macro.param.attachment.attachment
    • page^attachment - The chart is saved as an attachment to the page name provided.
    • space:page^attachment - The chart is saved as an attachment to the page name provided in the space indicated.
  • attachmentVersion - Defines the the versioning mechanism for saved charts.
    • new - (default) Creates new version of the attachment.
    • replace - Replaces all previous versions of the chart. To replace an existing attachment, the user must be authorized to remove attachments for the page specified.
    • keep - Only saves a new attachment if an existing export of the same name does not exist. An existing attachment will not be changed or updated.
  • attachmentComment - Comment used for a saved chart attachment.
  • thumbnail - Default is false. If true, the chart image attachment will be shown as a thumbnail.

Colors

Date Format

Copied from Java SimpleDateFormat specification.

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

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

• Text: For formatting, if the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available. For parsing, both forms are accepted, independent of the number of pattern letters.
• Number: For formatting, the number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount. For parsing, the number of pattern letters is ignored unless its needed to separate two adjacent fields.
• Year: For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.

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

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

• Month: If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
• General time zone: Time zones are interpreted as text if they have names. For time zones representing a GMT offset value, the following syntax is used:

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

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

  For parsing, RFC 822 time zones are also accepted.

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

       RFC822TimeZone:
               Sign TwoDigitHours Minutes
       TwoDigitHours:
               Digit Digit

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

  For parsing, general time zones are also accepted.