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'.
{aim} Old style AIM presence macro (Legacy)
{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} Create an anchor that allows people to link to a specific point in a page
{attachment-data} $macro.description
{attachment-options} $macro.description
{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-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.

{blogpost} An alias to blog-posts.
{blogposts} An alias to blog-posts.
{blogs} An alias to blog-posts.
{boilerplate} $macro.description
{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} Defines a section which will be only shown at certain times.
{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}
{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>}
children.desc.text

Example:

  • children.child
  • children.another.child
  • children.child
    • children.first.grandchild
  • children.another.child

children.desc.text2
{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} Defines a section of content which can be hidden or revealed.
{code} Macro to format blocks of source-code or XML. (Legacy)
{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} Change the colour of the contained text
{column}
{composition-setup} Sets up the page to allow composition macros to be used.
{content-by-user:fred}

usertable.desc

{content-options} $macro.description
{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} Lists all of the authors of a page (Legacy)
{contributors-summary} Displays a summary in table form of pages and contributors (Legacy)
{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

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} $macro.description
{date-data} $macro.description
{deck} Defines a section of 'cards' - pieces of content which are shown one at a time.
{details} Record (and display) details about a page (Legacy)
{detailssummary} Show a tabular view of a series of details stored in pages in the same space (Legacy)
{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} $macro.description
{editinwordlink} Adds a hyperlink for editing in Word
{eval-data} $macro.description
{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}excerpt.example.text{excerpt}

{excerpt:hidden=true}excerpt.example.text.hidden{excerpt}
excerpt.desc
  • excerpt.hidden.desc
{excerpt-data} $macro.description
{excerpt-include:Home}

{excerpt-include:Home|nopanel=true}

{excerpt-include:blogPost=/2006/12/28/News Page}
excerptinclude.desc
  • excerptinclude.nopanel.desc
{expand} $macro.description
{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

{favpages} List the pages in your favourites list.
{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} Allows the contents of the macro to float to the left or right.
{footnote}text of footnote{footnote}

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

See Also: User Guide and Examples

{gadget} $macro.description
{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} $macro.description
{global-reports} $macro.description
{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} $macro.description
{gtalk} Old style Gtalk presence macro (Legacy)
{hidden-data} $macro.description
{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} Use HTML code within a Confluence page (Legacy)
{html-include} Retrieve an external HTML file and include it in the page (Legacy)
{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

{icq} Old style ICQ presence macro (Legacy)
{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} Displays a status graphic for a specified IM id (Legacy).
{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

{include:Home}

{include:FOO:Home}

{include:spaceKey=FOO|pageTitle=Home}
include.desc

include.user.perms

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

index.desc

{info} $macro.description
{jira}
{jiraissues}
{junitreport:directory=file:///c:/test-reports}
junitreport.currently.only.supports.xml

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

junitreport.success.rate junitreport.tests junitreport.failures junitreport.times junitreport.times
93%
14 1 0 1.531

{label-options} $macro.description
{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-data} $macro.description
{list-option} $macro.description
{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} $macro.description
{livesearch} $macro.description
{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

{msn} Old style MSN presence macro (Legacy)
{multimedia} $macro.description
{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.
{newcode} Macro to format blocks of source-code or XML. This macro uses the key "{newcode}" to maintain backwards compatibility with earlier versions of the plugin. (Legacy)
{news} An alias to blog-posts.
{nl} $macro.description
{noformat} Create blocks of text where other wiki formatting is not applied
{nolink} $macro.description
{note} $macro.description
{number-data} $macro.description
{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).

{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} Draw a panel with an optional title and border
{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.
{quote} Generate blockquotes that may contain multiple paragraphs or complex markup
{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 Confluence content which has changed recently. By default, listed content will be listed from the current space. Returned content may be filtered through the various parameters.

  • 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 the rendered 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} Displays recent updates with filtering options. Used on the dashboard.
{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} $macro.description
{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} Retrieve a remote RSS feed and summarise it in the page (Legacy)
{sametime} Old style Sametime presence macro (Legacy)
{scaffold} $macro.description
{search:query=my_query}

{search:query=my_query|maxLimit=x}
inlinesearch.desc
  • query: inlinesearch.query.desc
  • maxLimit=x: inlinesearch.maxlimit.desc
  • spacekey: inlinesearch.spacekey.desc
  • type: inlinesearch.type.desc
  • lastModified: inlinesearch.lastmodified.desc
  • contributor: inlinesearch.contributor.desc

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}
{set-data} $macro.description
{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} Shows a card for a specific deck.
{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} Old style Skype presence macro (Legacy)
{skypeme} Old style Skypeme presence macro (Legacy)
{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

{space-attachments}
{space-details} $macro.description
{spacejump}
{spaces} $macro.description
{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} Status macro for Confluence (pre-4.0)
{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

{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} $macro.description
{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} $macro.description
{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} $macro.description
{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.
{toggle-cloak} Creates a link which allows a cloaked section to be hidden or revealed.
{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'.

{user-options} $macro.description
{userlister}
{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.

{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} $macro.description
{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} $macro.description
{welcome-message} Insert welcome message text.
{widget} $macro.description
{wildfire} Old style Wildfire presence macro (Legacy)
{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 presence macro (Legacy)