Template:Search/doc

This is a documentation subpage for Template:Search.
It contains usage information, categories and other content that is not part of the original Template page.

This template is a template gadget. It requires the InlineSearch gadget to work, which is loaded automatically when this template is used.

Use this template to search the wiki and display the results in a wiki page.

See the installation instructions to get it working in your wiki.

Usage

Basic

Markup	Renders as
{{Search\|javascript}}	Searching...

Advanced

Markup

Renders as

{{Search
| query = incategory:JavaScript
| namespace = 2
| limit = 100
| sort = incoming_links_desc
}}

Searching...

Installation

To install this template in your wiki:

Create a template with the following markup. You can choose the template name, parameter names and defaults to suit your wiki.

<includeonly><div class="InlineSearch"
data-search="{{{1|{{{query|}}}}}}"
data-namespace="{{{namespace|}}}"
data-limit="{{{limit|}}}"
data-sort="{{{sort|}}}"
>Searching...</div>[[Category:Gadget:InlineSearch]]</includeonly>

Create MediaWiki:Gadget-InlineSearch.js with the following code:

/**
 * InlineSearch allows to search the wiki and display the results in a wiki page
 * Documentation: https://www.mediawiki.org/wiki/InlineSearch
 * Source code: https://www.mediawiki.org/wiki/MediaWiki:Gadget-Global-InlineSearch.js
 */
mw.loader.load( '//www.mediawiki.org/w/load.php?modules=ext.gadget.Global-InlineSearch' );

Add the following gadget to MediaWiki:Gadgets-definition:

* InlineSearch[ResourceLoader|hidden|default|categories=Gadget:InlineSearch]|InlineSearch.js

Done! Add your template to any page to verify that the installation was successful.

Template data

Use this template to search the wiki and display the results inline

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Query	`query` `1`	Search terms or query	String	required
Namespace	`namespace`	Namespace number to search Example 2	Number	optional
Limit	`limit`	Max search results to show Default 10 Example 100	Number	optional
Sort	`sort`	Sort criteria for search results Suggested values `create_timestamp_asc` `create_timestamp_desc` `incoming_links_asc` `incoming_links_desc` `last_edit_asc` `last_edit_desc` `random` `relevance` Default relevance Example create_timestamp_asc	String	optional