| 1 |
********************************************************************
|
| 2 |
D R U P A L M O D U L E
|
| 3 |
********************************************************************
|
| 4 |
Name: opensearchclient.module
|
| 5 |
Author: Robert Douglass <http://www.robshouse.net>
|
| 6 |
|
| 7 |
DESCRIPTION
|
| 8 |
********************************************************************
|
| 9 |
Turns your Drupal site into an OpenSearch client capable of searching
|
| 10 |
3rd party sites that offer OpenSearch RSS feeds. See http://opensearch.a9.com/
|
| 11 |
for more information.
|
| 12 |
|
| 13 |
RSS parsing is handled by the Magpie RSS library. This enables search
|
| 14 |
requests to remote sites to be cached in order to politely limit the amount
|
| 15 |
of overhead and traffic caused.
|
| 16 |
|
| 17 |
DEPENDENCIES
|
| 18 |
********************************************************************
|
| 19 |
This module depends on the search.module being enabled and on the
|
| 20 |
Magpie RSS library available from http://magpierss.sourceforge.net/
|
| 21 |
|
| 22 |
INSTALLATION
|
| 23 |
********************************************************************
|
| 24 |
Download magpierss-0.72.tar.gz
|
| 25 |
http://internap.dl.sourceforge.net/sourceforge/magpierss/magpierss-0.72.tar.gz
|
| 26 |
|
| 27 |
Unpack the archive into the opensearchclient directory so that you have
|
| 28 |
opensearchclient/magpierss-0.72/...
|
| 29 |
|
| 30 |
HOW TO USE THIS MODULES ONCE INSTALLED
|
| 31 |
********************************************************************
|
| 32 |
The module is currently capable of supporting only one search feed.
|
| 33 |
You can pick from a list of feeds at the A9 site:
|
| 34 |
http://opensearch.a9.com/-/search/moreColumns.jsp
|
| 35 |
|
| 36 |
The opensearchclient module should be capable of searching any of the
|
| 37 |
sites listed.
|
| 38 |
|
| 39 |
To configure the module to search a site, you need to determine what the
|
| 40 |
search URL template for that site is, and the corresponding placeholders for the
|
| 41 |
dynamic parts have to be set on the admin/settings/opensearchclient page.
|
| 42 |
|
| 43 |
Available placeholders are:
|
| 44 |
{searchTerms}
|
| 45 |
{startPage}
|
| 46 |
{startIndex}
|
| 47 |
{language}
|
| 48 |
{outputEncoding}
|
| 49 |
{count}
|
| 50 |
|
| 51 |
Here are some examples:
|
| 52 |
|
| 53 |
IceRocket
|
| 54 |
http://blogs.icerocket.com/search?q={searchTerms}&rss=1&os=1&p={startPage}&n={count}
|
| 55 |
|
| 56 |
Koders Source Code Search
|
| 57 |
http://blogs.icerocket.com/search?q={searchTerms}&rss=1&os=1&p={startPage}&n={count}
|
| 58 |
|
| 59 |
Syndic8 RSS and Atom Feed Search
|
| 60 |
http://www.syndic8.com/search_feeds/{startIndex}/{searchTerms}
|
| 61 |
|
| 62 |
A Drupal site with the OpenSearch module installed:
|
| 63 |
http://sitename.com/opensearch/node/{searchTerms}?page={startPage}
|
| 64 |
|
| 65 |
Once you have determined what the URL template for your target search site,
|
| 66 |
enter that value in the OpenSearch URL template field on the admin/settings/opensearchclient
|
| 67 |
page. Give the search a name in the Site name, field, and you should then see
|
| 68 |
an extra tab on your search page. Happy searching!
|
| 69 |
|
| 70 |
ATTENTION NUTCH USERS
|
| 71 |
*********************
|
| 72 |
The Nutch module integrates with the opensearchclient module to provide custom search result
|
| 73 |
rendering for Nutch specific elements (cache, explain, site, etc.)
|
| 74 |
|
| 75 |
http://drupal.org/project/nutch
|
| 76 |
|
| 77 |
Here is an example of a typical Nutch URL template:
|
| 78 |
|
| 79 |
http://www.example.com/opensearch?query={searchTerms}&start={startIndex}&hitsPerSite=2&hitsPerPage=10
|
Parent Directory
| 
Revision Log
| 
Revision Graph