TextGlossary
Overview
The TextGlossary standard function produces a bulleted glossary of pages built by searching the page body for the tokens passed to the function. It also includes a set of alphabet links to quickly jump to sections.
Prototype
##TextGlossary(string [searchPhrase], integer {Top}, string {styleName})
Parameters
- Name: searchPhrase [Required]
- Type: string
- Description: The search phrase to use for the search query.
- Name: Top {Optional}
- Type: integer
- Default: 1000
- Description: The maximum number of pages to include in the glossary - ordered descending by match score.
- Name: styleName {Optional}
- Type: string
- Default: Full
- Values: list, full
- Description: The style name of the glossary.
- Name: showNamespace {Optional}
- Type: bool
- Default: false
- Description: Whether or not the namespace will be shown as part of the page title.
Examples
##TextGlossary(Wiki help, 10, Full)
See Also
Function Calling Convention
Scope Function
Instruction Function
Standard Function
Related