Confluence Docs 3.0 : Bookmarks Macro This page last changed on Jun 11, 2009 by ggaskell. This page describes the Bookmarks Macro, provided by the Social Bookmarking plugin. 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 Usage with the Wiki Markup Editor Parameters Examples ## Usage with the Macro Browser To insert the bookmarks macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page. 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
--- | ---
{bookmarks} |
## Parameters Parameters are settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
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:
    {bookmarks:max=5}
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.
    {bookmarks:spaces=~jbloggs,sales}
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.
    {bookmarks:spaces=~jbloggs,sales|creators=jbloggs}
Display only the bookmark titles: We have forced the line-breaks in this example. Your code should consist of a single line.
    {bookmarks:showAuthor=false|showDate=false
    |showDescription=false|showEditLinks=false
    |showLabels=false|showListHeader=false
    |showSpace=false|showViewLink=false}
##### RELATED TOPICS Working with Bookmarks Working with Macros Take me back to the Confluence User Guide. Attachments: BookmarksMacro.png (image/png)

Document generated by Confluence on Nov 05, 2009 23:35