Home » Tech Tips » Drupal Tips

Help for the weary Drupal developer: api.drupal.org and drupal.org OpenSearch plugins

Submitted by Mike on Sun, 01/21/2007 - 3:19pm
Posted in



OpenSearch Plug-ins for Drupal.org, Drupal 4.7 API, Drupal 5 API, and Drupal 6 API

I've created some Drupal-specific OpenSearch plugins for Firefox (and IE7, too!). They provide Drupal.org and api.drupal.org search integration in browsers supporting the OpenSearch search plugin protocol.
They are useful when searching for Drupal API routines or other Drupal development subjects. Install them as you would any other OpenSearch plugin...

Note: at present, the API search plugins work best with single words. I need to figure out how to package multi-word searches in the api.drupal.org search URL.

I've tested them in FF 2.0.x and IE7. If you encounter any issues, leave a comment on this page.

FireFox 2 Autodiscovery

Installation

This page contains the necessary autodiscovery entries, so, you need to tell your browser to install them for you.

Installation is fairly straightforward in FireFox and related browsers: just click on the search box icon, and in the drop-down list you should see a list of new search definitions available to be added to your browser (see sidebar image for an example.)

Flash: Drupal 5 Module creates OpenSearch plugin for your site!

Here's a nifty module that creates OpenSearch plugins for your Drupal 5-based site.

Manual Download Links

For those who are so inclined, here are direct download links:
Drupal.org Search
Drupal 4.7 API search
Drupal 5.x API search
Drupal 6.x API search
Drupal HEAD API search


I don't know how to install

Submitted by christefano@drupal.org (not verified) on Mon, 01/22/2007 - 7:13pm.

I don't know how to install them once you've downloaded them ...

I don't know about IE7, but with Firefox the plugins' extensions need to be changed from .xml to .src. Then you can use window.sidebar.addSearchEngine, which is the subject of an article at mozilla.org called Using JavaScript to add new Search Engines.

There are already several OpenSearch plugins for drupal.org at the Mycroft Project. You can look at their JavaScript installer to see how it works.

Thanks for the info

Submitted by Mike on Mon, 01/22/2007 - 8:07pm.

Naturally, Mycroft is the one place I didn't bother looking for an existing search plugin for Drupal. That's ok, I wanted to make them anyway. :D

autodiscovery

Submitted by Pasqualle (not verified) on Fri, 03/09/2007 - 1:41pm.

Just a little issue with the installation.

The Add "Drupal 4.7 API search" and Add "Drupal HEAD API search" options remained in the list after I added them. The Add "Drupal.org" option works fine.

I think it is because they names differ from the installed one:
Drupal 4.7 API search <-> Drupal Api search (4.7)
Drupal HEAD API search <-> Drupal Api search (HEAD)

Firefox 2.0.0.2

Thanks for the plugin..

Fixed?

Submitted by Mike on Sat, 03/10/2007 - 1:02am.

I changed the autodiscovery description to match the name in the XML file. I hope that fixes the problem for you, it seems to have done so for me.

very useful thanks

Submitted by Guest (not verified) on Thu, 08/30/2007 - 2:58am.

very useful thanks

My favorite

Submitted by Sutharsan (not verified) on Tue, 12/18/2007 - 10:41am.

These belong to my favorite tools for Drupal development. Could you make a Drupal 6 API search version.
Very much appreciated!

Drupal 6 version now available

Submitted by Mike on Wed, 05/14/2008 - 7:27am.

I've added a Drupal 6 API version to the page. Enjoy!

Thx!

Submitted by guldi (not verified) on Tue, 05/13/2008 - 11:50pm.

Thanks a lot!
Makes the search much faster!! :)

good instructions?

Submitted by Marjorie (not verified) on Sat, 05/24/2008 - 10:45pm.

would love to use these resources if I could figure out how. Could someone in the know kindly prepare detailed instructions for Firefox-in-windows users? Would be great... thanks.

It's fairly simple...

Submitted by Mike on Sun, 05/25/2008 - 9:16am.

While viewing this page, drag down the FireFox search bar list (click the small down arrow to the left of the search box.) You should then see a list of Drupal search definitions near the bottom of the list, each prefixed with "Add". Select the Drupal search definitions you wish to add, one at a time.

If that doesn't work, then I'm afraid I can't offer much advice other than to refer you to the FireFox documentation or a quick Google search... or the following step-by-step instructions:

How to Add Search Engines to Firefox's Search Box (eHow.com)

How to Add a Custom Search Engine to Firefox's Search Bar (answerbag.com)

Offline Drupal API in iphone

Submitted by Guest (not verified) on Tue, 12/02/2008 - 9:03pm.

Just in case any one needed, offline drupal api in Iphone
Offline Drupal API in iPhone

Fix: update for drupal.org

Submitted by SteveC (not verified) on Thu, 02/26/2009 - 1:36am.

These OpenSearch plugins will not work on the latest version of drupal.org

You need to edit the following in the xml files:

Drupal.org search
Change: template="http://drupal.org/search/node/{searchTerms}"
To: template="http://drupal.org/search/apachesolr_search/{searchTerms}"

Drupal API search
Change: template="http://api.drupal.org/function/{searchTerms}/6"
To: template="http://api.drupal.org/api/search/6/{searchTerms}"

Change the number after 'search/' for specific api versions.