Template:Search box/doc
This is a documentation subpage for Template:Search box. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template creates a simple search box for all a page's 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".
- style
- can be used to style the box with inline CSS.
Examples
{{search box |root=Wikipedia:FAQ |search-button-label=Search the FAQ}}
produces:
Example 2 with |search-width=
:
{{search box |root=User:Example |search-width=22 |search-button-label=Search User:Example's pages }}
produces:
Example 3 with |style=
:
{{search box
|root=User:Example
|search-button-label=Search User:Example's pages
|style=width: fit-content;
}}
produces:
Templates for searching
Search links
A search link stores a query in a link that takes you to live search results for that stored search. They're found on user pages and talk pages. Use one to bring the full feature set of MediaWiki Search, or features of external search engines, to bear on users unfamiliar with their search parameters.
One type of search link is a wikilink with all the capabilities of Search (search box), and with standard wikilink syntax: [[Special:Search/query| label]]. So this search link will (1) navigate: [[Special:search/Wales]] → Special:search/Wales or (2) search: [[Special:search/~Wales | search/~Wales]] → search/~Wales if you prefix a ~ tilde character.
All other search links are made from a template that will build a URL instead of wikilink. A URL can for example can call off-site search engines to search Wikipedia.
- {{Search link}} offers all the capabilities of Searching (search box), plus extra (URL) parameters for combinations of namespaces, and where you can escape the 20-results-per page-limitation, shareable: {{search link | et al | ''label'' | ns4 | ns5 | limit = 123}} → label.
- {{Regex}} – develop an advanced regex search. {{regex | \<--.*--> | label = Articles with comments missing the ! bang character | prefix=0}} → Articles with comments missing the ! bang character
- {{Template usage}} – develop a template regex search, and pinpoint specific template-call details. {{Template usage | Convert | \{{!}}C\{{!}}F | 0 | Articles that convert Celsius to Fahrenheit}} → Articles that convert Celsius to Fahrenheit
- {{ShortSearch}} – create three search links: {{ShortSearch | system operations research}} → WP GWP G (search Wikipedia, "Google" Wikipedia, and Google search)
- {{Wikidata search link}} – creates a Wikidata search link for descriptions, entities, items, properties, etc. → https://www.wikidata.org/w/index.php?search=Universe&title=Special:Search&fulltext=1
See also
- Help:Searching
- Category:Search templates
- MediaWiki:Extension:InputBox § General syntax - how to create your own search box using
<inputbox>...</inputbox>