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: |
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
[edit]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
[edit]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
[edit]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:
- Introduction to Lua patterns
- Scribunto ASCII pattern documentation
- Scribunto unicode string pattern documentation
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
[edit]{{string count|page=Wikipedia:Administrators' noticeboard/Incidents|search=admin}}
→ 87{{string count|page=Wikipedia:Administrators' noticeboard/Incidents|search=[Aa]dmin|plain=false}}
→ 125
TemplateData
[edit]TemplateData for String count
Parameter | Description | Type | Status | |
---|---|---|---|---|
Page name | page | The name of the page on Wikipedia to search.
| 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.
| Boolean | suggested |