Template:String count/doc

This is a documentation subpage for Template:String count.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:String (sandbox)
Module:Page (sandbox)

This template counts the number of strings on the specified page. It uses the most recent saved version of a page, so if used on the current page it will not work correctly in preview mode.

Usage

Plain search

{{string count|page=page|search=text to search for}}

Search with Lua patterns

{{string count|page=page|search=pattern to search for|plain=false}}

Parameters

page - the page to search on.
search - the string or Lua pattern to search for.
plain - set to "false" to search with a Lua pattern instead of plain text.

Lua patterns

A Lua pattern is a special string that can match several different strings. For people who know regular expressions, Lua patterns are similar, but more limited. See the following documentation for how to construct patterns:

Note: This module uses Unicode-safe Scribunto functions, so there is no need to make special exceptions for Unicode characters. However, some character classes may behave differently to the ASCII pattern character classes, so see the Unicode string pattern documentation for the most accurate description.

Examples

{{string count|page=Wikipedia:Administrators' noticeboard/Incidents|search=admin}} → 0
{{string count|page=Wikipedia:Administrators' noticeboard/Incidents|search=[Aa]dmin|plain=false}} → 0

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:String count in articles based on its TemplateData.

TemplateData for String count

This template counts the number of strings on the specified page.

Parameter		Description	Type	Status
Page name	`page`	The name of the page on Wikipedia to search. Example Wikipedia:Administrators' noticeboard/Incidents	Page name	required
Search Query	`search`	What to search for on the specified page	Unbalanced wikitext	required
Plain text?	`plain`	Is the search query plain text? If not, it is treated as a Lua patten. Default true	Boolean	suggested