Access Keys:
Skip to content (Access Key - 0)

Adaptavist Documentation Move

This documentation is deprecated. Adaptavist's documentation has moved to a new location where it is maintained and updated. Please visit Adaptavist's new Documentation area.

my-favourite-users macro

Overview

The my-favourite-users macro is used to list people marked as favourite for a specific user.

A widget, styled using CSS, showing favourite users.

The default output will table of favourite users showing their profile pictures, name and a link1 which can be clicked to remove them from the favourites.

Footnotes
Ref Notes
1 The link is only shown when viewing your own favourites.

The macro can be used in Widgets, Theme Builder layouts and within content such as wiki pages and blog posts.

Usage

{my-favourite-users}

Macro Parameters

Parameter Required Default Notes Bubbles Version
default @creator The username of the person whose favourites people are to be displayed:
  • username - the user's username
  • @self - the currently logged in user (does not output anything for anonymous users)
  • @creator - the user who created the current page or blog (as applicable depending on where the macro is being displayed)
  • @owner - the user who created the space where the current page or blog is located.
1.0
showImg true Show profile pictures for the listed users:
  • true - show pictures
  • false - do not show pictures
1.0
output table The output format for the list:
  • table - tabular format, ideal for use in widgets
  • list - unordered list, ideal for use in Theme Builder menus
1.0
count no restriction Limit the number of users listed to a specific number, eg: count=5 1.0
size source image size The width and height of the profile pictures. Confluence automatically scales all profile pictures to 48x48 pixels, however you can further reduce the image size using this parameter. For best results, use multiples of the default size, eg. 12, 24, 96. 1.0
none   The text to display if there is no favourite users 1.0

Examples

Show favourites for the creator of the current page

Show favourites for a specific user

Show favourites for the logged in user

Changing profile picture size

Hiding the profile pictures

Outputting users in a list

Hints and Tips

If you are using Theme Builder 3.0, you can embed a list of favourite users in to menus using syntax like the following:

{menubar}
 {menu}People
  {wikimenu}{my-favourite-users:@self|output=list}{wikimenu}
  {menuseparator}
  {compound-menuitem:people|caption=People Directory...}
 {menu}
{menubar}

See Also



View old comments


Adaptavist Theme Builder Powered by Atlassian Confluence