View source for Template:Search box/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This template creates a simple search box for a page's all subpages, like archives.

=== Usage ===
Simple {{tnull|search box}} creates a search box. The scope is all subpages of the tagged page, ''excluding'' that page itself.

<pre>
{{search box
 |root= /
 |search-break=<yes|no>
 |search-width=number
 |search-button-label=text
}}
</pre>

===Parameters===
;root: The target page. <code><nowiki>|root=User talk:Example/Archives</nowiki></code> 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 <code><nowiki>noslash=yes</nowiki></code>.
;search-break: <code><nowiki>search-break=yes</nowiki></code> will insert a break between the search bar and search button. The default is no.  
{{search box
 |search-break=no
}}
{{search box
 |search-break=yes
}}
;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===
<pre>{{search box |root=Wikipedia:FAQ |search-button-label=Search the FAQ}}
</pre> produces: {{search box |root=Wikipedia:FAQ |search-button-label=Search the FAQ}}

Example 2:
<pre>
{{search box
 |root=User:84User
 |search-break=no
 |search-width=22
 |search-button-label=Search 84user's pages
}}
</pre> produces: {{search box
 |root=User:84User
 |search-break=no
 |search-width=44
 |search-button-label=Search User:84user's pages
}}

{{Internal search templates common doc|append=
* [[:commons:Template:search box]] - Wikimedia Commons template that does the same thing}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Archival templates]]
[[Category:Search templates]]
[[Category:Box templates]]
[[Category:User namespace templates]]

[[ja:Template:検索窓]]
}}</includeonly>