The UndefinedPagesPlugin lists all pages that are linked to on other pages (RED-LINKs) but have not yet been created.
Whenever a page link points to a page that does not exist it becomes a RED-LINK — a red coloured link that takes you to the page creation editor. The UndefinedPagesPlugin scans the entire link graph and collects every such missing page in one place, making it easy to identify content gaps and prioritise which pages to create. See Plugins for a complete list of available plugins.
[{UndefinedPagesPlugin}] renders as:
All parameters are optional:
| Parameter | Type | Default | Description |
|---|---|---|---|
max | integer | unlimited | Maximum number of results to show |
format | string | list | Output format: list, count, or table |
before | string | — | Text/markup placed before each item (list format) |
after | string | — | Text/markup placed after each item (list format) |
include | regex | — | Only show undefined pages whose title matches this pattern |
exclude | regex | — | Hide undefined pages whose title matches this pattern |
showReferring | boolean | false | Expand each entry to show the pages that link to it |
[{UndefinedPagesPlugin format='count'}] renders as:
104
[{UndefinedPagesPlugin max='10'}] renders as:
[{UndefinedPagesPlugin format='table' max='10'}] renders as:
The Referenced By column shows how many pages currently contain a link to each undefined page.
[{UndefinedPagesPlugin showReferring='true' max='5'}] renders as:
Each undefined page is shown as a red create-link with a nested list of the existing pages that link to it — useful for auditing where red links come from so you can either create the missing page or fix the links.
[{UndefinedPagesPlugin include='^Project.*' format='count'}] renders as:
0
| Format | Description |
|---|---|
list | Bulleted list of red create-links (default) |
count | Plain number — total undefined pages on the platform |
table | Table showing page name and how many pages link to it |
Add showReferring='true' to any list or table result to expand the referring page information. count is unaffected.
See Using ReferringPagesPlugin to show pages that link to the current page, Using IndexPlugin for an alphabetical page index, and Plugins for the full list of available plugins.