Skip to end of metadata
Go to start of metadata

Overview

The topic summary macro provides a way to display forum topics from an entire space (or spaces). The topics displayed are child pages of forum root pages that are designated as a forum using the forum macro.

Usage

{topic-summary}

Like the forum macro the topics that are displayed are found using the Confluence search index. This means there will normally be a slight delay between when a page or comment is added and it showing up in this macro.

Macro Parameters

Content Parameters | Display Parameters | Username Meta Parameters

Content Parameters

Parameter

Required

Default

Notes

Bubbles Version

space

(error)

@current

Specify the space to display topics for. The following meta params can also be used:

  • @current - The space the macro is rendered in.
  • @personal - The users personal space.
  • @my-communities - The spaces that are also communities that the user is a member of.

1.6

recurse

(error)

false

Show all descendant pages as topics

1.6

sort

(error)

date

The sorting to use for the forum topics.

  • date - sort by last update date
  • activity - sort by the activity score for each topic. Only valid when activity score calculations are turned on.

1.6

reverse

(error)

false

Change the display order to show the oldest posts first.

1.6

excludeSubForums

(error)

true

Exclude any descendent topic pages from being displayed that are also marked as being forum root pages.

1.6

include

(error)

 

Topics with matching properties will be included

  • locked - locked topics
  • sticky - sticky topics
    Multiple includes can be specified as a comma separated list, topics must match all the include properties to be displayed.

1.6

exclude

(error)

 

Topics with matching properties will be excluded

  • locked - locked topics
  • sticky - sticky topics
    Multiple excludes can be specified as a comma separated list.

1.6

count

(error)

show all topics

The maximum number of topics that should be shown, eg. 10

1.6

paginate

(error)

true

If there are more topics then what can be displayed with the count parameter additional forum page links will be displayed.

1.6

start

(error)

0

The start index of the first topic to be displayed. (If the start index is specified in the http parameters when using pagination that value will override this param.)

1.6

author

(error)

 

If specified the topics displayed will be restricted to those authored by the given user. See Also Username Meta Params

1.6

participant

(error)

 

If specified the topics displayed will be restricted to those that the given user has participated in. See Also Username Meta Params

1.6

Display Parameters

Parameter

Required

Default

Notes

Bubbles Version

display

(error)

table

The layout to use for the forum topics:

  • table - A more conventional table layout, similar to the normal forum macro output
  • list - Simple list of page titles

1.6

none

(error)

"There are no topics in this forum"

The text to display if there are no topics in the forum. You can also use the @hide param to completely hide any form macro output if there are no topics.

1.6

fullComment

(error)

false

Show an excerpt from the latest comment or the full comment.

1.6

excerpt

(error)

comment

Controls if the excerpt from the latest comment or the original topic page is displayed.

  • comment - Show the excerpt from the latest comment
  • topic - Show the excerpt from the original topic page always
  • none - don't show the excerpt at all.

1.6

showPics

(error)

true

Whether to show the user's profile pictures or not:

  • true - Show profile pictures
  • false - Don't show pictures

1.6

showIcons

(error)

depends on display mode

Controls the display of the topic icons such as sticky pages, and locked comments etc. Defaults to false for list display mode, true for other display modes.

1.6

showForumStats

(error)

depends on display mode

This parameter controls the display of the forum statistics above the forum. By default they will be shown if the table display mode is selected, but won't be shown for other display modes.

1.6

activityIndicatorThreshold

(error)

50

The activity score required before adding the 'hot' indicator () to a topic. (This will only work when activity score calculations are enabled.)

1.6

class

(error)

 

The css class to apply to the top level element in the display to help with creating custom themes. For the list mode this will be appended to the <ul> element, for other display types it will be appended to the <table> element.

1.6

showParentPage

(error)

true

Show the parent page for the topic in the output. (This param doesn't apply to list display mode.)

1.6

parentPagePrefix

(error)

 

The text to show before the the parent page title in the output. (This param doesn't apply to list display mode.)

Username Meta Parameters

For macro parameters that take a username the following meta params can be used instead of specifying a username:

@self

Refers to the currently logged in user viewing the macro

@creator

Refers to the user that created the page that the macro is being rendered on

@owner

Refers to the user that created the space that the macro is being rendered in