This is a documentation subpage for Template:Search box. It contains usage information, categories and other content that is not part of the original template page. |
This template creates a simple search box for a page's all subpages, like archives.
Usage
Simple {{search box}}
creates a search box. The scope is all subpages of the tagged page, excluding that page itself.
{{search box |root= / |search-break=<yes|no> |search-width=number |search-button-label=text }}
Parameters
- root
- The target page.
|root=User talk:Example/Archives
will search all subpages of User talk:Example/Archives. The default is the current page name. - noslash
- By default, the target page itself is excluded, by appending a slash "/" to the "root" parameter. If you want to include it, set
noslash=yes
. - search-break
search-break=yes
will insert a break between the search bar and search button. The default is no.
- search-width
- can be used to change the width of the text field, in characters. The default is 22, which fits the search bar with the default box width. Note: this is a bare number with no units.
- search-button-label
- can be used to change the text on the search button. The default is "Search".
Examples
{{search box |root=Wikipedia:FAQ |search-button-label=Search the FAQ}}
produces:
Example 2:
{{search box |root=User:Example |search-break=no |search-width=22 |search-button-label=Search User:Example's pages }}
produces:
Template:Internal search templates common doc