Template:Search box/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

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.


See also