Wiki Notation Guide
Uploaded by
Sumit PriyaWiki Notation Guide
Uploaded by
Sumit PriyaWiki Notation Guide
Headings To create a header, place "hn. " at the start of the line (where n can be a number from 16). Notation Comment h1. Biggest heading h2. Bigger heading h3. Big Heading h4. Normal Heading h5. Small Heading Biggest heading Bigger heading Big Heading Normal Heading Small Heading
h6. Smallest Heading Smallest Heading Text Effects Text effects are used to change the formatting of words and sentences. Notation Comment *strong* _emphasis_ ??citation?? -strikethrough+underlined+ ^superscript^ ~subscript~ {{text will be monospaced}} bq. Some block quoted text Makes text strong. Makes text emphasis. Makes text in citation. Makes text as . Makes text as underlined. Makes text in superscript. Makes text in subscript. Makes text as code text. To make an entire paragraph into a block quotation, place "bq. " before it. Example: Some block quoted text Quote a block of text that's longer than one paragraph. Example: here is quoteable content to be quoted Changes the color of a block of text. Example: look ma, red text!
{quote} here is quoteable content to be quoted {quote} {color:red} look ma, red text! {color} Text Breaks
Most of the time, explicit paragraph breaks are not required - Confluence will be able to paginate your paragraphs properly. Notation Comment (empty line) \\ -----Produces a new paragraph Creates a line break. Not often needed, most of the time Confluence will guess new lines for you appropriately. creates a horizontal ruler Produces symbol.
-Produces symbol. Links Links are the heart of Confluence, so learning how to create them quickly is important. Notation Comment Creates an internal hyperlink to the specified page in the desired space (or the current one if you don't specify any space). Appending the optional '#' sign followed by an anchor name will lead into a specific bookmarked point of the desired page. Also having the optional '^' followed by the name of an attachment will lead into a link to the attachment of the desired page. Example: pagetitle If such a page doesn't already exist, it will allow you to create the page in the current space. Create page links will have a after them. Example: anewpage
[#anchor] [^attachment.ext] or [pagetitle] [pagetitle#anchor] [pagetitle^attachment.ext] or [spacekey:pagetitle] [spacekey:pagetitle#anchor] [spacekey:pagetitle^attachment.ext]
Creates an internal hyperlink to the specified page in the desired space (or [link alias|#anchor|link tip] the current one if you don't specify [link alias|^attachment.ext|link tip] any space) where the link text is or different from the actual hyperlink [link alias|pagetitle|link tip] link. Also you can have an optional [link alias|pagetitle#anchor|link tip] link tip which will apear as tooltip. [link alias|pagetitle^attachment.ext|link tip] Appending the optional '#' sign or followed by an anchor name will lead [link alias|spacekey:pagetitle|link tip] into a specific bookmarked point of [link alias|spacekey:pagetitle#anchor|link tip] the desired page. Also having the [link alias|spacekey:pagetitle^attachment.ext|link optional '^' followed by the name of tip] an attachment will lead into a link to the attachment of the desired page.
Example: link alias Creates an internal hyperlink to the specified blog post in the desired space (or the current one if you don't specify any space). You must specify the date the post was made in /year/month/day form as shown. Anchors and link text can be added the same way as described above. If you attempt to link to a blog post that doesn't exist, no link will be created. Example: /2004/01/12/Blog Post my link name Creates an internal hyperlink to a view of a whole day's blog. Specify the date you wish to link to as year/month/day. Link titles can be supplied as with other links. It is possible to link to days with no blog posts on them: the destination page will just be empty. Examples: /2004/01/12/Blog Post my link name Creates a link to a piece of content by its internal database ID. This is currently the only way to link to a mail message. Examples: Re: Webwork 2 Upgrade my link name Creates a link to the space homepage, or space summary page of a particular space. Which of these the link points to depends on the configuration of the space being linked to. If the space does not exist, the link will be drawn with a strike-through to indicate it is an invalid space. Examples: spacekey custom link title [nosuchspace:]
[/2004/01/12/Blog Post] [spacekey:/2004/01/12/Blog Post]
[/2004/01/12] [spacekey:/2004/01/12] or [my link name|/2004/01/12] [my link name|spacekey:/2004/01/12]
[$12345] or [my link name|$12345]
[spacekey:] [custom link title|spacekey:]
[~username] [custom link title|~username]
Creates a link to the user profile page of a particular user. By default, will be drawn with a user icon and the user's full name, but if you supply a custom link text, the icon will not be drawn. If the user being linked to does not exist, the link will be drawn with a strikethrough. Examples: User Full Name custom link title [~nosuchuser] Creates a shortcut link to the specified shortcut site. Shortcuts are configured by the site administrator. You can add a link title to shortcuts in the same manner as other links. Examples: http://www.google.com/search?q=con fluence custom link text Creates a link to an external resource, special characters that come after the URL and are not part of it must be separated with a space. External links are denoted with an arrow icon. Note: the [] around external links are optional in the case you do not want to use any alias for the link. Examples: http://confluence.atlassian.com/ Atlassian Creates a link to an email address, complete with mail icon. Example: https://wiki.myatos.net/renderer/notati onhelp.action# This only works on Internet Explorer Creates a link to file on your computer or on a network share that you have mapped to a drive
[phrase@shortcut] [custom link text|phrase@shortcut]
[http://confluence.atlassian.com] [Atlassian|http://atlassian.com]
[mailto:[email protected]]
[file://c:/temp/foo.txt] [file://z:/file/on/network/share.txt]
A macro that allows you to quickly {doc:/display/DOC/Confluence+Documentation+ create links to content at Home}Confluence Documentation{doc} http://confluence.atlassian.com/.
Default parameter The link to the content relative to http://confluence.atlassian.com/. Macro body The link text, interpreted as wiki markup. Generates an 'Add Page' link which, when clicked, can take the user directly to a template and/or set the page parent. template - (optional) the name of the template to use when creating the page. live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false. parent - (optional) the name of the parent page (empty by default). May also have the following markers: @self - (default) the parent will be the page the macro is in. @parent - the parent will be the parent of the page the macro is in. @home - the parent will be home page for the Space the page is in. title - (optional) if you want popup text to appear when the mouse is hovered over the link, enter it here. labels - (optional) the list of labels to apply to the new page. Does not work for non-live templates. allowRename - (optional) if set to true, the user will be allowed to rename the page while it is being created. Generates an 'Add Page' form with a field for the title. template - (optional) the name of the template to use when creating the page. live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false. parent - (optional) the name of the parent page (empty by default). May also have the following markers:
{add-page:template=My Template|parent=Page Parent}Click to add page{add-page}
{add-page-form:template=My Template|parent=Page Parent}Click to add new page{add-page-form}
@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. width - (optional) The width of the title text field. Eg. '250px' or '70%'. Links to a page in the current space. If the page doesn't exist or is untitled, it generates a 'Add Page' link which, when clicked, can take the user directly to a template and/or set the page parent. The title may also contain substitution markers, indicated with '%' surrounding a Supplier key chain value. Eg: {link-page:name=%content:title% %global:current user > user:full name%}your page{link-page} This will link to a page with the name being the parent page's title, followed by " - " followed by the current user's name. [default]/name - (optional) the title of the page. If not supplied, clicking the link will always create a new page. template - (optional) the name of the template to use when creating the page. live - (optional) if set to 'true', the template will be live when the page is created. Defaults to false. parent - (optional) the name of the parent page (empty by default). May also have the following markers: @self - (default) the parent will be the page the macro is in.
{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}
@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. Creates a link to special Confluence locations. All locations are non-casesensitive. Parameters [default] - The location to link to. See the list of locations below. space - (optional) The spacekey to link to. page - (optional) The name of the page/news item/etc to link to. popup - (optional) If 'true', the link will open in a popup window. popupWidth - (optional) The width of the popup window. Defaults to 600px. popupHeight - (optional) The height of the popup window. Defaults to 400px. popupScroll - (optional) If false, no scrollbar is displayed. Defaults to true. target - (optional) The name of the popup window to open. title - (optional) if you want popup text to appear when the mouse is hovered over the link, enter it here. 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.
{link-to:dashboard}Go to Dashboard{link-to} {linkto:news|space=ANOTHERSPACEKEY}Go to another space's news{link-to} {link-to:page source|popup=true}View page source{link-to}
signup - The signup page. notation guide - The notation guide. rss feed builder - The RSS Feed Builder (Confluence 2.x) spaces - The list of spaces the user has access to. (Confluence 1.4) user profile - The currently logged in user's profile. user history - The currently logged in user's history. Space Locations You can specify which space to link to by setting the 'space=key' parameter, or it will default to the current space. add news - Add a news post. browse space - Go to the 'Browse Space' view. mail - The mail page. news - The news page. pages alphabetical - The list of pages in alphabetical order. pages tree - The hierarchical view of pages in the space. pages updated - The recently updated pages list. space attachments - The attachments list for the space. space templates - The space templates list. popular labels - A page listing popular page labels in the space. (Confluence 2.x) all labels - A page listing all labels across the space. (Confluence 2.x) RSS Feeds Again, you can specify the space, or the current one will be used as the default. rss comments - New comments are added to this feed. rss news - News items for the space are added to the feed. rss new pages - Any new pages in the space are added to the feed. rss updated pages - Any updated
pages in the space are added to the feed. Page Locations You can specify the space key as above, and you can specify the page or news item with the 'page=Page Name' parameter. @parent - Links to the page's parent, if it has one. @self - Links to the page the macro is on. add comment - Opens the 'add comment' section of the page. page comments - Jumps to the page comments. page attachments - The attachments tab for the page. page children - Jumps to the page children list. page edit - The edit tab for the page. page history - The page history view. page info - The page info view. page source - The page source view pdf export - Export the page to PDF. word export - Export the page in Microsoft Word format. print - The print view for the page. Links to a page or URL, popping it up into a new window. [default]/href - The name of the page, or the URL. type - Either 'normal' (the default) or 'popup'. If set to popup, many of the settings below will default to those appropriate for a popup window. width - The width of the new window. {link-window:Another Page}Open Another Page height - The height of the new in Another Window{link-window} 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. Creates a bookmark anchor inside the page. You can then create links directly to that anchor. So the link [My Page#here] will link to wherever in "My Page" there is an {anchor:here} macro, and the link [#there] will link to wherever in the current page there is an {anchor:there} macro.
{anchor:anchorname}
Lists Lists allow you to present information as a series of ordered items. Notation Comment * some * bullet ** indented ** bullets * points A bulleted list (must be in first column). Use more (**) for deeper indentations. Example: some bullet indented bullets points A list item (with -), several lines create a single list. Example: different bullet types A numbered list (must be in first column). Use more (##, ###) for deeper indentations. Example: a numbered list You can even go with any kind of mixed nested lists: Example: a numbered
- different - bullet - types
#a # numbered # list #a # numbered #* with #* nested
#* bullet # list *a * bulletted *# with *# nested *# numbered * list
with nested bullet list a bulletted with nested numbered list The Dynamic Tasklist Macro displays a task list which can be modified in the page as it is viewed. Despite the fact that this plugin has an ajax UI, it is still fully versioned like a normal Confluence page. Example:
{dynamictasklist:th ingsToDo}
What you need to type {dynamictaskli st:Arthurs ToDo's}
What you will get
Images Images can be embedded into Confluence pages from attached files or remote sources. Notation Comment !http://www.host.com/image.gif! or !attached-image.gif! !spaceKey:pageTitle^image.gif! !/2007/05/23/My Blog Post^image.gif! Inserts an image into the page. If a fully qualified URL is given the image will be displayed from the remote source, otherwise an attached image file is displayed. Inserts an image that is attached on another page or blog post. If no space key is defined, the current is space is used by default. Insert a thumbnail of the image into the page (only works with images that are attached to the page). Users can click on the thumbnail to see the full-sized image. Thumbnails must be enabled by the site administrator for this to work.
!image.jpg|thumbnail!
!image.gif|align=right, vspace=4!
For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so. Create a gallery of thumbnails of all images attached to a page. This will only work on pagesthat allow attachments, obviously. The title parameter allows you to supply a title for the gallery The columns parameter allows you to specify the number of columns in the gallery (by default, 4) The exclude parameter allows you to specify the name of attached images to ignore (i.e., they will not be included in the gallery). You can specify more than one picture, separated by commas. Example: exclude=my picture.png,my picture2.gif The include parameter allows you to specifically include one or more attached images. The gallery will show only those pictures. You can specify more than one picture, separated by commas. Example: include=my picture.png,my picture2.gif The page parameter allows you specify the title of one or more pages which contains the images you want displayed. If a page is in the same space as the page containing the macro, use the format page=My Page Name. To specify a page in a different space, use page=SPACEKEY:My Page Name, such as page=DOC:Gallery Macro. You can specify more than one page, separated by commas. Example: page=Image Gallery,STAFF:Group Photos If a page or attachment file name contains a comma, you can use it in the include, exclude, or page parameters by enclosing it in single or doublequotes. Example: include="this,that.jpg",theother.png The sort parameter allows you to control the order of the images. The options are name,comment, date, or size. The reverse parameter is used in conjunction with the sort parameter to reverse the order of the specified sort.
{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}
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. {imagemap} Base-Plugin defining the image to use for the ImageMap. name: (mandatory) Specifies the link to the image to be used as an ImageMap. Can be 1) an absolute URL e.g. '[http://www.somedomain.com/somepictur e.jpg]' or 2) a Confluence-like link to an imageattachment [somepage^somepicture.jpg] width: (optional) Specifies the width of the image height: (optional) Specifies the height of the image {map} Nested Plugin for defining clickable {imagemap:name=[SomePage^SomePicture regions and target-links. .jpg]} title: (optional) Tooltip text, that appears if {map:link=[myTarget]| the mouse stays over the clickable region. coords=257,174,363,233| title='Jump to coords: (mandatory) Coordinates of the Target'| shape='rect'} shape: {imagemap} x1,y1,x2,y2 for rect-shapes x,y,r for circle-shapes x1,y1,x2,y2 ... xn,yn for polygon-shapes. link: (mandatory) Target link where to go, after region was clicked. Can be 1) an absolute URL e.g. 'http://www.google.com' or 2) a Confluence-like link [somepage] shape: (optional) The shape of the clickable region. Possible values are 'rect', 'circle' and 'polygon'. Defaults to 'rect' target: (optional) Specifies the target-frame of the link. E.g. target='_blank' opens the link in a new window Tables Tables allow you to organise content in a rows and columns, with a header row if required. Notation Comment
||heading 1||heading 2||heading 3|| |col A1|col A2|col A3| |col B1|col B2|col B3|
Makes a table. Use double bars for a table heading row. Note that each table-row has to be defined on a single line. The code given here produces a table that looks like: heading 1 heading 2 heading 3 col A1 col B1 col A2 col B2 col A3 col B3
{column:width=50%} Text in this column. {column} {section} {column:width=30%} Column one text goes here {column} {column:width=70%} Column two text goes here {column} {section}
Defines a single column. width: - (optional) the width of the column. Must be defined in a section macro.
If you want to use columns instead of tables, you can define them first by marking a {section}, and then placing any number of {column}s inside. border: - (optional) set to "true" to draw a border around the section and columns.
{section:border=true} ... {section} Advanced Formatting More advanced text formatting. Notation {code:title=Bar.java|borderStyle=solid} // Some comments here public String getFoo() { return foo; } {code} {code:xml} <test> <another tag="attribute"/> </test> {code}
Comment Makes a preformatted block of code with syntax highlighting. All the optional parameters of {panel} macro are valid for {code} too. The default language is Java but you can specify JavaScript, ActionScript, XML, HTML and SQL too. Example: Bar.java // Some comments here public String getFoo()
{ return foo; } <test> <another tag="attribute"/> </test> Displays the each of the items from a reporter in a table. A report block must contain two things: 1) A reporter macro (such as {content-reporter} or {user-reporter}), which finds the list of items to report on, and 2) one or more {reportcolumn}s must be present to define what data is displayed. It may also optionally include a {report-empty} macro, which specifies what will be displayed if no items are returned from the reporter. depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents. sortDescendents - (optional) If set to false, the descendents displayed if 'depth' is greater than 1 are not sorted using the report sort criteria. maxResults - (optional) The maximum number of results to display. firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1. width - (optional) The width of the table (e.g. '500px', '100%'). class - (optional) The CSS class to render the table with. injected - (optional) If set to true, the {report-column}
{report-table} {xxx-reporter} {report-column:title=Key 1}{report-info:item:key 1}{report-column} {report-column:title=Key 2}{report-info:item:key 2}{report-column} {report-empty} This is displayed if no results are returned by the reporter. {report-empty} {report-table}
macros will default to injecting %prefix:key% values directly. Displays a single column in a {report-table}. This macro will usually contain at least one use of the {report-item} macro, or another macro which dispays information about the current item being reported on. title - (required) The title to display in the table header. width - (optional) The width of the column. Eg. "50px", "20em". colSpan - (optional) The number of columns this column should span over. rowSpan - (optional) The number of rows this column should span over. newRow - (optional) If set to true, a new row will be started with this column. class - (optional) The CSS class(es) to apply to this column. summaryType - (optional) The type of summary to display at the end of this column. May be one of: sum - The sum total of all numbers in the column. count - The number of nonblank values in the column. average - The average of all numbers in the column. summaryValue - (optional) The key chain value for the column summary, or plain text to display if the 'summaryType' is not set for this column. E.g. "data:My Number", or "content:children > collection:size". *Note:* The summary value key can be completely unrelated to what is
{report-column:title=Column Title}{reportitem:value}{report-column}
displaying in the column, if so desired. summaryFormat - (optional) The number format to use for the summary. E.g. "$#, injected - (optional) If set to true, %prefix:key% values in the body will be injected with report value before being rendered. Displays the each of the items from a reporter as a list item. A report block must contain two things: 1) A reporter macro (such as {content-reporter} or {user-reporter}), which finds the list of items to report on, and 2) A {report-body} macro, which contains the wiki code which will be executed for each item. It may also optionally include a {report-empty} macro, which specifies what will be displayed if no items are returned from the reporter. style - (optional) The style of bullet to display. May be any standard CSS style. Defaults to 'disc' if outlining is off, or 'decimal' if outlining is on. outline - (optional) If set to 'true', the list and any sub-lists of children will be displayed with an outline number format (eg. "1.2.3"). Defaults to 'false'. Note: This setting will only display correctly in FireFox. depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents. sortDescendents - (optional) If set to false, the descendents displayed if 'depth' is greater than 1 are not sorted using the
{reportlist:depth=[1,2...all]|outline=true/false|style=[disc, decimal, etc]} {xxx-reporter} {report-body} This content is repeated for each item. {report-body} {report-empty}This is displayed if no results are returned by the reporter.{report-empty} {report-list}
report sort criteria. trim - (optional) If 'false', the body will not be trimmed. True by default. injected - (optional) If set to true, the {report-body} macros will default to injecting %prefix:key% values directly. maxResults - (optional) The maximum number of results to display. firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1. Displays the each of the items from a reporter in a block of wiki text. A report block must contain two things: 1) A reporter macro (such as {content-reporter} or {user-reporter}), which finds the list of items to report on, and 2) A {report-body} macro, which contains the wiki code which will be executed for each item. It may also optionally include a {report-empty} macro, which specifies what will be displayed if no items are returned from the reporter. separator - (optional) The type of separator to display between each item. Defaults to nothing. May be one of the following: bracket - Square brackets ('[', ']') surrounding each item. brace - Braces ('{', '}') surrounding each item. comma - A comma (',') between each item. paren - Parenthases ('(', ')') surrounding each item. pipe - A pipe ('|') between each item.
{report-block} {xxx-reporter} {report-body} This content is repeated for each item. {report-body} {report-empty}This is displayed if no results are returned by the reporter.{report-empty} {report-block}
newline - A line break after each item. "custom" - Any other character you wish, specified between quotes. maxResults - (optional) The maximum number of results to display. firstResult - (optional) Specify the number of the first result to start displaying in the report. The first item has a number of 1. depth - (optional) If the item has children, the depth do display its descendents. Defaults to 0. May be 'all' for all descendents. sortDescendents - (optional) If set to false, the descendents displayed if 'depth' is greater than 1 are not sorted using the report sort criteria. injected - (optional) If set to true, the {report-body} macros will default to injecting %prefix:key% values directly. This macro contains the wiki code which will be displayed before a non-empty report. It must be contained in another report macro (e.g. {reportblock}). trim - (optional) If 'true', the body will be trimmed. False by default. This macro contains the wiki code which will be executed for each item of the surrounding report. It is used by the {reportblock} and {report-list} macros. It will usually contain one or more uses of the {reportitem} macro to display reported values.
{report-header} This content is displayed at the beginning of a nonempty report. {report-header}
{report-body} This content is repeated for each item of a report. {report-body}
trim - (optional) If 'true', the body will be trimmed. False by default. injected - (optional) If set to true, %prefix:key% values in the body will be injected with report values before being rendered. This macro contains the wiki code which will be displayed after a non-empty report. It must be contained in another report macro (e.g. {reportblock}). trim - (optional) If 'true', the body will be trimmed. False by default. This macro contains the wiki code which will be displayed if the surrounding report has no items. It is used by the {reportblock}, {report-list} and {report-table} macros. trim - (optional) If 'true', the body will have any leading or trailing white space removed before it is displayed. False by default. Displays the specified key value for the current report item. The key is a set of Supplier keys, separated by ">" characters. For example, if the current item is a standard Confluence page, the following will display the page creator's full name: {reportinfo:content:creator > user:full name} It first looks up the creator of the current item, then get the full name for that user. default/key - (required) the key
{report-footer} This content is displayed at the end of a non-empty report. {report-footer}
{report-empty} This content is displayed for reports with no items. {report-empty}
{report-info:item:key|format=[number format/date format]|render=none/wiki|link=true/false}
value to display. format - (optional) The date (eg. 'dd MMM, yyyy') or number (eg. '#, This will only be used if the data is a date or a number, respectively. Otherwise, it will be ignored. link - (optional) If set to 'true' and the current item/key has a URL link, the text generated will be linked to that URL. Defaults to 'false'. render - (optional) If set to 'wiki', the generated text will be rendered as wiki text. Defaults to 'none'. default - (optional) The contents of this parameter will be used if the item/key is empty. It will be rendered as wiki text. Alternately, the body of the macro can also be used, if more complex wiki text is required. separator - (optional) If the item/key points to a list of results, the type of separator to display between each item. Defaults to 'comma'. May be one of the following: bracket - Square brackets ('[', ']') surrounding each item. brace - Braces ('{', '}') surrounding each item. comma - A comma (',') between each item. paren - Parenthases ('(', ')') surrounding each item. pipe - A pipe ('|') between each item. newline - A line break after each item. "custom" - Any other character you wish, specified between quotes. {report-link:item:key|info=Mouse-over Displays the specified key
information|target=_blank}Link text{report-link}
value as a link. It is assumed that the item/key value is an absolute or server-relative link. If not, the 'prefix' and 'postfix' parameters can be used to prepend or append extra values to the URL. default/key - (required) the key value to use as the link URL. info - (optional) The text which will be displayed when the user hovers their mouse over the link. target - (optional) The target frame to open the link in. May be any standard HTML target. prefix - (optional) The text to prepend to the item/key value in the link. postfix - (optional) The item to append to the item/key value in the link. trim - (optional) If set to 'false', the URL will not be trimmed. Defaults to 'true'. Displays the specifed key value for the current item as an image. It is assumed that the key value retrieved is an absolute (eg. "http://server/folder/file.gif") or server-relative (eg. "/folder/file.gif") URL. default/key - (required) the key value to use as the image URL. width - (optional) The width of the image, using standard CSS units (eg. "20px" or "80em"). height - (optional) The height of the image, using standard CSS units (eg. "20px" or "80em"). border - (optional) The border style of the image, using standard CSS values (eg. "red dash 2px").
{report-image:item:key|width=16px|height=16px}
Sets the item context to the item/key value specified. This is useful when you wish to display several key values from a sub-item of the item currently being reported on. For example, you may wish to use the full name and email address of the current page's last modifier: {reporton:content:modifier} Last Modifier: {reportinfo:user:full name|link=true} ({reportinfo:user:email|link=true}) {report-on} default/key - (required) the key value to display. default - (optional) The contents of this parameter will be used if the item/key is empty. It will be rendered as wiki text. Alternately, the body of macro can also be used, if more complex wiki text is required. separator - (optional) If the item/key points to a list of results, the type of separator to display between each item. Defaults to 'comma'. May be one of the following: bracket - Square brackets ('[', ']') surrounding each item. brace - Braces ('{', '}') surrounding each item. comma - A comma (',') between each item. paren - Parentheses ('(', ')') surrounding each item. pipe - A pipe ('|') between each item. newline - A line break after each item. "custom" - Any other character
{report-on:item:key} Sub-Item 1: {report-info:item:subkey 1} Sub-Item 2: {report-info:item:subkey 2} {report-on}
you wish, specified between quotes. injected - (optional) If set to true, %prefix:key% values will be injected with report values before being rendered. Allows a sub-report to be created from within another report. This reporter will display the contents of any subitem of the current item, identified using the "prefix:key" value. default/key - (required) the key {local-reporter:prefix:key} value to display. {xxx-sort:prefix:subkey|order=[ascending, descending]} source - (optional) The location {xxx-filter:prefix:subkey|extra parameters go here} to set as the source context. If {local-reporter} unspecified, the current report item (if in a report) or current page/news item will be the context. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. Reports on Confluence Spaces. It must be used in a report of some type (eg. {report-block}). It will only list spaces visible to the current user. Also, further filtering can be made by specifying the 'spaces' parameter, or using custom filters. space(s) - (optional) The list of spaces to search in. Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded). Defaults to '@self'. May be one of the following: @self - (default) The space the current content is in.
{space-reporter:space=KEY} {xxx-sort:item:key|order=[ascending, descending]} {xxx-filter:item:key|extra parameters go here} {space-reporter}
@personal - Personal spaces only. @global - Global spaces, that is, non-personal spaces. @all - All spaces, both global and personal SPACE KEY - Any other space key may be specified explicitly. labels - List of label checks. Eg. "one, +two, -three" would list content which had the "two" label but not the "three" label. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. Reports on Confluence content (pages, news, comments, attachments, etc). The content can be filtered by space, type, scope or labels, as well as any custom filters specified in the body of the macro. space(s) - (optional) The list of spaces to search in. Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded). Defaults to '@self'. May be one of the following: @self - (default) The space the current content is in. @personal - Personal spaces only. @global - Global spaces, that is, non-personal spaces. @all - All spaces, both global and personal SPACE KEY - Any other space key may be specified explicitly. type(s) - (optional) The list of content types to allow. Defaults to allowing all types. Each type may be prefixed by either a '+'
{content-reporter:space=KEY|types=[page, +news, comment]|scope=Page [> required scope]|labels=[one, +two, -three]} {xxx-sort:item:key|order=[ascending, descending]} {xxx-filter:item:key|extra parameters go here} {content-reporter}
(to indicate it is require) or '-' (to indicate it must be excluded). May be any of the following: page news comment attachment spacedescription 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. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. Reports on Confluence users matching the specified criteria. user(s) - (optional) the (list of) users who can see the content. group(s) - (optional) the (list of) groups who can see the conent. space(s) - (optional) KEY > permission - the (list of) spaces where, if the user can view the space, they can see the content. The permission is optional view is used by default.
{user-reporter:user=[usernames]|group=[group names]|space=SPACEKEY:view/edit/admin/news} {xxx-sort:item:key|order=[ascending, descending]} {xxx-filter:item:key|extra parameters go here} {user-reporter}
Otherwise, you may specify one of the following after the '>'. 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. comment - the user can post a comment. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. Reports on the available user groups in Confluence. This list is only available to administrators and users who can create or administrate spaces. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. This macro will expand upon the selected 'prefix:key' of each of the result items returned by the contained reporter. In database query terms, this is essentially a 'join' operation, and is mostly useful for manyto-many relationships. For example, a user can be a member of many groups, and each group can have many users as members. If you wish to display a list of all groups and their members in a single table, with only one group and one user listed per row, you need to expand on one or the
{user-group-reporter} {xxx-sort:item:key|order=[ascending, descending]} {xxx-filter:item:key|extra parameters go here} {user-group-reporter}
{expanding-reporter:prefix:key|as=something} {xxx-reporter} {xxx-sort:item:key|order=[ascending, descending]} {xxx-filter:item:key|extra parameters go here} {expanding-reporter}
other. You will end up with both being repeated multiple times, but such is the nature of the relationship. Using the {user-group-reporter} it would look something like this: {expanded-reporter:usergroup:members|as=member} {user-group-reporter} {text-sort:usergroup:name} {user-group-reporter} {text-sort:user:name} {expanded-reporter} You would then display your results by doing something like this: {reportcolumn:title=Group Name}{reportinfo:expanded:item > name}{report-column} {reportcolumn:title=Username}{report -info:expanded:member > name}{report-column} {reportcolumn:title=Email}{reportinfo:expanded:member > email|link=true}{reportcolumn} Note the use of 'expanded:item' and 'expanded:member'. 'expanded:item' always referrs to the original item being expanded on, in this case the user group. 'expanded:member' is used because the original {expand-on} macro declared that each of the items in 'usergroup:members' would be known as 'member'. Note also that you can specify sort order inside the {expanded-
reporter} macro. You can also add any filters you wish to, and they will only apply to the items being expanded on. default/key - (required) The key value to expand on. as - (required) The name to set each expanded item as when accessing it in the report. May not be 'item', as this is reserved for the original item being expanded. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. allowEmpty - (optional) Defaults to false. If set to true, the parent item will still be returned even if the specified key value is empty. This macro combines two or more reports into a single set of results for output. The results of the reporter do not have to be of the same type, although sorting and filtering will probably not work as expected if they are not. The reporter can contain filter and sort macros. Filters will be applied on each item from each report as it is retrieved from the sub-report. Sorting will be done on the complete set of results after being filtered and combined. By default, no uniqueness checking is done, but you can specify it with the 'unique' parameter. There will be a performance penalty for turning this option on, however. If the set of results is unsorted, only the first instance of a value will
{combining-reporter} {xxx-reporter} {yyy-reporter} {zzz-reporter} {xxx-sort:item:key|order=[ascending, descending]} {xxx-filter:item:key|extra parameters go here} {combining-reporter}
be returned - duplicates are ignored. unique - (optional) If true, the set of results will only contain a single instance of each item. matchAll - (optional) If set to 'false', content matching any of the criteria will be returned. Otherwise, the content must match all criteria. This filter will ensure that the specified 'prefix:key' value matches the required true/false value. It must be used in a reporter macro. default/key - (required) The key value to filter on. value - (optional) If specified, the value of the key value must match the one specified. required - (optional) If set to 'true', the key value must have a value of some sort, either true or false. This filter will ensure that the specified 'prefix:key' value is a date, and that it matches the required criteria. It must be used in a reporter macro. default/key - (required) The key value to filter on. minValue - (optional) If specified, the date must be greater than or equal to the specified date. This may also be a period from today's date, such as '1y 2m 3w 4d 5h 6m 7s'. To specify a period in the past, prefix with '-'. E.g. '-2y 6m' is 2 years, 6 months in the past. maxValue - (optional) If specified, the date must be less than or equal to the specified date value. This may also be a period from today's date, such
{booleanfilter:prefix:key|value=true/false|required=true/false}
{datefilter:prefix:key|minValue=[date]|maxValue=[date]|for mat=[date format]|required=true/false}
as '1y 2m 3w 4d 5h 6m 7s'. To specify a period in the past, prefix with '-'. format - (optional) If either minValue or maxValue are a specific date, this parameter must also be specified to inform the filter of the date format used in those parameters. It is not required for relative dates. required - (optional) If set to 'true', the key value must have a value of some sort - it may not be empty. This filter will ensure that the specified 'prefix:key' value is a number, and that it matches the required criteria. It must be used in a reporter macro. default/key - (required) The key value to filter on. minValue - (optional) If specified, the number must be greater than or equal to the specified value. {numbermaxValue - (optional) If filter:prefix:key|minValue=[number]|maxValue=[numb specified, the number must be er]|decimal=true/false|required=true/false} less than or equal to the specified value. decimal - (optional) If specified, setting it to 'true' will require that the number is a decimal type, and setting it to false will require it is a whole number. required - (optional) If set to 'true', the key value must have a value of some sort - it may not be empty. This filter will ensure that the specified 'prefix:key' value {textmatches the required true/false filter:prefix:key|minLength=[#]|maxLength=[#]|include value. It must be used in a =[regexp]|exclude=[regexp]|required=true/false} reporter macro. default/key - (required) The key
value to filter on. minLength - (optional) If specified, value must have at least this many characters. maxLength - (optional) If specified, the value must have at most this many characters. include - (optional) If specified, this is a regular expression specifying the pattern required to be included. exclude - (optional) If specified, this is a regular expression specifying the pattern required to be excluded. required - (optional) If set to 'true', the key value must have a value of some sort, either true or false. This filter will ensure that the specified 'prefix:key' value matches the required Confluence content value. It must be used in a reporter macro. default/key - (required) The key value to filter on. space(s) - (optional) The list of spaces to search in. Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded). Defaults to '@self'. May be one of the following: @self - (default) The space the current content is in. @personal - Personal spaces only. @global - Global spaces, that is, non-personal spaces. @all - All spaces, both global and personal SPACE KEY - Any other space key may be specified explicitly. type(s) - (optional) The list of
{content-filter:prefix:key|space=[space keys]|types=[types]|scope=[page scopes]|labels=[labels]}
content types to allow. Defaults to allowing all types. Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded). May be any of the following: page news comment attachment spacedescription 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. matchAll - (optional) If set to 'false', content matching any of the criteria will be let through. This filter will ensure that the specified 'prefix:key' value matches the required Confluence content value. It must be used in a reporter macro. default/key - (required) The key value to filter on. user(s) - (optional) The list of users to match. May be '@self' to indicate the currently-
{user-filter:prefix:key|user=[user list]|group=[group list]|space=[space permission list]}
logged-in user. group(s) - (optional) This list of user groups to match. space(s) - (optional) The list of space keys, followed by an optional permission type, to match against. The form is 'SPACEKEY:permission' (e.g. 'MYSPACE:edit'). The available permissions to check against are: view - (default) The user can view the space. edit - The user can edit the pages in the space. news - The user can add news items to the space. comment - The user can add comments to the space. admin - The user can administer the space. matchAll - (optional) Defaults to 'true'. If set to 'false', content matching any of the criteria will be let through. This filter will check that any contained filter values exist on all/any/none of the items in the collection specified by the filter's "prefix:key" value. Tip: You can use 'collectionfilter-1' to 'collection-filter-5' if you need to nest collection filters. {collectiondefault/key - (required) The key filter:prefix:key|matchItems=all/any/none|matchFilters= value to filter on. all/any/none} {xxx-filter:prefix:key} {yyymatchItems - (optional) Define filter:prefix:key} {collection-filter} how many of the collection's items can match the sub-filers. Defaults to 'all'. May be one of the following: all - (default) All items must match the sub-filter set. any - At least one item must match the sub-filter set. none - None of the items may
match the sub-filter set. matchFilters - (optional) Define how many of the sub-filters must match for the item to be let through. May be one of the following: all - (default) All sub-filters must match the item. any - At least one sub-filter must match the item. none - None of the sub-filters may match item. This filter checks if the current value is different from the previous one passed to the filter. If so, it passes, otherwise it will fail. default/key - (required) The key value to filter on. match - (optional) Either 'first' (the default) to match only the first item or 'repeats' to match only the repetitions, not the original value. This will sort the results by the specified boolean key value. By default, empty values will be listed before false, which will be before true, using ascending order. order - (optional) May be 'ascending' or 'descending'. Defaults to ascending. This will sort the results by the specified date key value. By default, empty values will be listed first, then the rest using ascending order. order - (optional) May be 'ascending' or 'descending'. Defaults to ascending. This will sort the results by the specified number key value. By default, empty values will be listed first, then the rest using
{repeat-filter:prefix:key|match=[first/repeats]}
{boolean-sort:prefix:key|order=ascending/descending}
{date-sort:prefix:key|order=ascending/descending}
{number-sort:prefix:key|order=ascending/descending}
ascending order. order - (optional) May be 'ascending' or 'descending'. Defaults to ascending. This will sort the results by the specified text key value. By default, empty values will be listed first, then the rest using ascending order. mode - (optional) May be one of the following: natural - (default) The text is sorted in natural order, taking into account symbols, numbers and capitalisation. Will recognise the 'local' parameter locale - The text is sorted in local-specific character order. bitwise - The text is sorted according to the bit value of each character. {textorder - (optional) May be sort:prefix:key|mode=natural/locale/bitwise|locale=@us 'ascending' or 'descending'. er/@global/@server/other|order=ascending/descending} Defaults to ascending. locale - (optional) The locale to use when sorting text in either 'natural' or 'locale' mode. Defaults to '@user'. May be one of the following: @user - (default) The current user's selected locale. Uses @global if no specific locale is selected by the user. @global - The global default locale for Confluence. @server - The server's default locale (may be different to @global) xx_yy - A standard local value, such as "en_AU" or "de". This will sort the results by the specified key value. order - (optional) May be 'ascending' or 'descending'. Defaults to ascending.
{natural-sort:prefix:key|order=ascending/descending}
Widget Connector url - (required) The URL to the widget you want to display in Confluence {widget:url=http://au.youtube.com/watch?v=cOE8ukQo {widget:url=http://au.youtube.c z6E} om/watch?v=cOE8ukQoz6E} {widget:url=http://au.youtube.com/watch?v=cOE8ukQo width & height - (optional) z6E | width=500 | height=400} Specify the width and height of your widget {widget:url=http://au.youtube.c om/watch?v=cOE8ukQoz6E | width=500 | height=400} Displays a simple table of all the content (pages, comments, blog posts, user profiles and space descriptions) created by a user (here 'fred'). Displays an index of all the pages in the current space, cross linked and sorted alphabetically. Includes one page within another (this example includes a page called "Home"). Pages from another space can be included by prefacing the page title with a space key and a colon. The user viewing the page must have permission to view the page being included, or it will not be displayed. Imports and executes the specified template to the current page. This is different to creating a page using a template because it will always display the latest version of the template, rather than copying the original version. [default]/name - (required) The template to import and display. Displays stored field data. Numbers and dates may be
{content-by-user:fred}
{index}
{include:Home} {include:FOO:Home} {include:spaceKey=FOO|pageTitle=Home}
{live-template:Template Name}
{get-data:Text Field}Default value{get-data} {get-data:name=Number Field|format=$#,{get-data:A
Group.Date Field|format=d MMM, yyyy|default=Never}
formatted nicely. [default]/name - (required) The name of the field. May be a 'field path' (e.g. 'Group Name.Field Name') default - (optional) The default value to display (rendered as wiki directly) if the field is not set. Alternately, the default can be set as the body of this macro. format - (optional) The number format (e.g. '#, to use when parsing the value being set. The parameter will be ignored for data types other than 'number' or 'date'. render - (optional) Defaults to 'wiki'. May be set to 'none' to display any content unrendered. separator - (optional) If the item/key points to a list of results, the type of separator to display between each item. Defaults to 'comma'. May be one of the following: bracket - Square brackets ('[', ']') surrounding each item. brace - Braces ('{', '}') surrounding each item. comma - A comma (',') between each item. paren - Parenthases ('(', ')') surrounding each item. pipe - A pipe ('|') between each item. newline - A line break after each item. "custom" - Any other character you wish, specified between quotes. Allows entering of text in a single- or multiple-line text field. Must be contained inside a scaffold macro. [default]/name - (required) The
{set-data:Text Field}Default value{set-data} {set-data:Number Field|type=number}123.45{set-data} {set-data:Date Field|type=date|format=d MMM, yyyy}1 Jan, 2007{set-data} {set-data:Page Field|type=content|value=My Page
Title} {set-data:User Field|type=user|value=administrator}
name of the field. value - (required) The value to set. You can alternatively use the body of the macro, which is useful if setting more complex wiki markup. type - (optional) The type of field to display. May be one of the following: text - (default) Text data. number - An integer or decimal value. date - A date. boolean - A true/false value. content - A link to a single Confluence page/news item. E.g. 'SPACEKEY:My Page' or just 'My Other Page'. attachment - A link to a page/news item attachment. E.g. '^mypicture.jpg'. user - A link to a registered user. This is their username, not their full name. E.g. 'joebloe' or 'administrator'. format - (optional) The number format (e.g. '#, to use when parsing the value being set. The parameter will be ignored for data types other than 'number' or 'date'. This is basically required when the data type is 'date', since the default date format is unlikely to be used when setting a date. hidden - (optional) When set to 'true', the value being set will not be displayed to the page viewer. Groups the contained data together under the specified name. [default]/name - (required) The name of the scaffold. Allows entering of text in a
{group-data:name=My Group}scaffold data{groupdata} {text-data:Text Field}Default value{text-data}
single- or multiple-line text field. Must be contained inside a scaffold macro. [default]/name - (required) The name of the field. type - (optional) The type of field to display. May be one of the following: line - (default) A single-line text field. password - A single-line password field. area - A multi-line text area field. content - (optional) The type of content in the field. May be one of the following: wiki - (default) The content is wiki markup. text - The content is plain text. noformat - The content will appear inside a {noformat} section. quote - The content will be quoted. code:language - The content will be rendered as code, with an optional programming language such as Java or XML. E.g. 'content=code:JavaScript'. minLength - (optional) The minimum number of characters that may be entered. maxLength - (optional) The maximum number of characters that may be entered. pattern - (optional) The regular expression the text must match. patternInfo - (optional) If the pattern is specified, this is displayed if the saved value does not match it. required - (optional) If 'true', the field cannot be empty. {excerpt-data:Excerpt Field}{excerpt-data} Allows editing of page's excerpt text via a text field. All
the options for {text-data} will work here. Must be contained inside a scaffold macro. Allows entering of a whole number value (eg 1, 4000). Must be contained inside a scaffold macro. [default]/name - (required) The name of the field. type - (optional) The type of field to display. May be one of the following: line - (default) A single-line number field. select - A single-selection dropdown list box. Note: this type requires that there is a maximum range of 1000 between the min-value and max-value. decimal - (optional) If 'true', the field will allow decimal values to be entered. Warning: Decimals are by their nature imprecise, and may result in some arithmatic errors at times. Only use them if necessary, and don't expect min-value and max-value to always be precise as boundaries. minValue - (optional) The minimum value the number may be (inclusive). maxValue - (optional) The maximum value the number may be (inclusive). step - (optional) The amount each option should step when in 'select' mode. Eg. a step of 2 will produce options 1, 3, 5, etc. Defaults to 1. format - (optional) The format the number should be output in when not being edited. See java.text.DecimalFormat for details.
{number-data:Number Field}0{number-data}
required - (optional) If 'true', the field cannot be empty. Evaluates mathematical equations, optionally using values from other field data in the same scaffold. Other fields can be referenced by putting them inside '${}' markers. The examples to the left add and divide the current values of the 'Foo' and 'Bar' fields, respectively. Must be contained inside a scaffold macro. Parameters [default]/name - (required) The name of the field. format - (optional) The format the number should be output in when not being edited. See java.text.DecimalFormat for details. Functions round([number], [places]) Rounds the number to the specified number of decimal places. Eg: round(1.4634, 2) rounds to 1.46. sumtable([table], [column]) Sums the values of the specified column in the specified table. Eg: sumtable("My Table", "Number Column"). avgtable([table], [column]) Averages the values of the specified column in the specified table. Eg: avgtable("My Table", "Number Column"). Allows editing of date field. Must be contained inside a scaffold macro. [default]/name - (required) The name of the field. format - (required) The format
{eval-data:Evaluated Field} ${Foo} + ${Bar} {evaldata} {eval-data:Evaluated Field} round(${Foo} / ${Bar}, 2) {eval-data}
{date-data:List Field|format=dd-MMMM-yyyy}
of the date content. May contain any of the following special characters: y - The year (eg. 'yy' = '05', 'yyyy' = 2005). M - The month (eg. 'MMMM' = 'April', 'MMM' = 'Apr', 'MM' = '04'). d - The day (eg. 'dd' = '09', 'd' = '9'). H - The hour - 24 hour time (eg. 'HH' = '13'). h - The hour - 12 hour time (eg. 'hh' = '01'). m - The minute (eg. 'mm' = '23'). s - The second (eg. 'ss' = '14'). a - AM/PM (eg. 'a' = 'PM'). minYear - (optional) The minimum year that is allowed. May be absolute (eg. '1980') or relative to the current year (eg. '-5'). Defaults to '-10'. maxYear - (optional) The maximum year that is allowed. May be absolute (eg. '2020') or relative to the current year (eg. '+15'). Defaults to '+10'. required - (optional) If 'true', the field cannot be empty. Defines a repeating section. The contents of the macro will be repeated 0-n times, depending how many have been added in edit mode. Must be contained inside a scaffold macro. [default]/name - (required) The name of the field. order - (optional) If set to 'desc', the rows will list from bottom to top. initialRows - (optional) The number of times the section should be repeated initially.
{repeating-data:Repeating Data|order=desc|initialRows=5} Something: {text-data:Something}{text-data} Something Else: {number-data:Something Else}{number-data} {repeating-data}
{table-data:Editable Table} || Name || Value || Expires || | {text-data:Name} | {number-data:Value} | {data-data:Expires|format=ddMMM-yyyy} | {table-data}
Defines an editable table. Should contain a single header row ('||') and a single data row ('|'). The header row will be displayed once at the start of the table. The data row will be repeated for each row in the table. Make sure there are spaces around the '|' characters marking table cell boundaries. Must be contained inside a scaffold macro. [default]/name - (required) The name of the field. order - (optional) If set to 'desc', the rows will list from bottom to top. initialRows - (optional) The number of times the section should be repeated initially. Allows selecting one or more options. Must be contained inside a scaffold macro. [default]/name - (required) The name of the field. type - (optional) The type of field to display. May be one of the following: select - (default) A selectable list is displayed. check - A list of checkable items are displayed. maxResults - (optional) The maximum number of items which will be in the list. required - (optional) If 'true', a non-empty item must be selected. Defaults to 'false'. blank - (optional) If 'true', a blank item is added to the list. Only applies to select lists. blankText - (optional) The text to put in the blank option, if it is enabled. multiple - (optional) If 'true', multiple options may be
{list-data:List Field} {list-option:Label}Value{list-option} {list-data}
selected. width - (optional) The width of the field. Any CSS width is allowed. Note: Only applies when type is 'select'. height - (optional) The height of the field. Any CSS height is allowed. Note: Only applies when type is 'select'. separator - (optional) If multiple items are selected, the type of separator to display between each item. Defaults to one item per line. May be one of the following: bracket - Square brackets ('[', ']') surrounding each item. brace - Braces ('{', '}') surrounding each item. comma - A comma (',') between each item. paren - Parentheses ('(', ')') surrounding each item. pipe - A pipe ('|') between each item. newline - A line break after each item. "custom" - Any other character you wish, specified between quotes. Defines a simple option for a list. Must be contained inside a list-data macro. [default] - (required) The nonwiki label for the option. Creates a set of list options linking to content matching the filter options. Must be contained inside a list-data macro. parent - (optional) Only immediate children of the specified page will be listed. ancestor - (optional) Any decendent of the specified page
{list-option:Label}*Wiki Text*{list-option}
{content-options:parent=A Page}
will be listed. spaces - (optional) Only lists pages from the specified list of spaces. branches - (optional) Specifies the type of pages that will be listed. May be one of: all - All page types are returned. parents - Only pages with children are listed. children - Only pages with no children are listed. labels - (optional) Only list pages which contain (or do not contain) certain labels Creates a set of list options linking to the attachments on the specified content the filter options. Must be contained inside a list-data macro. content - (optional) If specified, the page or other content the files are attached to. Defaults to the current page. include - (optional) A regular expression specifying which file names to include. E.g. ".*gif" for all GIF files. exclude - (optional) A regular expression specifying which file names to exclude. E.g. ".*zip" for all ZIP files. Creates a set of list options linking to users matching the filter options. Must be contained inside a list-data macro. groups - (optional) Only users in the specified groups will be listed. spaces - (optional) Only users with the required access to the specified spaces will be listed. Permissions can be specified
{attachment-options:content=A Page}
{user-options:groups=a-user-group}
for each space. Eg: SPACEKEY:view - (default) Only users with view access to the SPACEKEY will be listed. SPACEKEY:edit - Only users with edit access to the space will be listed. SPACEKEY:admin - Only users with administration access to the space will be listed. SPACEKEY:blog - Only users who can post a blog (aka News) message will be listed. users - (optional) Only users specified will be listed. match - (optional) If set to 'all', the user must match all settings specified. Defaults to 'any'. Creates a list of labels to attach to the current page. Must be contained inside a list-data macro. (default)/names - The list of labels which are available to select. Hides its contents when viewing a page, but reveils it when editing. Must be contained inside a scaffold macro. whenEmpty - (optional) If present, the field value specified will be checked, and the contents of this hidden-data macro will be hidden if the field is empty. whenNotEmpty - (optional) If present, the field value specified will be checked, and the contents of this hidden-data macro will be hidden if the field is not empty. whenHasRows - (optional) If present, the table/repeation
{label-options:label1, label2, label3}
{hidden-data} Only visible when editing: {number-data:My Number}{number-data} {hidden-data} {hidden-data:whenEmpty=My Number} Only visible when a number is set: {number-data:My Number}{number-data} {hidden-data}
section specified will be checked, and the contents of this hidden-data macro will be hidden if it has any rows. whenNoRows - (optional) If present, the table/repeation section specified will be checked, and the contents of this hidden-data macro will be hidden if it has no rows. Creates a set of list options linking to the attachments on the specified content the filter options. Must be contained inside a list-data macro. [default]/name - The name of the field. include - (optional) A regular expression specifying which file names to include. E.g. ".*gif" for all GIF files. exclude - (optional) A regular expression specifying which file names to exclude. E.g. ".*zip" for all ZIP files. Prints a simple note to the user. title: - (optional) the title of the note. icon: - (optional) if "false", dont display the icon. Be Careful The body of the note here.. Prints a warning note to the user. title: - (optional) the title of the warning. icon: - (optional) if "false", dont display the icon. Warning Insert warning message here!
{attachment-data:Field Name|include=.*jpg,.*gif}
{note:title=Be Careful} The body of the note here.. {note}
{warning:title=Warning} Insert warning message here! {warning}
{info:title=Be Careful} This macro is useful for including helpful information in your confluence pages {info}
Prints an informational note. title: - (optional) the title of the information box. icon: - (optional) if "false", dont display the icon. Useful Information This macro is useful for including helpful information in your confluence pages Prints a helpful tip for the user. title: - (optional) the title of the tip. icon: - (optional) if "false", dont display the icon. Handy Hint Join the Confluence Mailing-List! Makes a preformatted block of text with no syntax highlighting. All the optional parameters of {panel} macro are valid for {noformat} too. nopanel: If the value of "nopanel" is true, then the excerpt will be drawn without its surrounding panel. Example: preformatted piece of text so *no* further _formatting_ is done here Embraces a block of text within a fully customizable panel. The optional parameters you can define are the following ones: title: Title of the panel borderStyle: The style of the border this panel uses (solid, dashed and other valid CSS border styles) borderColor: The color of the border this panel uses
{tip:title=Handy Hint} Join the Confluence Mailing-List! {tip}
{noformat} preformatted piece of text so *no* further _formatting_ is done here {noformat}
{panel}Some text{panel} {panel:title=My Title}Some text with a title{panel} {panel:title=My Title| borderStyle=dashed| borderColor=#ccc| titleBGColor=#F7D6C1| bgColor=#FFFFCE} a block of text surrounded with a *panel* yet _another_ line {panel}
borderWidth: The width of the border this panel uses bgColor: The background color of this panel titleBGColor: The background color of the title section of this panel Example: My Title a block of text surrounded with a panel yet another line Confluence Content Ways to include, summarise or refer to other Confluence content. Notation Comment Embeds an object in a page, taking in a comma-separated of properties. Default supported formats: Flash (.swf) Quicktime movies (.mov) Windows Media (.wma, .wmv) Real Media (.rm, .ram) MP3 files (.mp3) !quicktime.mov! !spaceKey:pageTitle^attachment.mov! !quicktime.mov|width=300,height=400! !media.wmv|id=media! Other types of files can be used, but may require the specification of the "classid", "codebase" and "pluginspage" properties in order to be recognised by web browsers. Common properties are: width - the width of the media file height - the height of the media file id - the ID assigned to the embedded object Due to security issues, files located on remote servers are not permitted Styling By default, each embedded object is wrapped in a "div" tag. If you
wish to style the div and its contents, override the "embeddedObject" CSS class. Specifying an ID as a property also allows you to style different embedded objects differently. CSS class names in the format "embeddedObject-ID" are used. Prints a list of attachments patterns: - (optional) a comma separated list of regular expressions. Only file names matching one of these are displayed. old: - (optional) if "true", display old versions of attachments as well. upload: - (optional) if "true", allow the upload of new attachments. Displays a list of bookmarks using the criteria supplied. Searching Options spaces comma separated list of spaces to search for. Meta space names @all, @personal, @global can also be used. (If no labels and spaces are supplied will default to current space.) labels list of labels that are applied to the bookmarks. (If multiple labels are specified bookmarks only have to match one label to be included.) creators comma separated list of users that have created bookmarks. Sorting Options sort comma separated list of attributes to sort the bookmarks by. Valid values are: creation Bookmark Created Date creator Bookmark Creator Name title Bookmark title Default is by created date.
{attachments:patterns=.*doc|old=true}
{bookmarks}
reverseSort Reverse the order of the bookmarks. Default is false. Display Options All options default to true. showAuthor The user that created the bookmark. showDate The relative date the bookmark was created. showDescription The bookmark description. showEditLinks If the current user has permission, show quick links to edit or remove the bookmark. showLabels The labels for the bookmark. showListHeader The bookmark list header (with the rss feed link). max The maximum number of bookmarks to display. Defaults to 15. showSpace The space the bookmark is saved in showViewLink A link to the actual bookmark page Provides page hierachal tree within a space. If no parameters are specified the root of the tree will be the home page, a different root page can be specified by providing the page to the root parameter. root: - (optional) page where the {pagetree} tree would be rooted from. Meta {pagetree:root=PageName} root names @self, @parent, {pagetree:root=PageName|sort=natural|excerpt=true|r @home can also be used. everse=false} sort: - (optional) sorts the tree {pagetree:root=@home|startDepth=3} node. It my be one of the {pagetree:searchBox=true} following: bitwise, creation, {pagetree:expandCollapseAll=true} modified, natural, position. Default sorting is position excerpt: - (optional) true/false flag that indicate if a page excerpt would be included in the tree display (default is false). reverse: - (optional) true/false flag that allows you to reverse the
order of the display (default is false). searchBox: - (optional) true/false flag that allows you to add a search box in the tree that would search from the root page (default is false). expandCollapseAll: - (optional) true/false flag that allows you to add an expand all and a collapse all row (default is false). startDepth: - (optional) a number that indicates the initial depth that the tree would display (default value is 1). Provides a search box to search a page hierachal tree within a space. If no parameters are specified the root of the tree will be the current page, a different root page can be specified by providing the page to the rootPage parameter. Creates a Table of Contents for headings on the the current page. type - (optional) The type of output. May be one of the following: list - (default) The headings are output in hierarchical list format. flat - The headings are listed on a single line with a separator between them. class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output. style - (optional) The style of the list items if in list mode. The style may be any of the following: none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them. any CSS style - Headings are
{pagetreesearch} {pagetreesearch:rootPage=PageName} {pagetreesearch:rootPage=Space:PageName}
{toc:style=disc|indent=20px} {toc:outline=true|indent=0px|minLevel=2} {toc:type=flat|separator=pipe|maxLevel=3}
output in indented lists with the specified CSS style. outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings. ident - (optional) The amount to indent each list sub-heading by (default is '10px'). separator - (optional) The type of separator to use if the style is flat. May be one of the following: bracket - Square brackets ('[', ']') surrounding each item. (default) brace - Square brackets ('[', ']') surrounding each item. (default) comma - A comma (',') between each item. paren - Parentheses ('(', ')') surrounding each item. pipe - A pipe ('|') between each item. newline - A line break after each item. "custom" - Any other character you wish, specified between quotes. minLevel - (optional) The lowest heading level to include (inclusive). (default is 1). maxLevel - (optional) The highest heading level to include (inclusive). (default is 7). include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'. exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator
in macros, use ',' where you would have usually used '|'. printable - (optional) If set to 'false', the table of contents will not be visible when being printed. Creates a Table of Contents for headings contained in the macro body. location - (optional) The location to have the table of contents output. May be 'top' or 'bottom'. If not set, it will be output at both locations. type - (optional) The type of output. May be one of the following: list - (default) The headings are output in hierarchical list format. flat - The headings are listed on a single line with a separator between them. class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output. style - (optional) The style of the list items if in list mode. The style may be any of the following: none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them. any CSS style - Headings are output in indented lists with the specified CSS style. outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings. ident - (optional) The amount to indent each list sub-heading by (default is '10px').
{toc-zone:separator\=brackets|location=top} h1. First Heading blah blah blah... {toc-zone}
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. {livesearch:id=1|spaceKey=KEY} Show search results keystroke by keystroke. spaceKey: - (optional) this option searches within a single space.
{contributorsCreates a table of contributor summary:order=edits|limit=3|showAnonymous=true} information from the current page
{contributorssummary:columns=edits|order=editTime}
or a group of pages. Table Options groupby - (optional) Specify if the table should be grouped by contributors or pages. Default value is contributors columns - (optional) Specify the columns that should appear in the table as a comma separated list. Default value is edits,comments,labels. Valid values: edits Edit Count Column edited List of pages or contributors comments Comment Count Column commented List of pages or contributors labels Label Count Column labeled List of pages or contributors labellist List of labels watches Watch Count Column watching List of pages or contributors lastupdate Last time a page was updated or a contributor changed some content. order - (optional) The order the contributors or pages will appear in. By default the table is ordered by the number of edits. edits Orders the list with the highest number of edits first in the list name Orders the list by name alphabetically editTime Orders the list by the time they last edit time update Order by the last update time of any content reverse - (optional) If true the sort order will be reversed. limit - (optional) Limit the number of contributors displayed to this
amount showAnonymous - (optional) Show updates by anonymous users. Default is false. showZeroCounts - (optional) If all the selected columns are zero, or empty should the contributor or page be displayed in the table. Default is false. Page Searching Options The following parameters control what pages are used to build the contributors list. page The page to count statistics from. If no spaces or labels are specified this will default to the current page. labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.) spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The following shortcut space names can also be used: @all All Spaces @global All Global Spaces @personal All Personal Spaces contentType Valid options are: pages blogposts If not specified blog posts and pages are included. publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.)
children include statistics from the immediate children of the page descendants include statistics from all descendants of the page Creates a list of contributors who have contributed to a page or a list of pages. Display Options include - (optional) What type of content from the pages to base the contributor list (and the counts) on. Multiple values can be specified with a comma separated list authors Include page authors (default). comments Include page comments labels Include page labels watches Include page watches order - (optional) The order the contributors will appear in. count Order by the total count (default) {contributors:order=edits} name Order by the names of the {contributors:include=authors,labels|mode=list|show contributors Count=true} update Order by the last update {contributors:order=editTime|limit=6} time Both the count and update orderings will use values from only the content specified with the include parameter. reverse - (optional) If true the sort order will be reversed. limit - (optional) Limit the number of contributors initially displayed to this amount mode - (optional) Sets the display mode of the macro inline The contributors will be displayed across the screen (default) list The contributors will be displayed in a list down the screen showAnonymous - (optional) Show edits by anonymous users. Default is false. showCount - (optional) Show the
count for each user. Default is false. showLastTime - (optional) Show the last time a contribution was made by each user for any content specified by the include parameter. Default is false. Page Searching Options The following parameters control what pages are used to build the contributors list. page The page to count statistics from. If no spaces or labels are specified this will default to the current page. labels The label to use to search for pages. Multiple labels can be specified in a comma separated list. (A page will match if it has any of the labels.) spaces Specify the space for the page or labels parameter. Multiple spaces can be specified in a comma separated list. If no pages or labels are specified all pages from the space will be included. The followingshortcut space names can also be used: @all All Spaces @global All Global Spaces @personal All Personal Spaces contentType Valid options are: pages blogposts If not specified blog posts and pages are included. publishDate specify the publish date for a blog post. The date format expected is: YYYY/mm/dd scope For each of the pages found this parameter lets you include the children or decendants. (Each page will only be counted once if it is already in the list.) children include statistics from the immediate children of the page
descendants include statistics from all descendants of the page Advanced Options showPages - show a list of pages returned above the list. Useful for debugging. noneFoundMessage - override the default message that is displayed when no contributors are found. Embeds the content of a file attachment into a Confluence page. Supported formats: Microsoft Word Documents Embedded as html Microsoft Excel Spreadsheets Embedded as html Microsoft Powerpoint Presentations - Embedded in a flash slideshow control or as a single image for individual pages Adobe PDF files - Embedded in a flash slideshow control or as a single image for individual pages {viewfile:presentation.ppt} space: - (optional)the space key for the attachment. The default is {viewfile:space=dog|page=testpage|name=worddocu the space of the page calling the ment.doc} macro. page: - (optional)the page or blog {viewfile:spreadsheet.xls|grid=false|sheet=Sheet post that contains the attachment. 1|row=4|col=5} The default is the page calling the macro. {viewfile:slideshow.pdf|width=200|height=150} 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. 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 {viewfile:presentation.ppt} Microsoft Powerpoint Presentations - Embedded in a {viewfile:space=dog|page=testpage|name=worddocu flash slideshow control or as a ment.doc} single image for individual pages Adobe PDF files - Embedded in a {viewfile:spreadsheet.xls|grid=false|sheet=Sheet flash slideshow control or as a 1|row=4|col=5} single image for individual pages space: - (optional)the space key {viewfile:slideshow.pdf|width=200|height=150} 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. {tracking-info:value=view count}0{tracking-info} {tracking-info:^attachment.ext|value=first view date|format=dd-MMM-yyyy}Anonymous{trackinginfo} {tracking-info:SPACE:Page|value=view count|type=gif|images=customgif}Unviewed{trackin g-info} Outputs information about the specified content. [default] - (optional) The content to report the view count for. Any standard Confluence link syntax is valid, although external links will not produce useful information.
{trackinginfo:SPACE:Page^attachment.ext|value=last view date}Never modified{tracking-info}
value - (required) The value to output. One of the following: first view date - The date the content was first viewed by someone other than the creator. last view date - The date the content was last viewed by someone other than the last editor. view count - The number of times the content has been viewed since the firstViewed date. For values returning a number, the following parameters may also be set: digits - (optional) The minimum number of digits to output. Defaults to 1. type - (optional) The type of image to use for the counter (e.g. "gif", "jpg", etc). If not set, plain text will be output. images - (optional) The style of image to use if type is not text. Defaults to the built-in 'odometer' style. For values returning a date, the following parameters may also be set: format - (optional) The date format (e.g. 'dd-MMM-yyyy'). May also be 'long', 'medium' or 'short', which will use the system defaults for those formats. Outputs a table containing data about the matching content. Defaults to displaying the title, view count, first view date and last view date. Display Options sort - (required) The sort order. May be one or more of the options listed below followed optionally by 'asc' or 'desc', separated by commas. The default is "view count desc, natural title". natural title - The natural content
{tracking-table:scope=Page > descendents|labels=tracked|type=page, attachment} {tracking-table}
title. Eg. "Page 2" comes before "Page 10". exact title - The exact content title. Eg. "Page 2" comes after "Page 10". 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. creation date - The date the content was created. modification date - The date the content was last modified. first view date - The date the content was first viewed by someone other than the creator. last view date - The date the content was last viewed by someone other than the last editor. view count - The number of times the content has been viewed since the firstViewed date. maxResults - Outputs up to this number of results. Default is unlimited. For values returning a number, the following parameters may also be set: digits - (optional) The minimum number of digits to output. Defaults to 1. type - (optional) The type of image to use for the counter (e.g. "gif", "jpg", etc). If not set, plain text will be output. images - (optional) The style of image to use if type is not text. Defaults to the built-in 'odometer' style. For values returning a date, the following parameters may also be set: format - (optional) The date format (e.g. 'dd-MMM-yyyy'). May also be 'long', 'medium' or
'short', which will use the system defaults for those formats. 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 commaseparated. 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. Defaults to 'page, news, attachment'. Valid types include: space - Spaces page - Wiki pages news - Blog/News posts comment - Page or blog comments userinfo - User profile attachment - An attachment Defines a column to display in a {tracking-table}. value - (required) The value to output. One of the following: id - The content's unique id. title - The content title. space key - The content's space key. space name - The content's space name. creation date - The date the content was created. modification date - The date the content was last modified. first view date - The date the content was first viewed by someone other than the creator. last view date - The date the content was last viewed by someone other than the last editor. view count - The number of times the content has been viewed since the firstViewed date. For values returning a number, the following parameters may also be set: digits - (optional) The minimum number of digits to output. Defaults to 1.
{tracking-table} {tracking-column:value=title} {tracking-column:value=creation date|format=ddMMM-yyyy} {tracking-column:value=view count} {tracking-column:value=modification date} {tracking-table}
type - (optional) The type of image to use for the counter (e.g. "gif", "jpg", etc). If not set, plain text will be output. images - (optional) The style of image to use if type is not text. Defaults to the built-in 'odometer' style. For values returning a date, the following parameters may also be set: format - (optional) The date format (e.g. 'dd-MMM-yyyy'). May also be 'long', 'medium' or 'short', which will use the system defaults for those formats. Displays the children and descendants of the current page. Specify 'all=true' to show all descendants of this page, or depth=x (where x is any number > 0) to show that many levels of descendants. The 'style' attribute can be any of 'h1' through 'h6'. If you specify a style, the top level of child pages will be displayed as headings of that level, with their children then displayed as lists below. A great way to throw together a quick contents page! You can view the children of a different page in the same space with {children:page=Another Page Title}. If you specify a page of '/', you will list all the pages in the space with no parent (i.e. the top-level pages), excluding the current page If you specify a page of 'FOO:' (the colon is required), you will list all the pages with no parent in the space with key "FOO". Specify 'excerpt=true' to also display the first line of the pages excerpt (see the excerpt macro) if
{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>}
it exists. Example: child another child child first grandchild another child The 'sort' attribute is an optional attribute that allows you to configure how the children are sorted. Specify 'creation' to sort by content creation date, 'title' to sort alphabetically on title and 'modified' to sort of last modification date. Use the reverse attribute to optionally reverse the sorting. The 'first' attribute allows you to restrict the number of children displayed at the top level. Does an inline site search. query: your query maxLimit=x: (where x is any number > 0) to limit the search result to a number of results. spacekey: specify the key of the space you want to search in type: specify the content type (could be page, comment, blogpost, attachment, userinfo, spacedesc) lastModified: specify a time period in which the content was last modified: (e.g. 3d = modified in the last 3 days, 1m3d = modified in the last month and three days) contributor: specify the username of the contributor of the content to be retrieved Example: Found 2 result(s) for home Home (My Space) This is the home page for My Space.
{search:query=my_query} {search:query=my_query|maxLimit=x}
file-containing-home.pdf ( download) Displays the most recent blog posts in this space. content - lets you choose whether to display each blog post in its entirety (the default), just short excerpts from each item (see the excerpt macro), or just a list of post titles. time - lets you choose how far back to look for blog posts. For example, "time=12h" would show you those items made in the last twelve hours, and "time=7d" would show items made in the last {blog-posts:max=5} week. (The default is no limit) label/labels - (optional) search for {blog-posts:max=5|content=excerpts} content with these labels; prefix a label with '+' to require a match or {blog-posts:max=5|content=titles} '-' to exclude any content with that label. By default, at least one of {blog-posts:time=7d|spaces=@all} the labels will be present on any matched content. Separate labels {blog-posts:max=15|time=14d|content=excerpts} with commas or single-spaces. spaces - (optional) spaces to {blog-posts:labels=confluence,atlassian} search. Accepted values: {blog-posts:labels=+atlassian,+confluence,+content} 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 singlespaces. 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. {excerpt}Confluence is a knowledge-sharing application that enables teams to communicate more effectively{excerpt} {excerpt:hidden=true}This excerpt will be recorded, but will not be displayed on the page.{excerpt} Marks some part of the page as the page's 'excerpt'. This doesn't change the display of the page at all, but other macros (for example children, excerpt-include and blog-posts) can use this excerpt to summarise the page's content. hidden: If the value of "hidden" is true, then the contents of the
excerpt macro will not appear on the page. Includes the excerpt from one page (see the excerpt macro) {excerpt-include:Home} within another. The included page must be in the same space as the {excerpt-include:Home|nopanel=true} page on which the macro is used. nopanel: If the value of "nopanel" {excerpt-include:blogPost=/2006/12/28/News Page} is true, then the excerpt will be drawn without its surrounding panel. Renders a list (or heatmap) of the most popular labels ordered by popularity (or name). count - (optional) Specify the number of labels to be displayed. If not specified, a default of 100 is used. spaceKey - (optional) Restrict the popular labels to a certain space. style - (optional) Allows 'heatmap'. Specifying a heatmap style will use different font sizes depending on their rank of popularity, ordered by label names. If not specified, a default list style is used ordered by popularity (highest first).
{popular-labels} {popular-labels:style=heatmap|count=15}
Displays a list of content marked with the specified labels. type - (optional) search for types of content. {contentbylabel:labels=dogs,cats} Accepted values: {contentbylabel:labels=dogs,cats|space=PETS} page: basic pages {contentbylabel:labels=dogs,cats|type=page,blogpost comment: comments on pages or } blogs {contentbylabel:labels=dogs,cats|showLabels=false|s blogpost/news: blog posts howSpace=false} attachment: attachments to pages {contentbylabel:labels=dogs,cats|excerpt=true} or blogs {contentbylabel:labels=+dogs,+cats} userinfo: personal information {contentbylabel:labels=+lebowski,+bowling,spacedesc: space descriptions walter|space=@all|type=page,-blogpost} 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 singlespaces. 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. {related-labels} {related-labels:labels=labelone, labeltwo} Renders a list of labels related to the current page's labels. labels - (optional) commaseparated list of labels whose related labels will be displayed.
Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100% {recently-updated} space/spaces - (optional) spaces to {recently-updated: spaces=sales,marketing | search. labels=timesheets,summaries} Accepted values: {recently-updated: labels=+confluence,-jira | space keys (case-sensitive) spaces=@all} @self: current space {recently-updated: @personal: personal spaces spaces=NOVELS,SHORTSTORIES | sort=creation | @global: global spaces reverse=true} @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 singlespaces. Defaults to the current space (@self). label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces. width - (optional) width of table on Confluence page, defaults to 100%. type/types - (optional) search for types of content. Accepted values: page: basic pages comment: comments on pages or blogs blogpost/news: blog posts attachment: attachments to pages or blogs userinfo: personal information spacedesc: space descriptions personalspacedesc: personal space descriptions Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces. Defaults to all types. In shared mode, the personal information type is excluded from the defaults. Renders a list (or table) of labels most recently used in a specified scope. count - (optional) Specify the number of labels to be displayed. If not specified, a default of 10 is used. scope - (optional) Allows 'global',
{recently-used-labels} {recently-used-labels:scope=space|count=15}
'space' and 'personal'. If not specified, the 'global' scope is used. The global scope will show labels that were recently used within this confluence instance. The space scope will show labels that were recently used in the current space. The personal scope will show you personal labels that you recently used. style - (optional) Allows 'table'. Specifying a table style will render the most recently used labels in a table form. title - (optional) Allows you to specify a heading for the table view of this macro. See the 'style' option above. Renders the list of pages associated with the specified label as a navigable map. A label must be specified for this macro. The following parameters are all optional: title - the title for this navigation map. wrapAfter - the number of cells to span horizontally before wrapping to the next line. (default: 5) cellWidth - width of individual cells in the map in pixels. (default: {navmap:mylabel} 90px) {navmap:mylabel|wrapAfter=3|cellWidth=110|cellHe cellHeight - height of individual ight=20|theme=mytheme} 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 WEBINF/classes/templates/macros directory. The file name convention to use is: navmapmytheme.vm. You can use whatever name you like in place of mytheme. Just make sure you
specify this when calling the macro using theme=mytheme. Table of Contents Documen tation Meet ing Minu tes Staff Direct ory
{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. A-Z documentation, staff, events, books, music 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 ')').
{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}
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 commaseparated. May also be one of the following special values: @all - All spaces, both personal and global @personal - All personal spaces @global - All non-personal spaces @favourites - All the current user's favourite spaces types - Will only list linking pages
of the specified types. Types should be comma-separated. Valid types include: page - Wiki pages news - Blog/News posts comment - Page or blog comments spacedescription - Space description userinfo - User profile attachment - An attachment mail - Mail archive mailto - A 'mailto' link url - An external URL. unresolved - An unresolved link. Creates a list of pages, websites and email addresses the current page links to. Wiki content may be included as the body to be shown if no links exist. Display Options page - The page to search on. mode - The mode in which links are displayed. Available modes: list - Links are displayed in a bullet-pointed list. flat - Links are displayed in a single row, with a separator between each item. separator - The style of separator to have. Defaults to ', ' when in flat mode. Available separators: brackets - Each item is surrounded by square brackets ('[' and ']'). braces - Each item is surrounded by curly braces ('{' and '}'). parens - Each item is surrounded by parentheses ('(' and ')'). pipe - Each item is separated by a pipe ('|'). other - The value is the separator. style - The style of the bullet points. Some styles may not be available depending on the mode. Available styles: icons - displays the Confluence
{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}
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 commaseparated. May also be one of the following special values: @all - All spaces, both personal and global @personal - All personal spaces @global - All non-personal spaces @favourites - All the current user's favourite spaces types - Will only list linking pages of the specified types. Types should be comma-separated. Valid types include: page - Wiki pages news - Blog/News posts comment - Page or blog comments spacedescription - Space
description userinfo - User profile attachment - An attachment mail - Mail archive mailto - A 'mailto' link url - An external URL. unresolved - An unresolved link. Creates a list of pages 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
{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}
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 commaseparated. 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. {undefined-links}No links exist{undefined-links} Creates a list of pages which are
{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}
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 commaseparated. 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. Displays a list of all spaces visible to the user, with linked icons leading to various space content functionality, within a table. The width parameter specifies the table width on the page. width - (optional) width of table on Confluence page, defaults to 100%.
{spaces:width=x}
{recently-updated-dashboard} {recently-updated-dashboard: spaces=sales,marketing | labels=timesheets,summaries}
Include a list of which Confluence content has changed recently Content will be listed from the current space or for each space defined in a comma separated list (space = x, y). The list will be rendered in a table with width matching the width argument (width=z) or defaulting to 100% spaces - (optional) comma separated list of space keys labels - (optional) comma separated list of labels (content associated with at least one of these will be listed) width - (optional) width of table on Confluence page, defaults to 100%. types - Filter content by type. You can specify one or more types, separated by commas. Accepted values: page: basic pages comment: comments on pages or blogs blogpost/news: blog posts attachment: attachments to pages or blogs userinfo: personal information spacedesc: space descriptions personalspacedesc: personal space descriptions mail: emails in a space showProfilePic - if true, display the profile pictures of the users who updated the content. Renders a list of links to global reports within a table of width x (defaults to 99%). width - (optional) width of table on Confluence page, defaults to 50%. Include the Confluence site welcome message. The site welcome message may be
{global-reports: width=x}
{welcome-message}
configured in the Administration > General Configuration section. Renders a create space button linked to the create space page. size - small (size of 'small' uses a smaller graphic, whereas size of 'large' uses a larger one) height - image height in pixels width - image width in pixels Lists users registered in Confluence. Either a group or groups value must be supplied. If you want all users in the system use groups=*. Supplying a groups value will list only members of those groups. The groups value supports a comma separated list of groupnames. Group: confluenceadministrators {userlister} {userlister:groups=confluence-administrators} {userlister:online=true} {userlister:groups=confluence-users|online=true} Tyler Durden ([email protected]) Marla Singer ([email protected]) Robert Paulson ([email protected]) Specifying the online value allows you to filter the user list by the user online status. Setting online=true will show only online users, whereas setting online=false will show only offline users. If you've configured this macro to display groups which are black listed by the administrator, you will get a warning panel at the top. The warning will be automatically displayed by default. To disable the warning, you can specify showWarning=false.
{create-space-button: size=large | width=32 | height=32}
External Content Ways to include, summarise or refer to content from other servers.
Notation
Comment
Imports and displays JIRA issue list as inline content for the page. You can easily customize the list and order of the columns being displayed, by specifying columns parameter. The url should be copied from the XML link of Jira's Issue Navigator. Refer to the JIRA Issues Macro documentation for further details. To specify a custom title (the text above the columns), you can specify the title parameter. By default this is JIRA Issues. A custom title can be specified by adding title=<My Custom Title> to the macros parameters. You can control how wide the {jiraissues} macro renders by specifying a width parameter. {jiraissues:url=http://jira.xml.url} To specify the width in percentage, use width=XX%. To specify the width in pixels, {jiraissues:url=http://jira.xml.url| use width=XXpx. If unspecified, the width will columns=type;key;summary} be 100%. Not specifying columns will lead into the {jiraissues:url=http://jira.xml.url| default column list and order. count=true} Allowed columns are: key, summary, type, created, updated, assignee, reporter, priority, {jiraissues:url=http://jira.xml.url| status, resolution. cache=off} Specifying count=true will cause the macro to just print out how many issues were in the list, {jiraissues:url=http://jira.xml.url? without printing the list. os_username=johnsmith&os_password= Using cache=off will force the macro to refresh secret} its internal cache of Jira issues. Note: Certain filters may require a logged-in {jiraissues:url=http://jira.xml.url| user in order to work. If a trust association has anonymous=true} been established between Confluence and JIRA, user authentication details will be passed between the servers automatically. This functionality requires JIRA 3.12 or later. If a trust association is not available you can send the required login by appending: &os_username=yourJiraUsername&os_passwo rd=yourJiraPassword to the end of your jira issues URL. You can prevent the jiraissues macro from attempting to use a trusted application link by specifying anonymous=true. Issues will then be retrieved anonymously. Example:
Atlassian JIRA (This file is an XML representation of some issues) Sum Assigne Key Status Res mary e TES T100 TES T103 TES T108 TES T109
Upda ted
Add JIRA John UNRES 01/Ja Open supp Gordon OLVED n/04 ort Add JUni In Robert UNRES 25/D t Progr Matson OLVED ec/03 Supp ess ort Add In RSS Bill UNRES 23/D Progr Supp Watson OLVED ec/03 ess ort Add Sear Fred ch Morit Supp ort Close FIXED d 03/Ja n/04
{jiraportlet:url=http://jira.portlet.url}
Imports and displays JIRA 3 portlet into a Confluence page. You can get the URL for the portlet by configuring the portlet into your JIRA dashboard. While in configuration mode, you can copy the portlet URL from the top of the portlet display. Note: Certain filters may require a logged-in user in order to work. Hence you may need to append: &os_username=yourJiraUsername&os_passwo rd=yourJiraPassword to the end of your portlet url. Lists supported plugins. profileKey The profile from which to get a list of plugins to display. by Lets you filter the list of plugins by the name of the person or organization that supports them. Shows a plugins compatibility with versions of a product.
{plugins-supported} {pluginssupported:profileKey=confluence} {pluginssupported:profileKey=confluence|by=atl assian} {plugin-compatibility-matrix} {plugin-compatibility-
matrix:key=confluence.repository.client }> {plugin-compatibilitymatrix:key=confluence.repository.client| productStart=2.7|productEnd=2.9}
key The key of the plugin to show compatibility information of. productStart The starting product version to show compatibility with. For instance, you can specify a value like 2.8 and the compatibility matrix will show compatibility information of the concerned plugin with product version 2.8 and above. productEnd This is the same as productStart. The only difference is that this is used as the upper boundary of the product version range, instead of lower. majorVersionsOnly If set to true, the generated compatibility matrix will only show compatibility with major versions of the product. If this is true, the plugin will assume the concerned plugin to be compatible with a major version of a product only: When a version of the plugin is explicitly marked compatibile with any minor version of the product, and... The same version of the plugin is not marked incompatible with any minor version of the product. By default, this is true. rows The number of the latest X versions of the plugin to show compatibility of. By default, all versions of the plugin is shown. showBrokenBuilds Lets you to choose whether to display broken builds as . By default, this is false and broken build cells are blank. Displays the results of a series (or single) JUnit test. Te Fail Tim Tim Success Rate sts ures e(s) e(s) 93 % 14 1 0 1.53 1
{junitreport:directory=file:///c:/testreports} (currently only picks up result files in XML format. Set ant formatter to "xml") {junitreport:url=file:///testreports/TestRep.xml} {rss:url=http://host.com/rss.xml}
Display the contents of a remote RSS feed within the page. Note: feeds are cached for 60 {rss:url=http://host.com/rss.xml|max=5} minutes before being retrieved again. The 'max' parameter can be used to limit the {rss:url=http://host.com/rss.xml|showTit number of entries displayed.
lesOnly=true}
Example: Sample RSS Feed (RSS 2.0) (Feed description here...) My Item ( Dec 30, 2003 06:53) And part of the item content here... Another Item ( Dec 30, 2003 06:53) And part of the item content here... You can specify 'showTitlesOnly=true' to show only the RSS feed titles. This parameter defaults to false. You can specify 'titleBar=false' to hide the feeds titlebar. This parameter defaults to true. You can specify anonymous=false to download the target content over a trusted connection (Trusted Application). For instance {rss:url=http://example.com/path/to/target/locat ion}. This parameter defaults to true.
Misc Various other syntax highlighting capabilities. Notation Comment \X Escape special character X (i.e. '{') Graphical emoticons (smileys). Notation :) Image :), :( etc Notation (+) (-) (?) (on) (off) (*) (*r) (*g) (*b) (*y) Image :( :P :D ;) (y) (n) (i) (/) (x) (!)
You might also like
- Topics: HTML (Hypertext Markup Language)No ratings yetTopics: HTML (Hypertext Markup Language)17 pages
- Lecture 2: Adding Hypertext Links To A Web PageNo ratings yetLecture 2: Adding Hypertext Links To A Web Page47 pages
- Are You A Lonely HTML-er?: Register For A Username HereNo ratings yetAre You A Lonely HTML-er?: Register For A Username Here21 pages
- WEB INTERFACE DESIGNING TECHNOLOGIES HTMLNo ratings yetWEB INTERFACE DESIGNING TECHNOLOGIES HTML17 pages
- Step.1-Click On Insert Button. Step.2-Click On Hyperlink Button. Step.3-Now Create Any FolderNo ratings yetStep.1-Click On Insert Button. Step.2-Click On Hyperlink Button. Step.3-Now Create Any Folder2 pages
- Nota Periodistica: Continuing Articles Across Pages Instructions For Using This TemplateNo ratings yetNota Periodistica: Continuing Articles Across Pages Instructions For Using This Template5 pages
- COMSATS Institute of Information Technology (CIIT) Vehari CampusNo ratings yetCOMSATS Institute of Information Technology (CIIT) Vehari Campus49 pages
- Creating Web Pages: Getting Started GuideNo ratings yetCreating Web Pages: Getting Started Guide15 pages
- Information and Communization TechnologyNo ratings yetInformation and Communization Technology118 pages
- Newsletter: Continuing Articles Across Pages Instructions For Using This TemplateNo ratings yetNewsletter: Continuing Articles Across Pages Instructions For Using This Template5 pages
- Confluence 101: Getting Started in ConfluenceNo ratings yetConfluence 101: Getting Started in Confluence22 pages
- Check Level Indicator (Bubble Should Be in Center)No ratings yetCheck Level Indicator (Bubble Should Be in Center)3 pages
- Corrosion Control in Geothermal Aerated Fluids Drilling Projects in Asia Pacific0% (1)Corrosion Control in Geothermal Aerated Fluids Drilling Projects in Asia Pacific7 pages
- Expand Your First Website: Thwacking Zombies With HTML & CSS Again: Undead Institute, #3From EverandExpand Your First Website: Thwacking Zombies With HTML & CSS Again: Undead Institute, #3No ratings yet
- Concepts of God in The Traditional Faith of The Meru People of Kenya - Marete Dedan GitariNo ratings yetConcepts of God in The Traditional Faith of The Meru People of Kenya - Marete Dedan Gitari138 pages
- Full Download Shakespeare Among The Courtesans Prostitution Literature and Drama 1500 1650 1st Edition Duncan Salkeld Ebook PDF & DOCX All ChaptersNo ratings yetFull Download Shakespeare Among The Courtesans Prostitution Literature and Drama 1500 1650 1st Edition Duncan Salkeld Ebook PDF & DOCX All Chapters67 pages
- Lesson 13 A Growing Sense of NationhoodNo ratings yetLesson 13 A Growing Sense of Nationhood21 pages
- Application 2018 - Reference Form Aga Khan UniversityNo ratings yetApplication 2018 - Reference Form Aga Khan University2 pages
- E.G. How Much Cheese? Yes, I'd Like Some Cheese, PleaseNo ratings yetE.G. How Much Cheese? Yes, I'd Like Some Cheese, Please1 page
- Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health79% (14)Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health260 pages
