Annual Documentation Survey

Do you have 4 minutes to help us improve our documentation? Please take our annual survey!

Skip to end of metadata
Go to start of metadata

ThemeBuilder Macro - Random Excerpt

random-excerpt

Includes the excerpt of a random child page to a specified parent.

See Confluence Excerpt Macro for how to set an 'excerpt' on pages you want included in the 'random-excerpt' macro's output.

Categories: confluence-content

Usage

Storage Format

<ac:macro ac:name="random-excerpt">
  <ac:parameter ac:name="parameter">value</ac:parameter>
</ac:macro>

Wiki Markup

 {random-excerpt:parameter=value}

Parameter

Name

Description

Type

Default

Required

parent

Parent Page

The page whose children an excerpt should be randomly chosen from

confluence-content

 

(error)

title

Show Page Title

Show the page title (default - true)

 

true

(error)

link

Link

Add a more link to the page whose excerpt is being displayed (default - true)

boolean

true

(error)

more

More Label

The label to use for the link to the page (default - More ...)

string

more

(error)

label

Labels

Comma separated list of labels which the content must have at least one for it to be shown

string

 

(error)

class

CSS class

The css classname to add to the outer div

string

 

(error)

count

Count

The number of excerpts to be shown (default 1)

string

1

(error)

hide

Hide

Whether to hide the extra excerpts or not (default false)

boolean

false

(error)

flag

Flag

A list of flags, one of which must be defined for the content to be displayed

string

 

(error)

notflag

Not Flag

A list of flags which must not be defined for the content to be displayed

string

 

(error)

Example

Show a random excerpt from the child pages of the page

<ac:macro ac:name="random-excerpt"><ac:parameter ac:name="parameter">value</ac:parameter>
</ac:macro>
 {random-excerpt:parameter=value}

Result

Shows a random page excerpt with a link through to the page.