Skip to end of metadata
Go to start of metadata

Overview

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

A widget, styled using CSS, showing favourite spaces.

The default output will table of favourite spaces showing their logos, name and a (star) link

which can be clicked to remove them from the favourites.

 

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

Usage

{my-favourite-spaces}

Macro Parameters

Parameter

Required

Default

Notes

Bubbles Version

default

(error)

@creator

The username of the person whose favourites 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, blog or space (as applicable depending on where the macro is being displayed)

1.0

showImg

(error)

true

Show logos for the listed spaces:

  • true - show pictures
  • false - do not show pictures

1.0

output

(error)

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

(error)

no restriction

Limit the number of spaces listed to a specific number, eg: count=5

1.0

none

 

 

The text to be displayed if there is not favourite spaces.

1.0

(lightbulb) Tip: Make all your space logos about 48x48 pixels so they don't take up too much space.

Examples

 Show favourites for the creator of the current page, space, etc.

When you don't specify a user, the macro will default to @creator which represents the person who created the current page, blog or space (as applicable depending on where the macro is used).

{my-favourite-spaces}

or...

{my-favourite-spaces:@creator}

This is particularly useful when you are using the macro on a personal home page or in sidebars.

 Show favourites for a specific user

Specify the user name as the default parameter, eg. to show Joe's favourite users:

{my-favourite-spaces:joe}
 Show favourites for the logged in user

Specify the user as @self, for example:

{my-favourite-spaces:@self}

This is particularly useful when creating a central portal for all users (rather than individual portals) because it allows the portal to reflect the settings of the currently logged in user.

 Changing logo size

To change the picture size, use the size parameter. For example, to set the logos to 24x24 pixels, use:

{my-favourite-spaces:@self|size=24}
 Hiding the logos

You can hide the logos using the showImg parameter, for example:

{my-favourite-spaces:@self|showImg=false}
 Outputting spaces in a list

To output users in a list, use the following syntax:

{my-favourite-spaces:output=list}

Which will result in something like this:

Hints and Tips

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

{menubar}
 {menu}{compound-menuitem:home|flat=true|caption=_Home|accesskey=1}
  {compound-menuitem:favouritespace|caption=Toggle space as favourite}
  {menuseparator}
  {wikimenu}{my-favourite-spaces:@self|output=list}{wikimenu}
  {menuseparator}
  {compound-menuitem:dashboard|icon=earth_view|caption=All spaces...|accesskey=3}
 {menu}
{menubar}

In fact, that's exactly what we've done on our "Home" menu throughout this site. If you're logged in you'll see the extra options.

See Also