=== Yahoo BOSS ===
Contributors: picklewagon 
Donate link:http://www.picklewagon.com/wordpress/
Tags: search, yahoo
Requires at least: 2.7
Tested up to: 2.7.1
Stable tag: 0.5

The Yahoo BOSS plugin makes it easy to create a search engine in your WordPress install. This plugin does not replace the default search.

== Description ==

The Yahoo BOSS plugin makes it easy to create a search engine in your WordPress install. Simply activate and configure and youÕre off and running. This plugin does not replace the default search within WordPress.

[Yahoo Search BOSS][1] (Build your Own Search Service) allows you to create a search engine using Yahoo technologies via a REST API. Currently, only web content search (images and news coming soon) is supported. You will need to get your own [BOSS application ID][2] to create your search engine. Use of this plugin subjects you to the [BOSS API Terms of Use][3]. Please read carefully.

In order for your search engine to function correctly, you need to define where you want both the search form and the search results to show. This is done with simple shortcodes that you need to add to a page or pages.

To create the search form add [boss\_search\_form] to a page.

To define where you want your search results use [boss\_search\_results]. Nothing will show if a query hasnÕt been performed.

So the page contents would be the following if you wanted a search form followed by the search results.

[boss\_search\_form]

[boss\_search\_results]

That is all you need to do to create you custom search engine.

 [1]: http://developer.yahoo.com/search/boss/
 [2]: http://developer.yahoo.com/wsregapp/
 [3]: http://info.yahoo.com/legal/us/yahoo/search/bosstos/bosstos-2317.html
	
== Installation ==

1.  Download this plugin.
2.  Upload the plugin to the wp-content/plugins directory on the server where your site is located.
3.  Activate the plugin through the ÔPluginsÕ menu in WordPress
4.  Add your Yahoo BOSS application ID on the configuration page or to wp-config.
5.  Configure as needed.
6.  Create the page(s) where you want the search form and search results using the shortcodes defined above.
7.  Search away!

== Frequently Asked Questions ==

No FAQ at this time.

== Screenshots ==

1. The admin panel

== Other Notes ==

### Administration

You need to modify a few options for the plugin to work correctly.

<span style="text-decoration: underline;">Yahoo App ID</span>: add your [Yahoo BOSS application ID][1] here. This option is required.

<span style="text-decoration: underline;">Results per Page</span>: use to configure how many search results you want to show on each page. Default is 10.

<span style="text-decoration: underline;">Format</span>: the format of the search results. This would be useful if you want to use with AJAX. You must have PHP 5 to use JSON currently. Default is XML.

<span style="text-decoration: underline;">Domains to Search</span>: add site urls here if you want to limit your search to certain sites.

### Extending

Yahoo App ID can be overridden with a defined constant in wp-config.

    define('YAHOO_APP_ID', 'your_app_id_goes_here');

There are some filters available to use.

pw\_boss\_title - applied to the title of the search engine in the search form. Filter function arguments: title.

pw\_boss\_button - applied to the button to initiate the search in the search form. Filter function arguments: button text.

pw\_boss\_stylesheet - applied to the search engine stylesheet to provide your own custom stylesheet. Filter function arguments: default stylesheet.

 [1]: http://developer.yahoo.com/wsregapp/