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 27 results for "keyword"

Page	Score
User Keywords system	20.621
System Keywords documentation	20.514
Keywords and Categories documentation	20.278
Search Documentation documentation	3.440
Media documentation	3.387
Using MediaPlugin documentation	3.361
Page Metadata Documentation documentation	3.337
Share Links documentation	3.329
Media Management documentation	3.252
Private system	3.198
Plugin Parameter Shortcuts documentation	3.163
Page Status documentation	3.149
Private Pages documentation	3.071
Using SearchPlugin documentation	3.026
Frontmatter documentation	3.017
ValidationManager documentation	2.848
User Documentation system	2.846
Contextual Variables documentation	2.766
ConfigAccessorPlugin documentation	2.582
Page Storage Guide documentation	2.529
Page Private documentation	2.423
Why Use This Platform documentation	2.258
Configuration Properties Reference documentation	2.049
Page Audience documentation	1.663
Using Captures documentation	1.615
Editing a Page documentation	1.448
Using MarqueePlugin documentation	1.289

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). `'current'` self-scopes to this page — see Plugin Parameter Shortcuts
`author`	string	—	Filter by page author (original creator). Use `$currentUser` for the logged-in user — see Plugin Parameter Shortcuts
`editor`	string	—	Filter by last editor. Use `$currentUser` for the logged-in user — see Plugin Parameter Shortcuts
`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 general	14.691
Plugin Guide general	14.689
Plugin documentation	12.810
Plugin Parameter Shortcuts documentation	10.461
Using Current Time Plugin documentation	8.528
Contextual Variables documentation	2.063
Using TotalPagesPlugin documentation	1.968
Using VariablesPlugin documentation	1.959
Geology Demo general	1.934
Geology Demo general	1.934

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 19 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: