PDA

View Full Version : Mini Mods - OpenSearch


Spleasure
20 Jun 2006, 15:42
NCODE OPENSEARCH FOR VBULLETIN 3.6.0
version: 1.1

I. What does it do
This plugin adds OpenSearch capabilities to you vBulletin board. OpenSearch is a standard defined by A9.com and defines a unified interface for search engines. The definitions are devided into four parts:

- OpenSearch Description: defines an XML format for describing search services
- OpenSearch Query Syntax: defines the query method and format, which is embedded in the OpenSearch Description file
- OpenSearch Response: defines RSS and ATOM extensions to return machinereadable search results.
- OpenSearch Query: defines a way of referring to a set of search results

This plugin provides a OpenSearch Description file, and thus implements OpenSearch Description and OpenSeach Query Syntax. OpenSearch Response is not implemented, and might get implemented in a future update, when the demand is sufficient, and when vBulletin allows for an easy integration.

This plugin is based around OpenSearch 1.1 Draft 3.

The plugin adds an autodiscovery tag to the <head> section of all pages, as recommended by the OpenSearch Description specification.

The current versions of the two largest browsers will support OpenSearch.
Information about the Internet Explorer 7 implementation can be found on:
http://blogs.msdn.com/ie/archive/2006/02/07/527266.aspx

