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	21.202
System Keywords documentation	21.078
Keywords and Categories documentation	20.855
Media documentation	3.454
Using MediaPlugin documentation	3.452
Search Documentation documentation	3.432
Page Metadata Documentation documentation	3.393
Media Management documentation	3.320
Share Links documentation	3.302
Private system	3.277
Plugin Parameter Shortcuts documentation	3.251
Using SearchPlugin documentation	3.117
Page Status documentation	3.109
Frontmatter documentation	3.107
ValidationManager documentation	2.943
Private Pages documentation	2.939
User Documentation system	2.937
Contextual Variables documentation	2.850
ConfigAccessorPlugin documentation	2.672
Page Storage Guide documentation	2.614
Page Private documentation	2.498
Why Use This Platform documentation	2.282
Configuration Properties Reference documentation	2.089
Page Audience documentation	1.729
Using Captures documentation	1.596
Editing a Page documentation	1.512
Using MarqueePlugin documentation	1.349

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	15.579
Plugin Guide general	15.579
Plugin documentation	13.362
Plugin Parameter Shortcuts documentation	10.938
Using Current Time Plugin documentation	8.939
Contextual Variables documentation	2.149
Using TotalPagesPlugin documentation	2.050
Using VariablesPlugin documentation	2.043
Geology Demo general	2.017
Geology Demo general	2.017

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: