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:

Jump to: A | B | C | D | E | F | G | I | J | K | L | M | P | R | S | T | U | V | W

133 pages

Geology Demo

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:

Jump to: P | U

2 pages

PageIndex

Using IndexPlugin

All pages except those starting with "Index"

[{IndexPlugin exclude='Index.*'}] renders as:

Jump to: A | B | C | D | E | F | G | I | J | K | L | M | P | R | S | T | U | V | W

131 pages

Geology Demo

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