| xmonad-contrib-0.8.1: Third party extensions for xmonad | Source code | Contents | Index

XMonad.Actions.Search

Contents

Usage
Use case: searching with a submap

Description
Synopsis

search :: Browser -> Site -> Query -> X ()
data SearchEngine = SearchEngine Name Site
searchEngine :: Name -> Site -> SearchEngine
promptSearch :: XPConfig -> SearchEngine -> X ()
promptSearchBrowser :: XPConfig -> Browser -> SearchEngine -> X ()
selectSearch :: SearchEngine -> X ()
selectSearchBrowser :: Browser -> SearchEngine -> X ()
amazon :: SearchEngine
codesearch :: SearchEngine
dictionary :: SearchEngine
google :: SearchEngine
hoogle :: SearchEngine
imdb :: SearchEngine
maps :: SearchEngine
mathworld :: SearchEngine
scholar :: SearchEngine
thesaurus :: SearchEngine
wayback :: SearchEngine
wikipedia :: SearchEngine
youtube :: SearchEngine

Usage

This module is intended to allow easy access to databases on the Internet through xmonad's interface. The idea is that one wants to run a search but the query string and the browser to use must come from somewhere. There are two places the query string can come from - the user can type it into a prompt which pops up, or the query could be available already in the X Windows copy/paste buffer (perhaps you just highlighted the string of interest).

Thus, there are two main functions: `promptSearch`, and `selectSearch` (implemented using the more primitive `search`). To each of these is passed an engine function; this is a function that knows how to search a particular site.

For example, the `google` function knows how to search Google, and so on. You pass `promptSearch` and `selectSearch` the engine you want, the browser you want, and anything special they might need; this whole line is then bound to a key of you choosing in your xmonad.hs. For specific examples, see each function. This module is easily extended to new sites by using `searchEngine`.

The currently available search engines are:

- `amazon` -- Amazon keyword search.
- `codesearch` -- Google Labs Code Search search.
- `dictionary` -- dictionary.reference.com search.
- `google` -- basic Google search.
- `hoogle` -- Hoogle, the Haskell libraries search engine.
- `imdb` -- the Internet Movie Database.
- `maps` -- Google maps.
- `mathworld` -- Wolfram MathWorld search.
- `scholar` -- Google scholar academic search.
- `thesaurus` -- thesaurus.reference.com search.
- `wayback` -- the Wayback Machine.
- `wikipedia` -- basic Wikipedia search.
- `youtube` -- Youtube video search.

Feel free to add more!

search :: Browser -> Site -> Query -> X () | Source

Given a browser, a search engine, and a search term, perform the requested search in the browser.

data SearchEngine | Source

Constructors

SearchEngine Name Site |

searchEngine :: Name -> Site -> SearchEngine | Source

Given a base URL, create the `SearchEngine` that escapes the query and appends it to the base. You can easily define a new engine locally using exported functions without needing to modify XMonad.Actions.Search:

     myNewEngine = searchEngine "site" "http://site.com/search="

The important thing is that the site has a interface which accepts the escaped query string as part of the URL. Alas, the exact URL to feed searchEngine varies from site to site, often considerably, so there's no general way to cover this.

Generally, examining the resultant URL of a search will allow you to reverse-engineer it if you can't find the necessary URL already described in other projects such as Surfraw.

promptSearch :: XPConfig -> SearchEngine -> X () | Source

Like `search`, but in this case, the string is not specified but grabbed from the user's response to a prompt. Example:

     , ((modm, xK_g), promptSearch greenXPConfig google)

This specializes promptSearchBrowser by supplying the browser argument as supplied by `getBrowser` from XMonad.Prompt.Shell.

promptSearchBrowser :: XPConfig -> Browser -> SearchEngine -> X () | Source

Like `search`, but for use with the output from a Prompt; it grabs the Prompt's result, passes it to a given searchEngine and opens it in a given browser.

selectSearch :: SearchEngine -> X () | Source

Like `search`, but for use with the X selection; it grabs the selection, passes it to a given searchEngine and opens it in the default browser . Example:

     , ((modm .|. shiftMask, xK_g), selectSearch google)

This specializes selectSearchBrowser by supplying the browser argument as supplied by `getBrowser` from XMonad.Prompt.Shell.

selectSearchBrowser :: Browser -> SearchEngine -> X () | Source

Like `search`, but for use with the X selection; it grabs the selection, passes it to a given searchEngine and opens it in a given browser.

amazon :: SearchEngine | Source

codesearch :: SearchEngine | Source

dictionary :: SearchEngine | Source

google :: SearchEngine | Source

hoogle :: SearchEngine | Source

imdb :: SearchEngine | Source

maps :: SearchEngine | Source

mathworld :: SearchEngine | Source

scholar :: SearchEngine | Source

thesaurus :: SearchEngine | Source

wayback :: SearchEngine | Source

wikipedia :: SearchEngine | Source

youtube :: SearchEngine | Source

Use case: searching with a submap

In combination with XMonad.Actions.Submap you can create a powerful and easy way to search without adding a whole bunch of bindings.

First import the necessary modules:

     import qualified XMonad.Prompt         as P
     import qualified XMonad.Actions.Submap as SM
     import qualified XMonad.Actions.Search as S

Then add the following to your key bindings:

     ...
     -- Search commands
     , ((modm, xK_s), SM.submap $ searchEngineMap $ S.promptSearch P.defaultXPConfig)
     , ((modm .|. shiftMask, xK_s), SM.submap $ searchEngineMap $ S.selectSearch)

     ...

     searchEngineMap method = M.fromList $
           [ ((0, xK_g), method S.google)
           , ((0, xK_h), method S.hoogle)
           , ((0, xK_w), method S.wikipedia)
           ]

Make sure to set firefox to open new pages in a new window instead of in a new tab: `Firefox -> Edit -> Preferences -> Tabs -> New pages should be opened in...`

Now mod-s + g/h/w prompts you for a search string, then opens a new firefox window that performs the search on Google, Hoogle or Wikipedia respectively.

If you select something in whatever application and hit mod-shift-s + g/h/w it will search the selected string with the specified engine.

Happy searching!

Produced by Haddock version 2.4.2