Using SearchPlugin

The SearchPlugin embeds search results directly in pages.

Description

Use this plugin to display search results within page content. You can search by text query, filter by category, keywords, author, or editor, and choose various output formats. Great for creating dynamic index pages, dashboards, and personal contribution summaries. See Plugins for a complete list of available plugins.

Syntax

[{Search query='keyword'}] renders as:

Found 22 results for "keyword"

Page	Score
User Keywords system	20.722
System Keywords documentation	20.614
Keywords and Categories documentation	20.340
Search Documentation documentation	3.471
Media documentation	3.418
Using MediaPlugin documentation	3.396
Page Metadata Documentation documentation	3.371
Media Management documentation	3.316
Private system	3.220
Private Pages documentation	3.108
Using SearchPlugin documentation	3.082
Frontmatter documentation	3.056
ValidationManager documentation	2.890
User Documentation system	2.838
ConfigAccessorPlugin documentation	2.623
Page Storage Guide documentation	2.570
Page Private documentation	2.460
Why Use This Platform documentation	2.299
Configuration Properties Reference documentation	2.094
Page Audience documentation	1.698
Editing a Page documentation	1.483
Using MarqueePlugin documentation	1.322

Parameters

Parameter	Type	Default	Description
`query`	string	`*`	Search text (`*` for all pages)
`system-category`	string	—	Filter by system category
`user-keywords`	string	—	Filter by keywords (pipe-separated OR logic)
`author`	string	—	Filter by page author (original creator). Use `$currentUser` for the logged-in user
`editor`	string	—	Filter by last editor. Use `$currentUser` for the logged-in user
`max`	number	`50`	Maximum results (0 = unlimited)
`pageSize`	number	`0`	Results per page — enables pagination (0 = disabled)
`page`	number	`1`	Current page number (also read from `?page=` query string)
`format`	string	`table`	Output format: `table`, `count`, `titles`, `list`

Output Formats

Format	Description
`table`	Full table with page names and scores (default)
`count`	Just the number of results (inline-friendly)
`titles`	Bullet list with links
`list`	Simple list of page names without links

Examples

Basic Text Search

[{Search query='plugin' max=10}] renders as:

Found 10 results for "plugin"

Page	Score
Plugin Guide addon	11.665
Plugin Guide addon	11.665
Plugin documentation	11.107
Using Current Time Plugin documentation	7.399
Using TotalPagesPlugin documentation	1.711
Using VariablesPlugin documentation	1.705
Geology Demo addon	1.689
Geology Demo addon	1.689
Page Content documentation	1.688
Using UptimePlugin documentation	1.681

All Pages in a Category

[{Search system-category='documentation' max=5}] renders as:

Found 5 results in category: documentation

Page	Score
Administrator documentation	1.000
AKA documentation	1.000
Asset documentation	1.000
Attachments documentation	1.000
Author Lock documentation	1.000

Count Format (inline)

There are [{Search system-category='system' format='count'}] system pages — renders as:

There are 18 system pages.

Titles Format

[{Search system-category='documentation' format='titles' max=8}] renders as:

Multiple Keywords (OR logic)

[{Search user-keywords='economics|geology' format='titles' max=5}] renders as:

Filter by Author

[{Search author='system' format='titles' max=5}] renders as:

My Pages (Author = Current User)

[{Search author='$currentUser' format='titles' max=10}] renders as:

Please log in to see your contributions.

Pages I Last Edited

[{Search editor='$currentUser' format='titles' max=10}] renders as: