Skip to end of metadata
Go to start of metadata

Description

The Forum Summary Macro is a dual purpose macro. It can be used to provide a summary of all forum macros across a space or root page. This helps provide a simple overview of all the Forums in a space, or can be used to create an easy to navigate list of forums.

Usage

There are two usage options with this macro, "space" and "page". In space mode, the macro shows all forums from the specified space. In page mode, the macro shows all forums that are child pages of the given page. The forums can be displayed in a table showing the number of topics/replies, as well as the last person to update the forum. 


Insert a Forum Summary Macro on a page.


Complete the desired fields and save.

Parameter

Description

Type

Default

Required
Sorted byDefines the sort order of the forums in the table. Options include alphabetic-ascending, alphabetic-descending, and last-activity.single selectalphabetic-ascending(tick)

Summarize forums under

Select if you want to summarize forums under the current page or across the entire space.single selectpage(tick)
Root pageThe page that contains child forums, or space key for forums from entire space.stringcurrent page(error)
SpaceAn alternate way of specifying the space key.stringcurrent space(error)
Recurse through child pagesApplies a recursive search to get the topics and reply counts for each forum found. if false, the topics and reply data are taken from child pages of the displayed forums only.booleanfalse(error)
Show user pictureShow the profile pictures of users.booleantrue(error)
Show forum authorShow the user who created the forum.booleanfalse(error)
Show forum excerptShow an excerpt of the forum.booleantrue(error)
Table HeadingChange the header of the first column.string"Forums"(error)

Sorted by

The sorted by last-activity option sorts forums using updates to a forum or when a new forum is created. Topic activity within a forum is not applied to the last activity sort order.

This results in a summary of forums.

  • No labels