Firefox 2 has supporting documents on:
http://developer.mozilla.org/en/docs/Creating_OpenSearch_plugins_for_Firefox
Please note that you might run into the following bugs when using Firefox 2:
OpenSearch: plugin not added if description not in utf-8 encoding
https://bugzilla.mozilla.org/show_bug.cgi?id=357830
Work around this bug by not using non-UTF-8 characters in the bbtitle, description
and keywords fields.
Can't use remote search engine icons larger than 10KB
https://bugzilla.mozilla.org/show_bug.cgi?id=361923
Don't use favicon.ico images larger than 10 KB. The default vBulletin icon is sized
9.9 KB and doesn't seem to work as well. However, this icon is a little bugged: it
contains double data (see vB 3.6 bug #716). I have attached an improved favicon.ico
with this plugin.

More on OpenSearch in general can be found on:
http://www.opensearch.org/


II. Installation
Use the product manager in vBulletin to upload the XML file.

III. Configuration
All settings are read from your vBulletin settings.
nCode OpenSearch makes use of the following settings:
- bbtitle
- description
- keywords
- webmasteremail
- languagecode
It also links to your favicon.ico image in the Description file.

In the control panel you'll find fields to alter the SyndicationRight
and AdultContent values of the OpenSearch Description file.
The SyndicationRight value is currently useless, because is controls
the OpenSearch Response part, which isn't implemented. It's provided
for completeness.

IV. Version history
1.1 (February 18th, 2007)
- added correct content-type to XML files
- secured the xml with CDATA sections
- support for the mozilla specific moz:SearchForm tag
- added notices about Firefox 2 bugs in the readme

1.0 (February 16th, 2007)
- Fixed templates

1.0 beta 1 (June 20th, 2006)
- First public release

V. Copyright
please keep in mind that:
THIS IS NOT FREE SOFTWARE

You are allowed to install this in your forum, and you are allowed to make suggestions for improvements. It is not allowed to redistribute the files in any other way than as a zipfile with the XML and this readme in original state.

(c) 2006 nCode - www.ncode.nl (http://www.ncode.nl) - info@ncode.nl

Below you can find screenshots from Internet Explorer 7 and Firefox 2.

Support site:
http://www.ncode.nl/vbulletinplugins/

Like it? Please donate
You can donate by PayPal: USD (https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=jorrit%40ncode%2enl&item_name=nCode%20vBulletin%20Plugins&item_number=ncode_vbulletin&no_shipping=1&cn=Comments&tax=0&currency_code=USD&lc=US&bn=PP%2dDonationsBF&charset=UTF%2d8) or EUR (https://www.paypal.com/cgi-bin/webscr?cmd=_xclick&business=jorrit%40ncode%2enl&item_name=nCode%20vBulletin%20Plugins&item_number=ncode_vbulletin&no_shipping=1&cn=Comments&tax=0&currency_code=EUR&lc=UK&bn=PP%2dDonationsBF&charset=UTF%2d8)

Spleasure
20 Jun 2006, 15:43
Reserved. I hope you like it.

Qwest
20 Jun 2006, 18:30
I still kinda dont get it. From the screenshots it looks like the users can download it??

What does it do exactly? Got a demo?

Spleasure
20 Jun 2006, 18:38
It's nothing special. You can compare it to the auto discovery of RSS feeds on certain sites. The same is done for search functionality, provided you have a compatible browser, which are currently Firefox 2 and Internet Explorer 7. In those browsers you can search the forum directly through the build in search box in the browser toolbar.
I don't have a demo, because I only have 3.6 running on a test forum behind a password. You can set up one easily on your own 3.6 board by importing the XML and visiting your forum with IE7 or FF2.
Again, this is nothing shocking, but rather something for the people who want to support every possible standard out there. I made it just to see if it could be done (quickly), and it could. This morning, I didn't even know I was going to build it :)

waza
20 Jun 2006, 19:06
bedankt ;)

The Free Bird
20 Jun 2006, 19:24
very good

think you

Bad Bunny
20 Jun 2006, 20:17
Interesting. Seems like it would be a neat feature for a large forum where people were very active...but useless for a slower forum. :)

bjs144
25 Jul 2006, 18:11
Fab, was looking around for something like this today.

Many thanks, we might use it here if we move to 3.6.X

Alfa1
14 Oct 2006, 15:46
How does this act in relation to member permissions? If I understand this correctly open search shares search results of the forum member. But if this member has access to restricted forums, will the search results/contents of these restricted forums also be shared trough the open search system?

Spleasure
14 Oct 2006, 15:52
How does this act in relation to member permissions? If I understand this correctly open search shares search results of the forum member. But if this member has access to restricted forums, will the search results/contents of these restricted forums also be shared trough the open search system?

This plugin has nothing to do with storing search results. It just provides another interface to the search system.

Alfa1
14 Oct 2006, 16:40
Aha, I see now. So that means a member with permission to view restricted forums, can not search those forums with this right?

Spleasure
14 Oct 2006, 17:31
Aha, I see now. So that means a member with permission to view restricted forums, can not search those forums with this right?
If he is logged in, he can. The open search query is just redirected to the normal search.php. This just adds the possibility to search from your IE7 or FF2 search bar.

Alfa1
15 Oct 2006, 17:57
Nice. Is it possible to create a search engine for multiple vbulletin sites with this? To search them all with one search query? If so: how?

Spleasure
15 Oct 2006, 18:04
Nice. Is it possible to create a search engine for multiple vbulletin sites with this? To search them all with one search query? If so: how?
Please install the mod and you'll see what it's about. It's nothing more than a redirect to search.php in your vBulletin installation.

Alfa1
15 Oct 2006, 18:18
I know. But would it be possible to somehow combine the results of the search.php from several sites?

Sjakie
11 Feb 2007, 22:39
How do I get my site search to appear in the Firefox search plugin system as shown in your pictures?

Dutch Translation:
Hoe krijg ik die zoekfunctie werkend in Firefox?

Spleasure
16 Feb 2007, 15:53
How do I get my site search to appear in the Firefox search plugin system as shown in your pictures?

Dutch Translation:
Hoe krijg ik die zoekfunctie werkend in Firefox?
Are you using Firefox 2? It should be in the list if you click on the google icon to the left of the search field

Sjakie
16 Feb 2007, 16:29
I've clicked the Google button but nothing appears that seems to have affiliation with my site?? I use firefox 2.0.0.1

Spleasure
16 Feb 2007, 16:32
I've clicked the Google button but nothing appears that seems to have affiliation with my site?? I use firefox 2.0.0.1
Can you give me a link to your forum?

Sjakie
16 Feb 2007, 16:56
http://www.xboxforum.nl

Sjakie
17 Feb 2007, 17:04
I've installed your updated version and now it works. Thanks!

Spleasure
17 Feb 2007, 17:18
Really strange that nobody complained before, because the bug I fixed made the mod practically useless. I forgot to select the right product for two plugins, so these plugins were never in the previous XML file.

Alfa1
17 Feb 2007, 23:07
Do earlier versions of FF and IE support Open Search as well?
2 thumbs up so far. This works like a charm.

Edit: it doesn't let me search restricted forums, that I have access to. I am logged in when searching. Is there a fix for this?

boatdesign
18 Feb 2007, 01:26
Installed the product from the first post within the hour; my forum appeared in the add dropdown for both firefox and IE, but when I clicked to add my forum to the search it did nothing in Firefox 2.x (latest) and in Internet Explorer it produced an error message:
Internet Explorer could not install this search provider.
There was a problem with the search provider's information.

(uninstalled and reinstalled the product to be sure - same result.)

Alfa1
18 Feb 2007, 09:14
Have you checked the settings in your admincp -> vbulletin options -> ncode OpenSearch ?

boatdesign
18 Feb 2007, 09:33
"SyndicationRight" is set to "open" and "AdultContent" is set to "no" -- are there any other settings?

M-Tuning
18 Feb 2007, 10:21
Thanks, Installed and working

Spleasure
18 Feb 2007, 10:43
Installed the product from the first post within the hour; my forum appeared in the add dropdown for both firefox and IE, but when I clicked to add my forum to the search it did nothing in Firefox 2.x (latest) and in Internet Explorer it produced an error message:
Internet Explorer could not install this search provider.
There was a problem with the search provider's information.

(uninstalled and reinstalled the product to be sure - same result.)
Fixed in 1.1

Alfa1
18 Feb 2007, 20:01
Where do i place my favicon.ico?

Spleasure
18 Feb 2007, 20:05
Where do i place my favicon.ico?
In the root of your forum. There should already be a favicon.ico.

boatdesign
18 Feb 2007, 20:36
Fixed in 1.1
Works great now! Thank you!

M-Tuning
04 Apr 2008, 13:40
Just wanted to say it works with 3.7.0 too :)

