Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

The macro will load slowly in a site with a lot of content. Use Local Reporter macro where possible.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

space(s)

  • Status
    title(X)

  • Status
    titleNO

@self

The comma-separated list of spaces to search in.

Each space may be prefixed by either '+' (to indicate the space is required) or '-' (to indicate the space must be excluded).
May be one of the following:

  • @self - (default) The space the current content is in.

  • @personal - Personal spaces only.

  • @global - Global spaces, that is, non-personal spaces.

  • @favorite - Favourite spaces only.

  • @all - All spaces, both global and personal.

  • SPACE KEY - Any other space key may be specified explicitly.

type(s)

  • Status
    title(X)

  • Status
    titleNO

all

The comma-separated list of content types to allow.

Each type may be prefixed by either a '+' (to indicate it is require) or '-' (to indicate it must be excluded). May be any of the following: 

  • page

  • news

  • comment

  • attachment

  • spacedescription

label(s)

  • Status
    title(X)

  • Status
    titleNO

The comma-separated list of labels to filter on. Each label can be prefixed with either a '+' (AND operator) or '-' (NOT operator). If no prefixes are included, the default operator would then be OR.

e.g.:

  • "+asia, +europe, -americas" would list content which have the "asiaAND "europe" labels but NOT the "americas" label.

  • "asia, +europe, -americas" would list content which has the "europe" label but NOT the "americas" label. Take note that because the "asia" label has no prefix but the other labels do, it will be ignored.

  • "asia, europe, americas" would list content which have at least one of these labels.

scope

  • Status
    title(X)

  • Status
    titleNO

Comma-separated list of pages, news items, etc which are in scope. If the content is a page, the scope can be expanded to their children, descendants or ancestors: 

  • > children - The direct children of the specified page. e.g.: 'My Page > children'

  • > descendants - All descendants of the specified page. e.g.: 'My Page > descendants'

  • > ancestors - All ancestors of the specified page. e.g.: 'My Page > ancestors'

Note

This is independent of the space parameter, so if you wish to limit the scope for a page in another space, you will need to put that space key as the prefix, even if you already specified it in the space parameter.

e.g.: "KEY:My Page > children'.

time

  • Status
    title(X)

  • Status
    titleNO

Allows the specification of a period of time to search within.

e.g.: 7d will only allow content modified in the last 7 days.

matchAll

  • Status
    title(X)

  • Status
    titleNO

true

If set to false, content matching any of the criteria will be returned. Otherwise, the content must match all criteria. 

Editor View

  • Not applicable.

...