Template:Book search

Template documentation[view] [edit] [history] [purge]

Usage

Standard parameters

{{Book search|float= |style= }}

All parameters

{{Book search
 | float             =
 | class             =
 | style             =
 | px                =
 | image             =
 | background        =
 | type              =
 | buttonlabel       =
 | searchbuttonlabel =
 | break             =
 | prefix            =
 | width             =
 | placeholder       =
}}

float: left|center|right (default: right)
class: Additional CSS classes
style: simple|image (default: simple, undefined values rendered as image)
- simple: Show only the search box
- image: Add a search icon and grey bounding box
px: Overall template width (default: 250px)
image: Search image (default: )
background: Background color of search widget, in hexadecimal notation #rrggbb (default: #f9f9f9)
Parameters passed to <inputbox>:
- type: search|fulltext (default: fulltext)
  - search: Show additional button for exact match search
  - fulltext: Show Full text search button only
- buttonlabel: Title of 'Exact match' button (default: "Search this book")
- searchbuttonlabel: Title of 'Full text' button (default: "Search this book")
- break: no|yes (default: yes)
  - no: Search button(s) appear to right of input field
  - yes: Search button(s) appear centered below input field
- prefix: Search scope (default: BOOKNAME)
- width: Width of input field in pixels (automatically converted to number of characters) (default: 250)
- placeholder: Define placeholder text displayed in the input field when empty (default "")

Examples

Wikitext

Display

{{Book search|float=right|style=simple}}

{{Book search|float=center|style=image}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Book search

Display input box for searching book contents

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Page placement	`float`	Set search field page alignment Suggested values `left` `center` `right` Default right Example left	Line	suggested
CSS classes	`class`	Define additional CSS classes for bounding box	Line	optional
Appearance	`style`	Select one of two available visual styles for search field Suggested values `simple` `image` Default simple Example image	Line	required
Bounding box width	`px`	Define total width of template output Default 250px Example 350px	Line	optional
Search image	`image`	Image displayed alongside input field to signify purpose (see 'Magnifying glass on book icons' category at Wikimedia Commons for suitable options) Default Loupe light.svg Example BookReader-favicon.svg	File	optional
Widget background color	`background`	A solid color to serve as the background for the entire search widget, given in hexadecimal notation as #rrggbb Default #f9f9f9 Example #d73f09	Line	optional
Search modes offered	`type`	Selection between a widget offering full text search only, or both full text and exact match searches Suggested values `fulltext` `search` Default fulltext Example search	Line	optional
Exact match button	`buttonlabel`	Overrides the default label for the 'Exact match' button ("Search this book") with the value supplied Suggested values `Exact match` `I'm feeling lucky` Default Search this book Example I'm feeling lucky	Line	optional
Full text button	`searchbuttonlabel`	Overrides the default label for the 'Full text search' button ("Search this book") with the value supplied Suggested values `Full text search` `Recursive search` `Thorough search` Default Search this book Example Deep search	Line	optional
Button placement	`break`	Selects between placing search button(s) to the right of input field or centered beneath Default yes Example no Auto value `no`	Boolean	optional
Search scope	`prefix`	Defines the point in the Wikibooks index from which to search recursively Default {{BOOKNAME}} Auto value	Page name	optional
Input field width	`width`	Width of search input field in pixels Default 250 Example 350	Number	optional
Placeholder text	`placeholder`	Text shown faded in input field when empty Example Search terms here	Line	optional