Using IndexPlugin
The IndexPlugin generates a dynamic, alphabetically-organised index of all pages, grouped by first letter with jump links to each section. The PageIndex page uses this plugin to display the full platform index. See Plugins for a complete list of available plugins.
Syntax
[{IndexPlugin}] renders as:
133 pages
- Page Attachments
- Page Audience
- Page Chrome Configuration
- Page Content
- Page History
- Page Information
- Page Level Access Control Lists
- Page Metadata Documentation
- Page Private
- Page Statistics
- Page Storage Guide
- Page Title
- PageIndex
- Password Management Guide
- Performance Optimization
- Permissions
- Platform Variables
- Plugin
- Plugin Guide
- Policies, Roles, and Permissions Architecture
- Privacy Notice
- Private
- Private Pages
- Profile Page
- US Volcano Alerts (USGS HANS)
- User Documentation
- User Documentation Pages
- User Keywords
- User Roles and Permissions
- Using AttachPlugin
- Using CalendarPlugin
- Using CommentsPlugin
- Using CounterPlugin
- Using Current Time Plugin
- Using Emoji
- Using FootnotesPlugin
- Using FormPlugin
- Using ImagePlugin
- Using IndexPlugin
- Using InsertPlugin
- Using MarqueePlugin
- Using MediaPlugin
- Using Metrics
- Using RecentChangesPlugin
- Using ReferringPagesPlugin
- Using SearchPlugin
- Using SessionsPlugin
- Using SlideshowPlugin
- Using TotalPagesPlugin
- Using UndefinedPagesPlugin
- Using UptimePlugin
- Using UserLookupPlugin
- Using VariablesPlugin
Parameters
All parameters are optional:
| Parameter | Type | Description |
|---|---|---|
include | regex | Only include pages whose name matches this pattern |
exclude | regex | Exclude pages whose name matches this pattern |
Examples
Only pages starting with "Index"
[{IndexPlugin include='Index.*'}] renders as:
All pages except those starting with "Index"
[{IndexPlugin exclude='Index.*'}] renders as:
131 pages
- Page Attachments
- Page Audience
- Page Chrome Configuration
- Page Content
- Page History
- Page Information
- Page Level Access Control Lists
- Page Metadata Documentation
- Page Private
- Page Statistics
- Page Storage Guide
- Page Title
- Password Management Guide
- Performance Optimization
- Permissions
- Platform Variables
- Plugin
- Plugin Guide
- Policies, Roles, and Permissions Architecture
- Privacy Notice
- Private
- Private Pages
- Profile Page
- US Volcano Alerts (USGS HANS)
- User Documentation
- User Documentation Pages
- User Keywords
- User Roles and Permissions
- Using AttachPlugin
- Using CalendarPlugin
- Using CommentsPlugin
- Using CounterPlugin
- Using Current Time Plugin
- Using Emoji
- Using FootnotesPlugin
- Using FormPlugin
- Using ImagePlugin
- Using InsertPlugin
- Using MarqueePlugin
- Using MediaPlugin
- Using Metrics
- Using RecentChangesPlugin
- Using ReferringPagesPlugin
- Using SearchPlugin
- Using SessionsPlugin
- Using SlideshowPlugin
- Using TotalPagesPlugin
- Using UndefinedPagesPlugin
- Using UptimePlugin
- Using UserLookupPlugin
- Using VariablesPlugin
Regular Expression Patterns
The include and exclude parameters use JavaScript regular expressions:
| Pattern | Matches |
|---|---|
^Test.* | Pages starting with "Test" |
.*Info$ | Pages ending with "Info" |
^[A-M].* | Pages starting with A through M |
.*[0-9]+.* | Pages containing numbers |
Output Format
The plugin renders:
- Jump links — quick navigation to each letter section
- Letter sections — each letter as a heading with pages listed below
- Page links — clickable links to each page
No comments yet.