Skip to end of metadata
Go to start of metadata
Järjestelmään asennetut makrot:
{add-page} $macro.description
{add-page-form} $macro.description
{add-page-form2} $macro.description
{advanced-form} Advanced Form
{advanced-search:id=config_id}

The {advanced-search} macro requires a valid id that relates to an xml configuration on the Advanced Search Configuration page in the Admin Panel.

See Also: Plugin Homepage and Documentation

{alias} Creates an alias for the page it is on.
{anchor} Create an anchor that allows people to link to a specific point in a page
{attachments}
{blog} An alias to blog-posts.
{blog-post} An alias to blog-posts.
{blog-posts:max=5}

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

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

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

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

{blog-posts:labels=confluence,atlassian}

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

Displays the most recent blog posts in this space.

  • content - lets you choose whether to display each blog post in its entirety (the default), just short excerpts from each item (see the excerpt macro), or just a list of post titles.
  • time - lets you choose how far back to look for blog posts. For example, "time=12h" would show you those items made in the last twelve hours, and "time=7d" would show items made in the last week. (The default is no limit)
  • label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
  • spaces - (optional) spaces to search.
    Accepted values:
    • space keys (case-sensitive)
    • @self: current space
    • @personal: personal spaces
    • @global: global spaces
    • @favorite/@favourite: user's favourite spaces
    • @all/*: all spaces (that the user has permission to view)

    Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
  • type - (optional) search for types of content.
    Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions
    • mail: emails in a space

    Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
  • max/maxResults - (optional) the maximum number of results to return. Defaults to 100.
  • sort - (optional) the sorting to apply to the results.
    Accepted values:
    • title: by content title
    • creation: by time of creation
    • modified: by time of last modification (creation is the "first" modification)
  • reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

{blogpost} An alias to blog-posts.
{blogposts} An alias to blog-posts.
{blogs} An alias to blog-posts.
{calendar:id=myCalendar|title=My Calendar|defaultView=week}

Displays a calendar.

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

Creates a new card. Must be inside a 'deck'. Only one card is visible at any given time.

  • label - (required) The label to put on the tab.
  • default - (optional) If true, the card will be the default. The last card in the deck marked as 'default' will be the default.
  • accessKey - (optional) The key that, when combined with {{Ctrl}} will activate the card.
  • class - (optional) The custom CSS class for the tab.
  • nextAfter - The number of seconds the slide will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.
  • effectType - The effect to use when moving to this slide. May be 'fade' or 'none' (the default).
  • effectDuration - The number of seconds the transition will take to complete. Eg. '1.5'
{change-history} Show the history of version comments.
{chart}
{child-counter} $macro.description
{children}

{children:all=true}

{children:depth=x}

{children:depth=x|style=h3}

{children:excerpt=true}

{children:page=Another Page}

{children:page=/}

{children:page=SPACEKEY:}

{children:page=SPACEKEY:Page Title}

{children:first=x}

{children:sort=<mode>|reverse=<true or false>}
children.desc.text

Example:

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

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

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

  • id - (required) The unique ID of the cloaked section.
  • visible - (optional) If 'true', the section will be visible initially. Defaults to 'false'.
{code} Macro to format blocks of source-code or XML. (Legacy)
{code} <b>html code</b> {code}

Formats source code

  • language: - (optional) the language to format, the default parameter
    • Supported values: c, c#, csharp, delphi, html java, javascript, js, pascal, php, python, py, shell, sql, vb, vb.net, xhtml, xml
  • linenumbers: - (optional) if "true", display line numbers next to the source code.
  • firstline: - (optional) the number to start line numbers at (defaults to 1).
  • controls: - (optional) if "true", display controls above the code fragment to view plain, copy to clipboard (on IE) and print.
  • collapse: - (optional) if "true", collapse the code fragment by default.

{color} Change the colour of the contained text
{column}
{composition-setup:defaults=Home^composition.properties}
cloak.memory.duration = 3 #days
cloak.toggle.type = custom
cloak.toggle.open = ^open.gif
cloak.toggle.close = ^close.gif
{composition-setup}

Performs setup operations for some of the composition macros. Some macros require that this has been put at the top of a page for them to work. It allows page-wide settings for macros. Its contents is a list of properties, as listed below.

Parameters:

  • defaults - (optional) the link to the default property attachment. E.g. "Home^defaults.txt". This allows easy setting of defaults for multiple pages.

Properties:

  • import.css - The path to the CSS file to import. May be a page attachment (eg. "^style.css") or a regular URL.
  • cloak.memory.duration - The number of days to remember the state of the page. Set to 0 to disable memory altogether. Defaults to 7 days.
  • cloak.toggle.type - (optional) The type of toggle to display. May be:
    • default - (default) Blue arrows pointing up or down.
    • custom - Allow custom images as the icons. You must set 'cloak.toggle.open' and 'cloak.toggle.close' when using this option.
    • text - Allow any regular text as the icons. You must set 'cloak.toggle.open' and 'cloak.toggle.close' when using this option.
    • wiki - Allow regular wiki text (except links). You must set 'cloak.toggle.open' and 'cloak.toggle.close' when using this option.
    • none - No icon will be output at all. You will probably want to make sure that 'cloak.toggle.zone' is set to true with this option.
  • cloak.toggle.open - If 'cloak.toggle.type' is set to 'text' or 'custom', this what the toggle will contain when the cloak contents can be expanded. E.g. If in 'text' mode, a good value might be '+'. If in 'custom' mode, either an absolute URL ('http://.../open.gif'), a relative URL ('/.../open.gif') or a Confluence attachment link ('[SPACEKEY:][Page]^open.gif') must be provided.
  • cloak.toggle.close - If 'cloak.toggle.type' is set to 'text' or 'custom', this is what the toggle will contain when the cloak contents can be hidden. E.g. If in 'text' mode, a good value might be '-'. If in 'custom' mode, either an absolute URL ('http://.../close.gif'), a relative URL ('/.../close.gif') or a Confluence attachment link ('[SPACEKEY:][Page]^close.gif') must be provided.
  • cloak.toggle.exclusive - (optional) If true, all cloaked sections will be exclusive - that is, only the current section will be visible at any given time. Defaults to 'false'.
  • cloak.toggle.zone - (optional) If true, the paragraph or heading any toggle icons are placed in can also be clicked to toggle the associated cloak section. Defaults to 'true'.
  • deck.memory.duration - The number of days to remember the state of the decks on the page. Set to 0 to disable memory altogether. Defaults to 7 days.
  • deck.class - The custom CSS class to apply to all decks
  • deck.tab.location - 'top', 'bottom' or 'none'. The location of the tab bar.
  • deck.tab.active.border - The border for the active tab (CSS - eg. '1px dashed black')
  • deck.tab.active.background - The background for the active tab (CSS - eg. '#ff0055')
  • deck.tab.inactive.border - The border for inactive tabs (CSS)
  • deck.tab.inactive.background - The background for inactive tabs (CSS)
  • deck.tab.spacer - The distance between tabs (eg '5px')
  • deck.card.border - The border for the active card.
  • deck.card.background - The background for the active card.
  • deck.width/deck.height - The width and/or height the content will be constrained to (not including any tabs). If not set, the tabs expand to display their content.
  • deck.startHidden - If set to 'false', the cards will be initially visible on the page until setup is complete. Defaults to 'true'.
  • deck.loopCards - If 'true', the deck will loop back to the beginning from the last card and vice versa. Defaults to 'false'.
  • deck.nextAfter - The number of seconds the slides will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.
  • deck.effect.type - The effect to use when moving to a new slide. May be 'fade' or 'none' (the default).
  • deck.effect.duration - The number of seconds the transition will take to complete. Eg. '1.5'. Defaults to 1.
{content-by-user:fred}

usertable.desc

{contentbylabel:labels=dogs,cats}
{contentbylabel:labels=dogs,cats|space=PETS}
{contentbylabel:labels=dogs,cats|type=page,blogpost}
{contentbylabel:labels=dogs,cats|showLabels=false|showSpace=false}
{contentbylabel:labels=dogs,cats|excerpt=true}
{contentbylabel:labels=+dogs,+cats}
{contentbylabel:labels=+lebowski,+bowling,-walter|space=@all|type=page,-blogpost}

Displays a list of content marked with the specified labels.

  • type - (optional) search for types of content.
    Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions
    • mail: emails in a space

    Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces.
  • showLabels - (optional) display the labels for each results (enabled by default)
  • showSpace - (optional) display space name for each result (enabled by default)
  • title - (optional) add a title above the results list
  • max/maxResults - (optional) the maximum number of results to display (default is 5)
  • excerpt - (optional) display first line of excerpt for each result
  • space/spaces - (optional) spaces to search.
    Accepted values:
    • space keys (case-sensitive)
    • @self: current space
    • @personal: personal spaces
    • @global: global spaces
    • @favorite/@favourite: user's favourite spaces
    • @all/*: all spaces (that the user has permission to view)

    Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces.
  • label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
  • sort - (optional) the sorting to apply to the results.
    Accepted values:
    • title: by content title
    • creation: by time of creation
    • modified: by time of last modification (creation is the "first" modification)
  • reverse - (optional) reverses the currently applied sort. This parameter must be used in conjunction with the sort parameter.

{contributors} Lists all of the authors of a page (Legacy)
{contributors-summary} Displays a summary in table form of pages and contributors (Legacy)
{create-space-button} $macro.description
Tabbed deck
{deck:id=My Deck}
{card:label=Card 1}
Card 1 contents.
{card}
{card:label=Card 2}
Card 2 contents.
{card}
{deck}

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

Creates a new deck of 'cards' - sections of content which are displayed one at a time. By default, tabs similar to those in the default Confluence theme are displayed.
Note: Requires that {composition-setup} is placed above it in the page.

  • id - (required) The unique ID of the deck section.
  • tabLocation Either 'top', 'bottom' or 'none'. Defaults to 'top'.
  • class - The custom CSS class the deck will be placed in.
  • width/height - The width and/or height the content will be constrained to (not including any tabs). If not set, the tabs expand to display their content.
  • startHidden - If set to 'false', the cards will be initially visible on the page until setup is complete. Defaults to 'true'.
  • loopCards - If 'true', the deck will loop back to the beginning from the last card and vice versa. Defaults to 'false'.
  • nextAfter - The number of seconds the slides will stay visible before moving to the next one. By default the current slide will not transition until prompted by the user.
  • effectType - The effect to use when moving to a new slide. May be 'fade' or 'none' (the default).
  • effectDuration - The number of seconds the transition will take to complete. Eg. '1.5'. Defaults to 1.
{details} Record (and display) details about a page (Legacy)
{detailssummary} Show a tabular view of a series of details stored in pages in the same space (Legacy)
{doc:/display/DOC/Confluence+Documentation+Home}Confluence Documentation{doc}

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

{dynamictasklist} $macro.description
{editinwordlink} Adds a hyperlink for editing in Word
{excerpt}excerpt.example.text{excerpt}

{excerpt:hidden=true}excerpt.example.text.hidden{excerpt}
excerpt.desc
  • excerpt.hidden.desc
{excerpt-include:Home}

{excerpt-include:Home|nopanel=true}

{excerpt-include:blogPost=/2006/12/28/News Page}
excerptinclude.desc
  • excerptinclude.nopanel.desc
{expand} $macro.description
{favpages} List the pages in your favourites list.
{float:right|width=50px|background: #F0F0F0|border: solid navy}
This will float to the right.
{float}

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

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

{gallery:columns=3}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{global-reports} $macro.description
{google-calendar} Displays a calendar with events for one or more Google Calendars.
{html} Use HTML code within a Confluence page (Legacy)
{html-include} Retrieve an external HTML file and include it in the page (Legacy)
{include:Home}

{include:FOO:Home}

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

include.user.perms

{incoming-links} $macro.description
{index}

index.desc

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

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

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

{link} For compatibility with any {link} macros imported from SnipSnap data (Legacy)
{link-page} $macro.description
{link-to} $macro.description
{link-window} $macro.description
{listlabels:spaceKey=@all}

Renders the list of all labels or labels for a specific space sorted alphabetical.

  • spaceKey - (optional) list the labels in the specified space (current space by default). If '@all' is specified, labels in all spaces will be listed.

documentation, staff, events, books, music

{livesearch} $macro.description
{loremipsum} Insert paragraphs of "lorem ipsum" space-filler text
{lozenge} $macro.description
{macro-list}

Prints a list of all enabled macros in this installation.

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

{multimedia} $macro.description
{navmap:mylabel}
{navmap:mylabel|wrapAfter=3|cellWidth=110|cellHeight=20|theme=mytheme}

Renders the list of pages associated with the specified label as a navigable map.
A label must be specified for this macro. The following parameters are all optional:

  • title - the title for this navigation map.
  • wrapAfter - the number of cells to span horizontally before wrapping to the next line. (default: 5)
  • cellWidth - width of individual cells in the map in pixels. (default: 90px)
  • cellHeight - height of individual cells in the map in pixels. (default: 60px)
  • theme - if you want to create your own look and feel for the navmap (say one with rounded corners), you can do so by adding a file to the WEB-INF/classes/templates/macros directory. The file name convention to use is: navmap-mytheme.vm. You can use whatever name you like in place of mytheme. Just make sure you specify this when calling the macro using theme=mytheme.

{network} The network macro displays a summary of a user's network in a Confluence page.
{newcode} Macro to format blocks of source-code or XML. This macro uses the key "{newcode}" to maintain backwards compatibility with earlier versions of the plugin. (Legacy)
{news} An alias to blog-posts.
{nl} $macro.description
{noformat} Create blocks of text where other wiki formatting is not applied
{nolink} $macro.description
{note} $macro.description
{orphaned-links} $macro.description
{outgoing-links} $macro.description
{page-info} $macro.description
{pagefamily-tagcloud}

Creates a tag cloud from labels on a page hierarchy. Similar to the popular-labels macro, but using only the labels attached to descendant pages of a given root page.

Parameters:

  • rootPage - the page to use as the root page of the search for labels. You can provide just a title, or use the [spaceKey]:[title] format. By default the current page is used as the root page.
  • sort - sort labels by number of occurrences (count) or alphabetically by label and label type (label). Default is label.
  • reverse - reverse the order of the sorting, default is false
  • includeRootPage - should the labels on the root page be included in the tag cloud or only the labels on descendant pages. Default is true.
  • labelLink - custom url that will be used as the link behind each label. The token %label$ will be replaced by the url encoded label. By default if nothing is specified for this param the label will be linked to the default Confluence label action.

{pagetree}

{pagetree:root=PageName}

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

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

{pagetree:searchBox=true}

{pagetree:expandCollapseAll=true}

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

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

{pagetreesearch}

{pagetreesearch:rootPage=PageName}

{pagetreesearch:rootPage=Space:PageName}

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

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

{panel} Draw a panel with an optional title and border
{popular-labels}

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

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

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

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

Injects the published date into the page properties.

See Also: Plugin Homepage and Documentation

{quote} Generate blockquotes that may contain multiple paragraphs or complex markup
{recently-updated}
{recently-updated: spaces=sales,marketing | labels=timesheets,summaries}
{recently-updated: labels=+confluence,-jira | spaces=@all}
{recently-updated: spaces=NOVELS,SHORTSTORIES | sort=creation | reverse=true}

Include a list of Confluence content which has changed recently. By default, listed content will be listed from the current space. Returned content may be filtered through the various parameters.

  • space/spaces - (optional) spaces to search.
    Accepted values:
    • space keys (case-sensitive)
    • @self: current space
    • @personal: personal spaces
    • @global: global spaces
    • @favorite/@favourite: user's favourite spaces
    • @all/*: all spaces (that the user has permission to view)

    Prefix a space with '+' to require a match or '-' to exclude any matches from that space. By default,at least one of the named spaces must match. Separate spaces with commas or single-spaces. Defaults to the current space (@self).
  • label/labels - (optional) search for content with these labels; prefix a label with '+' to require a match or '-' to exclude any content with that label. By default, at least one of the labels will be present on any matched content. Separate labels with commas or single-spaces.
  • width - (optional) width of the rendered table on Confluence page. Defaults to 100%.
  • type/types - (optional) search for types of content.
    Accepted values:
    • page: basic pages
    • comment: comments on pages or blogs
    • blogpost/news: blog posts
    • attachment: attachments to pages or blogs
    • userinfo: personal information
    • spacedesc: space descriptions
    • personalspacedesc: personal space descriptions

    Prefix a type with '+' to require matches to be of that type, or '-' to exclude matches of that type.By default, matched content will be of at least one of the listed type. Separate types with commas or single-spaces. Defaults to all types. In shared mode, the personal information type is excluded from the defaults.

{recently-updated-dashboard} Displays recent updates with filtering options. Used on the dashboard.
{recently-used-labels}

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

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

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

{redirect} Redirects the browser to the specified page.
{related-labels}

{related-labels:labels=labelone, labeltwo}

Renders a list of labels related to the current page's labels.

  • labels - (optional) comma-separated list of labels whose related labels will be displayed.

{rss} Retrieve a remote RSS feed and summarise it in the page (Legacy)
{scribd:id=1234565|doc=doc_123456789000000|key=key-someacceskeyhere
|ver=1|page=1|height=500|width=450|name=doc_123456789000000_object|align=center}

{scribd:id=1234565|doc=doc_123456789000000|key=key-someacceskeyhere
|ver=1|page=1|height=500|width=450|name=doc_123456789000000_object|align=left}
You can upload your file as Word, PDF, plain text, HTML, JPEG, PowerPoint, Excel, Postscript, LIT, and even audio format to Scribd ( http://www.scribd.com/ ) and use this Macro to view it Embed in your Confluence pages.
Remove line break before |ver=

Params
doc = doc_123456789000000
id = 1234565
ver = default 1
key = key-someacceskeyhere
page = default 1
align = left|center|right
height = default 500
width = default 450
name = doc_123456789000000_object
{search:query=my_query}

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

Example:

Found 2 result(s) for home

Home (My Space)
This is the home page for My Space.
PDF File file-containing-home.pdf ( download)
{search-form}
  {search-input:type=text|match=query}
  {search-submit}
{search-form}

{search-results}

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

  • autoSubmit - (boolean) Submit the form as soon as the page loads, providing default results. (defaults is false).
  • hidden - (boolean) Hide the form from view (only useful when autoSubmit=true)

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-input:type=checkbox|match=label|value=alpha|checked=true} Search for Alpha?
  {search-input:type=checkbox|match=label|value=beta} Search for Beta?
  {search-submit}
{search-form}

{search-results}

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

  • match - (string) Type of Search Field (label, metadata, query).
  • metadataKey - (string) Metadata Key - only valid if match=metadata
  • type - (string) Type of Field (text, checkbox, hidden)
  • value - (string) Value of the Field
  • checked - (boolean) Inital State - only valid if type=checkbox (default is false)

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-select:match=query|nullLabel=neither}
    {search-option:value=alpha}Alpha{search-option}
    {search-option:value=beta}Beta{search-option}
  {search-select}
  {search-submit}
{search-form}

{search-results}

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

  • value - (string) Value of the Field.
  • selected - (boolean) Is this Option Selected. (default is false)

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-submit}
{search-form}

{search-results}

The {search-results} macro is used to display the output of the search and to configure how the search results are displayed.

  • Types - There are 4 content types you can search for currently. You specify them as a comma separated list and any of the specified content types are included in the results. The 4 content types are: page, blogpost, userinfo and spacedesc.
  • Fields - There are 6 fields, and can be displayed in any order - however title must always be display. They can also be renamed:
    rating,title!My Title,author
    That would put the fields in that order, renaming the title field to "My Title".
  • Excerpts - If shown, the contents of the {excerpt} macro are used first and then it falls back on the the content excerpt used in the standard search results.
  • Ratings - If the rate macro is use (or has been in the past) and the page has ratings, then an average is found. If the rateThreashold (defaulting at 5) isn't met (i.e. if there haven't been 5 people rating this content) then it uses 0. If there isn't any rate data then it defaults to 0 as well. NOTE: If the content has been rated in the past, and the rate macro is then removed - the rating data will sill remain and will still be used by this plugin. This can be worked around by detecting the presence of a {rate} macro first in the content - however this work around isnt in effect yet. Please let me know if this is needed.

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-select:match=query|nullLabel=neither}
    {search-option:value=alpha}Alpha{search-option}
    {search-option:value=beta}Beta{search-option}
  {search-select}
  {search-submit}
{search-form}

{search-results}

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

  • match - (string) Type of Search Field (label, metadata, query). This parameter is required.
  • metadataKey - (string) Metadata Key is only valid if match=metadata
  • nullLabel - (string) Label of the "unanswered" option

See Also: Plugin Homepage and Documentation

{search-form}
  {search-input:type=text|match=query}
  {search-submit}
{search-form}

{search-results}

The {search-submit} macro must be included within the search-form if you wish your users to be able to manually submit the search.
(If you hide the search form and set it to auto submit, then this is not needed.)
The default text on the button can be changed, eg:

{search-submit:Search}

See Also: Plugin Homepage and Documentation

{section}
{shortcut-list}

Prints a list of all configured shortcuts in this installation.

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

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

Shows a card in the specified deck.

  • deck - (required) The id of the deck.
  • card - (required) Either the label of the card, or one of the following special labels:
    • @first - Show the first card in the deck.
    • @last - Show the last card in the deck.
    • @next - Show the next card after the currently-visible one. If the deck loops, it will show the first card if the current card is the last.
    • @prev - Show the card previous to the currently-visible one. If the deck loops, it will show the last card if the current card is the first.
  • scrollTo - (optional) If set to false, the browser will not scroll to the deck. Defaults to true.
{slide-share:id=123456|doc=some-doc-here-1234567890123456-7|align=left}

{slide-share:id=123456|doc=some-doc-here-1234567890123456-7|align=center}
You can upload your PowerPoint, OpenOffice and PDF Presentations to SlideShare ( http://www.slideshare.net/ ) and use this Macro to view it Embed in your Confluence pages.

Copy Embed in your blog code and fill its first div's id to first parameter of this macro and embed tags src atribute url's doc to doc parameter.
{snips-by-user} List the content created by a particular user (SnipSnap import compatibility) (Legacy)
{space-attachments}
{space-details} $macro.description
{spacejump}
{spaces} $macro.description
{spaces-list} Lists all spaces in Confluence. (deprecated - use {spaces} instead)
{status} Status macro for Confluence (pre-4.0)
{status-list} A Macro to list the Status Updates of a user
{survey:changeableVotes=true|voters=user1,user2|viewers=user3}
Knowledge - This is the knowledge category.
Communication - This is the communication category.
{survey}

The survey macro allows Confluence users to be surveyed on several categories. For each category, users are allowed to select only one of the given choices, and the results will not be visible to them until they have voted. Users that have not logged in will be prompted to do so before allowing them to cast a vote. This macro was created to support surveys of confluence users on several categories and will provide them with the chance to give a rating (1 to 5) for each category as well as a comment.

The body of this macro defines the categories that the users will be polled on. Each line of the body will be treated as a seperate category and should be written in the format "title - description". The title is always required but the dash and the description are optional.

Parameter Required Default Description
title false default no title If a Title is specified the Survey gets a Box around which makes it looking more compact and feeling the votes are belonging more together.
voters false all users This is a comma seperated list of usernames to who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters.
viewers false all users This is a comma seperated list of usernames to who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results.
changeableVotes false false This parameter, if set to true, will allow the users to change their responses after they have been cast.
choices false default 1-5 A comma separated List of choices. This will override the Default (1-5) List, but can still be overriden by a '-' separated list in each single line.
showComments false true Show comments-menu (the whole set: show, add, edit, delete)
locked false false Dont allow any further voting. Show a lock Symbol to indicate that. Image for Survey will only be displayed if you have the title-flag also. (It is still shown on the vote-elements)

{tasklist} $macro.description
{tip} $macro.description
{toc:style=disc|indent=20px}
{toc:outline=true|indent=0px|minLevel=2}
{toc:type=flat|separator=pipe|maxLevel=3}

Creates a Table of Contents for headings on the the current page.

  • type - (optional) The type of output. May be one of the following:
    • list - (default) The headings are output in hierarchical list format.
    • flat - The headings are listed on a single line with a separator between them.
  • class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
  • style - (optional) The style of the list items if in list mode. The style may be any of the following:
    • none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
    • any CSS style - Headings are output in indented lists with the specified CSS style.
  • outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
  • ident - (optional) The amount to indent each list sub-heading by (default is '10px').
  • separator - (optional) The type of separator to use if the style is flat. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item. (default)
    • brace - Square brackets ('[', ']') surrounding each item. (default)
    • comma - A comma (',') between each item.
    • paren - Parentheses ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
  • minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
  • maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
  • include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
{toc-zone:separator\=brackets|location=top}
h1. First Heading
blah blah blah...
{toc-zone}

Creates a Table of Contents for headings contained in the macro body.

  • location - (optional) The location to have the table of contents output. May be 'top' or 'bottom'. If not set, it will be output at both locations.
  • type - (optional) The type of output. May be one of the following:
    • list - (default) The headings are output in hierarchical list format.
    • flat - The headings are listed on a single line with a separator between them.
  • class - (optional) If specified, the TOC will be output with the specified CSS class. Also, if set, no other style values will be output.
  • style - (optional) The style of the list items if in list mode. The style may be any of the following:
    • none - (default) Headings are output in indented lists with no bullet points or numbers prefixing them.
    • any CSS style - Headings are output in indented lists with the specified CSS style.
  • outline - (optional) If set to true, each item will be prefixed with a number in the format 'X.Y'. The numbers will increase automatically, and extra levels will be added for lower-level headings.
  • ident - (optional) The amount to indent each list sub-heading by (default is '10px').
  • separator - (optional) The type of separator to use if the style is flat. May be one of the following:
    • bracket - Square brackets ('[', ']') surrounding each item. (default)
    • brace - Square brackets ('[', ']') surrounding each item. (default)
    • comma - A comma (',') between each item.
    • paren - Parentheses ('(', ')') surrounding each item.
    • pipe - A pipe ('|') between each item.
    • newline - A line break after each item.
    • "custom" - Any other character you wish, specified between quotes.
  • minLevel - (optional) The lowest heading level to include (inclusive). (default is 1).
  • maxLevel - (optional) The highest heading level to include (inclusive). (default is 7).
  • include - (optional) If set, any headings not matching the regular expression will be ignored. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • exclude - (optional) If set, any headings matching the regular expression will be excluded. Due to '|' being the parameter separator in macros, use ',' where you would have usually used '|'.
  • printable - (optional) If set to 'false', the table of contents will not be visible when being printed.
h1. {toggle-cloak:id=Cloaked Content} Cloaked Content

Creates a button to toggle a cloaked section between being visibile and hidden.
Note: Requires that {composition-setup} is placed above it in the page.

  • id - (required) The unique ID of the cloaked section to toggle.
  • exclusive - (optional) If true, all other sections at the same level will be cloaked when this is shown.
{undefined-links} $macro.description
{userlister}
{version-history} $macro.description
{viewdoc} Inserts Microsoft Word content into the page
{viewfile:presentation.ppt}

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

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

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

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

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

{viewpdf} Inserts a PDF document into the page as an interactive presentation
{viewppt} Inserts an interactive Microsoft Powerpoint presentation into the page
{viewxls} Inserts Microsoft Excel content into the page
{vote:What is your favorite color?}
Red
Blue
None of the above
{vote}

{vote:What is your favorite color?|changeableVotes=true|voters=user1,user2}
Red
Blue
None of the above
{vote}

The vote macro allows Confluence users to vote on any topic of interest. Users are allowed to select only one of the given choices and vote one time, and the results will not be visible to them until they have voted. Users that have not logged in will be prompted to do so before allowing them to cast a vote. This macro was created to support quick, informal votes on various topics. The macro has a title and a series of choices, each choice starting on its own line.

Parameter Required Default Description

true
This is the title of the ballot and must be the first paramter.
voters false all users This is a comma seperated list of usernames to who are allowed to cast a vote. Users not in this list will not be allowed to vote, but if they are viewers will be shown the results of the vote. If this parameter is not specified, all users with access to the page are considered voters.
viewers false all users This is a comma seperated list of usernames to who are allowed to see the survey results. Users not in this list will be allowed to vote but after doing so will simply be shown which item they voted for. If a user is in this list but is not a voter, they will be taken straight to the results. If this parameter is not specified, all users will be able to see the results.
changeableVotes false false This parameter, if set to true, will allow the voters to change their vote after it has been cast.
locked false false Dont allow any further voting. Show a lock Symbol to indicate that.

Before the user logs in:

What is your favorite color? (Log In to vote.)
Choices Your Vote
Red
Blue
None of the above

Before the logged-in user votes:

What is your favorite color?
Choices Your Vote
Red
Blue
None of the above

After the logged-in user votes:

What is your favorite color?
Choices Your Vote Current Results: (10 total votes)
Red
(4 votes, 40%)
Blue
(5 votes, 50%)
None of the above
(1 votes, 10%)
{warning} $macro.description
{web-widget} $macro.description
{weblogs} Display the most recent news items within a space (SnipSnap import compatibility) (Legacy)
{welcome-message} Insert welcome message text.
{widget} $macro.description
{you-tube:id=123456|align=left}

{you-tube:id=123456|align=center}
View your YouTube http://www.youtube.com/ videos. But video id to id.
  • No labels