content-filter

{content-filter}

Plugin: Reporting Plugin, from version 1.0

This filter will ensure that the specified 'prefix:key' value matches the required Confluence content value.

Description

This macro must be used within a reporter macro. It will check if the specified key chain value matches the criteria, such as its space, type, scope or labels. These options are very similiar to those provided by the content-reporter, but can be used in other contexts.

Usage

{content-filter:prefix:key|space=[space keys]|types=[types]|scope=[page scopes]|labels=[labels]}

Parameters

Name Required Default Description
[default]/key
The key value to filter on. May be '@self' to filter on the current report item.
space(s)
@self
The 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.
  • @all - All spaces, both global and personal.
  • SPACE KEY - Any other space key may be specified explicitly.
type(s)
all
The 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
scope
List of pages, news items, etc. which are in scope. If the content is a page, the scope can be expanded to their children, descendents or ancestors:
  • > children - The direct children of the specified page. E.g. 'scope=My Page > children'
  • > descendents - All descendents of the specified page. E.g. 'scope="My Page" > descendents'
  • > ancestors - All ancestors of the specified page. E.g. 'scope=My Page > ancestors'
label(s)
List of label checks. E.g. "one, +two, -three" would list content which had the "two" label but not the "three" label.
matchAll
true
If set to 'false', content matching any of the criteria will be matched.

Examples

Display all children with the 'foo' label

{report-list}
  {local-reporter:content:children}
    {text-sort:content:title}
    {content-filter:@self|labels=+foo}
  {local-reporter}

  {report-body}{report-info:content:title|link=true}{report-body}

{report-list}

See Also

Labels

filter filter Delete
macro macro Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.