Child pages
  • Bookmarks Macro
Skip to end of metadata
Go to start of metadata

This page describes the Bookmarks Macro. Please refer to [Working with Bookmarks] for details of how to add, view and subscribe to bookmarks.

Use the bookmarks macro to include a list of bookmarks on a Confluence page. By default, the macro will display the bookmarks saved in the current space. The bookmarks macro renders information as shown in the screenshot below.

Screenshot: Bookmarks Macro

On this page:

Usage with the Macro Browser

To insert the bookmarks macro into a page using the Macro Browser,

  1. Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
  2. Click the Macro Browser icon on the toolbar. The macro browser window will open.
  3. Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
  4. Click the desired macro.
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. Click 'Insert' to add the macro onto the page.

(tick) You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.

Once you've found the bookmarks macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

What you need to type

What you will get

Unknown macro: {nomarkup}
Unknown macro: {bookmarks}

Parameters

Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.

Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).

Parameter

Default

Description

Maximum Number of Bookmarks
(max)

15

The maximum number of bookmarks to display.

Search these Spaces Only
(spaces)

Current space

A list of spaces to search for, separated by commas. The macro will display the bookmarks saved in these spaces. Meta space names @all, @personal, @global can also be used.

Label(s)
(labels)

None

A list of labels to search for, separated by commas. The macro will display the bookmarks which have these labels applied. If you specify multiple labels, the bookmarks need to match only one of the labels to be included.

Creator(s)
(creators)

None

A list of usernames, separated by commas, specifying who created the bookmarks to be listed.

Sort By
(sort)

creation

Specify the sort order of the bookmarks. Valid values: 'creation' = bookmark created date; 'creator' = username of bookmark author; 'title' = bookmark title.

Reverse Sort
(reverseSort)

false

'true' = reverse the sort order.

Show Bookmark Creators
(showAuthor)

true

Display the user who created the bookmark.

Show Bookmark Creation Dates
(showDate)

true

Display the date when the bookmark was created.

Show Bookmark Descriptions
(showDescription)

true

Display the bookmark description.

Show Edit Links
(showEditLinks)

true

If the current user has permission, show quick links to edit or remove the bookmark.

Show Bookmark's Labels
(showLabels)

true

Display the bookmark's labels.

Show Bookmark List Heading
(showListHeader)

true

Display heading of the bookmark list (with the RSS feed link).

Show Space Where Bookmark is Saved
(showSpace)

true

Display the space the bookmark is saved in.

Show Link to Actual Bookmark
(showViewLink)

true

Display a link to the actual bookmark page.

Examples

Specify the number of bookmarks you want displayed:

Specify the space(s) where the bookmarks are saved:
The following markup will show the bookmarks in the personal space of user 'jbloggs' and in the 'sales' space.

Specify the space(s) where the bookmarks are saved and the person who created the bookmarks:
The following markup will show the bookmarks created by user 'jbloggs' in his personal space and in the 'sales' space.

Display only the bookmark titles:
We have forced the line-breaks in this example. Your code should consist of a single line.

RELATED TOPICS

[Working with Bookmarks]
[Working with Macros]

Take me back to the Wikis Help Guide.