SearchList
Overview
The SearchList standard function produces a simple bulleted list of pages built by searching the page body for the tokens passed to the function.
Prototype
##SearchList(string [searchPhrase], string {styleName}, integer {pageSize}, bool {pageSelector}, bool {allowFuzzyMatching})
Parameters
- Name: searchPhrase [Required]
- Type: string
- Description: The search phrase to use for the search query.
- Name: styleName {Optional}
- Type: string
- Default: Full
- Values: list, full
- Description: The style name for the result listing.
- Name: pageSize {Optional}
- Type: integer
- Default: 5
- Description: The number of results per page when paging.
- Name: pageSelector {Optional}
- Type: bool
- Default: true
- Description: Whether to show the page selector (first, previous, next, last).
- Name: allowFuzzyMatching {Optional}
- Type: bool
- Default: false
- Description: Whether the search engine should use fuzzy (non-exact) matching.
- Name: showNamespace {Optional}
- Type: bool
- Default: false
- Description: Whether or not the namespace will be shown as part of the page title.
Examples
##SearchList(Wiki help color)See Also
Function Calling Convention
Scope Function
Instruction Function
Standard Function
Related
- Namespaces - Using and creating namespaces to logically group pages in the wiki.