Yii 1.1: Adding Yii Search to Your Browser Search Box

5 followers

The official Yii project site now supports OpenSearch. This means you can customize your browser's search box to enable direct search of the content in yiiframework.com. For example, by entering a Yii class name in the browser's search box, the corresponding class API page will be shown in the browser.

Below we explain how to customize your browser to enable this nice feature.

FireFox

  • Click on the dropdown button on the left of the browser search box.
  • You should see two menu items: Add "Yii API Search" and Add "Yii Site Search".
  • Click on either or both of them to integrate the Yii search into your browser.

Your FireFox browser is now equipped with Yii search. If you enter a keyword (e.g. CController) in its search box, the corresponding Yii search result page will be displayed.

Internet Explorer

  • Click on the dropdown button on the right of the browser search box.
  • Click on the menu item Add Search Providers and choose Yii API Search and/or Yii Site Search.

Your Internet Explorer is now equipped with Yii search. If you enter a keyword (e.g. CController) in its search box, the corresponding Yii search result page will be displayed.

Chrome

You don't need to do anything. To do a Yii search, you do the following steps:

  • Enter yiiframework.com in the browser URL address field and press TAB or SPACE key to toggle Yii API Search.
  • Keep entering the keyword you want to look for and press ENTER. The browser will show the Yii search result page.
  • You can change search access keyword. Right Click in the address bar and select Edit Search Engines and on the next window select Yiisearch and Edit. here you can change access keyword E.G. yii. searching will be able as {keyword}<TAB>{query}

Opera

This requires more work than the above.

  • Go to Yii class reference page.
  • Put cursor on the left column search field and in context menu select create search.
  • Enter yii to the keyword field and save.
  • Close Opera.
  • Go to Opera's profile directory.
  • Open search.ini.
  • Find your search section by searching "yii".
  • Add the following to the end of the section and save.
Suggest Protocol=JSON
Suggest URL=http://www.yiiframework.com/api/suggest/?q={SearchTerm}&json=1

Now restart Opera and try typing yii ca in your address bar.

Maxthon Browser

  • In main Maxthon menu go Tools > Maxthon Setup Center
  • In Setup Center menu select Search
  • In search preferences select Add item
Title: `Yii API Search`
Alias: `yii`
URL: http://yiiframework.com/search/?type=api-suggest&q=%s
  • Now Yii API Search available from Maxthon browser searchbar or simply from addresss bar using yii<SPACE>query. There is no autosuggest ability in Maxthon.

Credits

  • GOsha for his initiative in implementing OpenSearch in yiiframework.com.
  • samdark for his finding in configuring the Yii search in Opera.

Total 1 comment

#2164 report it
Trejder at 2010/11/20 05:14pm
OpenSearch.org

I will only add to interested people that detailed information as long as perfectly written documentation on how to implement OpenSearch in your own project can be found at OpenSearch official website --> http://www.opensearch.org/Home.

Leave a comment

Please to leave your comment.

Write new article
  • Written by: qiang
  • Updated by: GOsha
  • Category: Tips
  • Yii Version: 1.1
  • Votes: +28
  • Viewed: 32,406 times
  • Created on: Nov 13, 2010
  • Last updated: Nov 14, 2010
  • Tags: search