Skip to end of metadata
Go to start of metadata

Overview

The {bubbles-show} macro allows a block of wiki text to be displayed based on a given condition. For users of the Theme Builder plugin, this is a very similar macro to builder-show macro only with conditions based on the functionality in the Bubbles plugin.

This macro is mainly intended to be used by people who are creating their own theme and want to control the display of some content based on the functionality of the Bubbles plugin.

See also: bubbles-hide macro

Usage

{bubbles-show:topic=true|sticky=true}

Stuff to display

{bubbles-show}

The body of this macro will be displayed if the conditions given in the parameters are true.

Parameters

Parameter

Required

Default

Notes

Bubbles Version

forum

(error)

 

true or false if the rendered page is a forum root page

1.4

topic

(error)

 

true or false if the rendered page is a forum topic page

1.4

locked

(error)

 

true or false if the rendered page has its comments locked

1.4

sticky

(error)

 

true or false if the rendered page is marked as sticky

1.4

community

(error)

 

true or false if the macro is rendered in a space that is also a community.

1.4

communityType

(error)

 

The ID of a community type that the is configured on the space that the macro is rendered in.

1.6

communityEnrolment

(error)

 

The community enrolment setting of the space the macro is rendered in. Possible options:

  • OPEN
  • MODERATED
  • CLOSED
  • NETWORK

1.6

communityGroup

(error)

 

The community group that the given user is in for the community that the macro is rendered in. (Multiple groups can be specified in a coma separated list.)

  • Member - user is a member of the community
  • Invited - user is invited to join the community

1.4

username

(error)

@self

For checks that are based on a user, such as community membership, which user should be used.

  • username - specify the username of a user.
  • @self - the logged in user
  • @creator - the user that created the page
  • @owner - ther user that created the space

1.4