tmiland
06 Apr 2008, 01:41
Sweet! This works great (3.7.0 RC2):D
*installed* & *nominated*

tazzarkin
25 Jun 2008, 21:16
wow. this is awesome.

DonaldDuck
26 Jun 2008, 06:51
Thanks works but is there a way to set a different title for the search bar ? My forum's name is too long for that ... :-/ ? It is just not good looking - there is a problem with an & in a title too ...

ok found my way - I just changed "bbtitle" ... to what I wanted =)

tazzarkin
28 Jun 2008, 14:43
I keep getting the following error message for firefox and ie:

Could not download the search plugin in from:
"www.mydomainname.com/misc.php?do=page&template=ncode_opensearch"

What would cause this?

-------------------------

fixed it: in the xml file i changed "misc.php?do=page&amp;template=ncode_opensearch"

to:

"{$vbulletin->options[bburl]}/misc.php?do=page&amp;template=ncode_opensearch"

it works great! thanks for this mod!

tpearl5
24 Jul 2008, 19:04
This works for 3.7 by the way. I can't believe more people have not jumped on this. What a great mod!

leodestroy
29 Jan 2009, 21:58
what about vb 3.8.1?

leodestroy
05 Feb 2009, 18:26
Any one can't help with vb 3.8???

terminator2k2
07 Apr 2009, 12:29
works fine till 3.7.6 can't say if it works on the 3.8.x

COBRAws
07 Aug 2009, 20:22
does it work with ff3?

lord_of_chaos
26 Jan 2010, 17:19
Fast fix for vB4 in attachment.

LuisManson
24 Jul 2010, 17:02
Fast fix for vB4 in attachment.

Thanks!!!! testing!