Skip to content

kolzchut/mediawiki-extensions-SearchBoxes

Repository files navigation

Extension:SearchBoxes for MediaWiki

Copyright (C) Dror S. & Kol-Zchut Ltd. Loosely based on Extension:InputBox by Erik Möller.

This MediaWiki extension supplies two types of Bootstrap3-themed search forms:

  • 'standard' - a simple inline search form
  • 'white' - a different design with a white background

Caveats

This extension is very much Kol-Zchut (WikiRights) centric right now. It assumes the presence of Boostrap 3 as well as Skin:Helena (unpublished) along with its global LESS variables.

Usage

This is a tag extension: . The following options are available:

  • 'type': 'standard' (default) / 'white'
  • 'placeholder': a placeholder text for the inputbox
  • 'default': default text in the input box (will hide the placeholder if specified)
  • 'buttonlabel': text for the search button. 'Search' by default.
  • 'labeltext': label for the input field.
  • 'id': an id attribute for the form. Currently unspecified behavior.
  • 'category': a category to filter by. Passed to the search form as "incategory:".
  • 'dir': 'rtl' / 'ltr'. Allows to override the form's default direction.
  • 'internal': 'yes' / 'no' (default) - whether to use 'Special:Search' even if Extension:WRGoogleSearch is on.
  • 'mobile': 'yes' (default) / 'no' - whether to show the form in mobile resolutions (basically Bootstrap's 'hidden-xs')
  • 'fancybutton': 'yes' / 'no' (default) - whether to use Bootstrap's 'btn-default' class
  • 'elementsize': 'small'/'normal' (default)/'large' - translated into Bootstrap 'input-group-lg/sm'.
  • 'hiddenbuttonlabel': 'yes'/'no' (default). Hide the button label (except from screen readers); Bootstrap 'sr-only'.
  • 'widthclasses': Allows the use of any Bootstrap grid options: col-(xs|sm|md|lg)-1..12. e.g.: 'col-sm-12 col-md-8 col-lg-6'.
  • 'inline': 'yes'/'no' (default) - place the form inline.
  • 'inputlength': this is equivalant to the HTML "size" attribute. The default of 0 means "ignored".

Example

<searchbox>
	placeholder=Find information about your rights
	buttonlabel=Search!
	category=rights
	internal=yes
	mobile=no
</searchbox>

Dependencies

Require MediaWiki >= 1.24.

Installation

See the regular installation instructions for MediaWiki extensions.

Configuration

None at this point.

About

MediaWiki extension that adds simple inline search forms

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published