Allow/Block Page Elements

Description

Control which page elements can be used on a page by adding them to either a blocklist or an allowlist.

Configuration options:

Required

(with optional parameter values)

Use the picker to choose elements that must be present on pages. If a page does not use these elements, a quality issue will appear in the report. All elements added to this list will also automatically be added to the allowlist.

You can narrow the focus of this rule to elements using a specific configuration by specifying parameters and search for specific values.

Allowlist

(with optional parameter values)

Use the picker to choose the elements that are allowed to be used. Every macro not chosen will be marked as a quality issue in the report.

You can narrow the focus of this rule to elements using a specific configuration by specifying parameters and search for specific values.

For instance, if you would prefer that

Blocklist

(with optional parameter values)

Use the picker to choose macros that should not be used. Each use of the macros in the list will be marked as a quality issue in the report.

You can narrow the focus of this rule to elements using a specific configuration by specifying parameters and search for specific values.

Advanced Mode Example Settings

YAML

# Require every page to have an Excerpt element

rule: elements
level: major
disabled: false
checkMacros: true
checkElements: true
required:
  - element: excerpt
    parameters: {}
description: We require every in this space to have an Excerpt element, please add one.

# Warn users not to use specific configurations within a page element

rule: elements
level: major
disabled: false
checkMacros: true
checkElements: true
blocked:
  - element: contributors
    parameters:
      mode:
        - list
description: Don't display contributors as a list, always use inline.