Template:Search

Template documentation

[view] [edit] [history] [purge]

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:

1. 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>
   

2. 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' );
   

3. 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[Edit template data]

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

See also

• es:Plantilla:Buscar - Spanish localization of this template
• User:Sophivorus - Main author of this template

The above documentation is transcluded from Template:Search/doc. (edit | history)
Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.