Template:Book search

From Wikibooks, open books for an open world
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]


Usage[edit source]

Standard parameters[edit source]

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

All parameters[edit source]

{{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: Loupe light.svg)
  • 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[edit source]

Wikitext Display
{{Book search|float=right|style=simple}}
{{Book search|float=center|style=image}}

Loupe light.svg

TemplateData[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Book search

Display input box for searching book contents

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Page placementfloat

Set search field page alignment

Suggested values
left center right
Default
right
Example
left
Linesuggested
CSS classesclass

Define additional CSS classes for bounding box

Lineoptional
Appearancestyle

Select one of two available visual styles for search field

Suggested values
simple image
Default
simple
Example
image
Linerequired
Bounding box widthpx

Define total width of template output

Default
250px
Example
350px
Lineoptional
Search imageimage

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
Fileoptional
Widget background colorbackground

A solid color to serve as the background for the entire search widget, given in hexadecimal notation as #rrggbb

Default
#f9f9f9
Example
#d73f09
Lineoptional
Search modes offeredtype

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
Lineoptional
Exact match buttonbuttonlabel

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
Lineoptional
Full text buttonsearchbuttonlabel

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
Lineoptional
Button placementbreak

Selects between placing search button(s) to the right of input field or centered beneath

Default
yes
Example
no
Auto value
no
Booleanoptional
Search scopeprefix

Defines the point in the Wikibooks index from which to search recursively

Default
{{BOOKNAME}}
Auto value
Page nameoptional
Input field widthwidth

Width of search input field in pixels

Default
250
Example
350
Numberoptional
Placeholder textplaceholder

Text shown faded in input field when empty

Example
Search terms here
Lineoptional

See also[edit source]