Creating OpenSearch plugins for Firefox

  • Revision slug: Talk:Creating_OpenSearch_plugins_for_Firefox
  • Revision title: Creating OpenSearch plugins for Firefox
  • Revision id: 80694
  • Created:
  • Creator: Jangirke
  • Is current revision? No
  • Comment /* What to do next with that OpenSearch XML file? */

Revision Content

Privacy?

At creating a OpenSearch plugin for Firefox 2.0 , I have to specify the a URL of the type="application/x-suggestions+json" where the search suggestions are stored.

This causes that the search suggestions are stored on the server. If I do not like this, because of privacy:

1) Can I prevent a plugin to store on a server as User of Firefox ?

2) What ULR do I have to use, that these things are stored locally ?

The "application/x-suggestions+json" URL in your plugin file has nothing to do with where suggestions are stored - it's the URL used to obtain the suggestions. These suggestions are displayed once and then discarded. These kinds of "suggestions" are different from the standard "history" results, which are stored in the user's profile, on disk. gavin 05:50, 31 October 2006 (PST)

What to do next with that OpenSearch XML file?

Cut it down to 3 lines 1.what to do with it from the beginners point of view 2.searchengine 3.how to access searchengine

Can I add the search engine by clicking on a link?

I created a few search engine XML files that work fine when I add them directly from the tool bar. That is, I go to the page where I have defined the auto discovery links to the XML files. Immediately the search box on Firefox gets the blue blinking light. I am then able to "add" the new search engine right there. However, I want to have links on this page where I describe the search engine's functionality. Clicking on the link should add the search engine. What should I do to create those links? Now it just opens up the xml file in the browser.

See Adding search engines from web pages, which is linked to in the third paragraph of this article. gavin 10:54, 9 January 2007 (PST)
Thanks Gavin. That worked.--Godzilla2 15:03, 9 January 2007 (PST)

What's wrong here?

I created an OpenSearch XML file, and it works 100% in IE7 (-shudder-) but whenever I try it in FF it says "This Search Engine isn't supported by FF and can't be installed" - Which is wierd because it follows strict OpenSearch 1.1 format. Loading the XML file directly into FF doesn't highlight any errors, there are no special chars to escape, and I don't even use any of the FF-specific tags so don't need to define the MOZ Namespace. (In fact, when I do, it fails in IE as well!)

Code Snippet:


<?xml version="1.0" encoding="UTF-8"?> <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" > <Url type="text/html" template="http://www.KIWIreviews.co.nz/search/{searchTerms}" /> <ShortName>KIWIreviews</ShortName> <LongName>KIWIreviews Browserbar Search</LongName> <Description>Search through our product and review database for your selected searchterms.</Description> <Tags>New Zealand Product Reviews</Tags> <Developer>KIWIreviews</Developer> <Contact>-valid email address-</Contact> <Attribution>Copyright ©2007 KIWIreviews.co.nz. All rights reserved.</Attribution> <SyndicationRight>limited</SyndicationRight> <AdultContent>false</AdultContent> </OpenSearchDescription>


Is there anything technically wrong with this?

On top of that, I added the autodiscover link to the index page header, yet no autodiscovery. -insert frustrated glare-

Lock?

This page is vandalized very often and doesn't get much useful edits. I suggest we lock it. --Nickolay 15:42, 10 April 2007 (PDT)


I agree. This page gets messed with constantly. I'm going to lock it. If anyone has a legitimate edit to make, let us know and we'll open it up for that. --Sheppy 16:06, 10 April 2007 (PDT)

savely needs to be changed to safely. I'm a new user here and this is my first edit. Nastajus 20:04, 24 July 2007 (PDT)
Fixed the typo, thanks! --Nickolay 10:56, 25 July 2007 (PDT)

Ready2Search moved to new URL;Ready2Search The new guide is Custom Search through Ready2Search. I can't fix by the lock. Delete this message after you finish fixing.

How Search Engines Become "Recommended"?

Is there a need for this page (or some other page) to include some information on how, why and when a search plug-in gets elevated from the full database of plug-ins (http://mycroft.mozdev.org/) to Firefox's primary search plug-in page (https://addons.mozilla.org/en-US/firefox/browse/type:4)? I'm looking for this information myself and was unable to find anything on the topic. --Fold 14:56, 08 June 2007 (GMT)

I suppose, you just need to submit it to AMO as an XPI. Post to dev-apps-firefox, perhaps? --Nickolay 10:56, 25 July 2007 (PDT)
That was wrong:
<gavin|> you need to email the AMO team and ask to have it added, afaik
<gavin|> they dont' accept them as XPIs
<gavin|> I think they have plans to create a more elaborate system for submitting search engines

--Nickolay 14:16, 25 July 2007 (PDT)

Automatic Updates?

In the old Firefox-only Plugins, one could specify an URL and Update Interval to be sure, users get updates for their plugins. Is there anything similar available in OpenSearch? --Andreas Kahl 13:21, 8 September 2007 (PDT)

I suppose, you could package the search plugin in an XPI that gets automatic updates. But your question should really be asked in the newsgroups. --Nickolay 13:22, 9 September 2007 (PDT)

Wikipedia Search Coding

I would like to make a search plugin for my company's Wiki-based knowledge base. I imagine that if I could find the coding for the integrated Wikipedia search, most of the parameters would be the same, and I could just change the addresses. The XML file isn't in the \Mozilla Firefox\searchplugins directory though. Can anyone direct me to a wiki search template so that I could create the search plugin? Ninjatek 18:11, 6 November 2007 (PST)

Can I add the search engine from a local file?

I have created a wellformed XML, but how do I add it from a local file? I made a local .html with a <link... in the <head> and specified the path to the local xml under href= but nothing happened. Is it mandatory to upload the file somewhere?! Surely there must be some easy way to locally just import one or more search engines from xml files?

Revision Source

<h3 name="Privacy.3F">Privacy?</h3>
<p>At creating a OpenSearch plugin for Firefox 2.0 , I have to specify the a URL of the 
type="application/x-suggestions+json" where the search suggestions are stored.
</p><p>This causes that the search suggestions are stored on the server. 
If I do not like this, because of privacy:
</p><p>1) Can I prevent a plugin to store on a server as User of Firefox ?
</p><p>2) What ULR do I have to use, that these things are stored locally ?
</p>
<dl><dd>The "application/x-suggestions+json" URL in your plugin file has nothing to do with where suggestions are stored - it's the URL used to obtain the suggestions. These suggestions are displayed once and then discarded. These kinds of "suggestions" are different from the standard "history" results, which are stored in the user's profile, on disk. <a href="User:GavinSharp">gavin</a> 05:50, 31 October 2006 (PST)
</dd></dl>
<h3 name="What_to_do_next_with_that_OpenSearch_XML_file.3F">What to do next with that OpenSearch XML file?</h3>
<p>Cut it down to 3 lines
1.what to do with it from the beginners point of view
2.searchengine
3.how to access searchengine
</p>
<h3 name="Can_I_add_the_search_engine_by_clicking_on_a_link.3F">Can I add the search engine by clicking on a link?</h3>
<p>I created a few search engine XML files that work fine when I add them directly from the tool bar. That is, I go to the page where I have defined the auto discovery links to the XML files.  Immediately the search box on Firefox gets the blue blinking light.  I am then able to "add" the new search engine right there.  However, I want to have links on this page where I describe the search engine's functionality.  Clicking on the link should add the search engine.  What should I do to create those links?  Now it just opens up the xml file in the browser.
</p>
<dl><dd> See <a href="en/Adding_search_engines_from_web_pages">Adding search engines from web pages</a>, which is linked to in the third paragraph of this article. <a href="User:GavinSharp">gavin</a> 10:54, 9 January 2007 (PST)
</dd></dl>
<dl><dd><dl><dd>Thanks Gavin.  That worked.--<a href="User:Godzilla2">Godzilla2</a> 15:03, 9 January 2007 (PST)
</dd></dl>
</dd></dl>
<h3 name="What.27s_wrong_here.3F"> What's wrong here? </h3>
<p>I created an OpenSearch XML file, and it works 100% in IE7 (-shudder-) but whenever I try it in FF it says "This Search Engine isn't supported by FF and can't be installed" - Which is wierd because it follows strict OpenSearch 1.1 format. Loading the XML file directly into FF doesn't highlight any errors, there are no special chars to escape, and I don't even use any of the FF-specific tags so don't need to define the MOZ Namespace. (In fact, when I do, it fails in IE as well!)
</p><p>Code Snippet:
</p>
<hr>
<p>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" &gt;
&lt;Url type="text/html" template="http://www.KIWIreviews.co.nz/search/{searchTerms}" /&gt;
&lt;ShortName&gt;KIWIreviews&lt;/ShortName&gt;
&lt;LongName&gt;KIWIreviews Browserbar Search&lt;/LongName&gt;
&lt;Description&gt;Search through our product and review database for your selected searchterms.&lt;/Description&gt;
&lt;Tags&gt;New Zealand Product Reviews&lt;/Tags&gt;
&lt;Developer&gt;KIWIreviews&lt;/Developer&gt;
&lt;Contact&gt;-valid email address-&lt;/Contact&gt;
&lt;Attribution&gt;Copyright ©2007 KIWIreviews.co.nz. All rights reserved.&lt;/Attribution&gt;
&lt;SyndicationRight&gt;limited&lt;/SyndicationRight&gt;
&lt;AdultContent&gt;false&lt;/AdultContent&gt;
&lt;/OpenSearchDescription&gt;
</p>
<hr>
<p>Is there anything technically wrong with this?
</p><p>On top of that, I added the autodiscover link to the index page header, yet no autodiscovery. -insert frustrated glare-
</p>
<h3 name="Lock.3F"> Lock? </h3>
<p>This page is vandalized very often and doesn't get much useful edits. I suggest we lock it. --<a href="User:Nickolay">Nickolay</a> 15:42, 10 April 2007 (PDT)
</p><p><br>
I agree.  This page gets messed with constantly.  I'm going to lock it.  If anyone has a legitimate edit to make, let us know and we'll open it up for that. --<a href="User:Sheppy">Sheppy</a> 16:06, 10 April 2007 (PDT)
</p>
<dl><dd> savely needs to be changed to safely. I'm a new user here and this is my first edit. <a href="User:Nastajus">Nastajus</a> 20:04, 24 July 2007 (PDT)
</dd></dl>
<dl><dd><dl><dd> Fixed the typo, thanks! --<a href="User:Nickolay">Nickolay</a> 10:56, 25 July 2007 (PDT)
</dd></dl>
</dd></dl>
<p>Ready2Search moved to new URL;<a class="external" href="http://ready.to/search/en/">Ready2Search</a>
The new guide is <a class="external" href="http://ready.to/search/make/en_make_plugin.htm">Custom Search through Ready2Search</a>. I can't fix by the lock. Delete this message after you finish fixing.
</p>
<h3 name="How_Search_Engines_Become_.22Recommended.22.3F"> How Search Engines Become "Recommended"? </h3>
<p>Is there a need for this page (or some other page) to include some information on how, why and when a search plug-in gets elevated from the full database of plug-ins (http://mycroft.mozdev.org/) to Firefox's primary search plug-in page (https://addons.mozilla.org/en-US/firefox/browse/type:4)?  I'm looking for this information myself and was unable to find anything on the topic. --<a href="User:Fold">Fold</a> 14:56, 08 June 2007 (GMT)
</p>
<dl><dd> I suppose, you just need to submit it to AMO as an XPI. Post to dev-apps-firefox, perhaps? --<a href="User:Nickolay">Nickolay</a> 10:56, 25 July 2007 (PDT)
</dd><dd> That was wrong:
</dd></dl>
<pre class="eval">&lt;gavin|&gt; you need to email the AMO team and ask to have it added, afaik
&lt;gavin|&gt; they dont' accept them as XPIs
&lt;gavin|&gt; I think they have plans to create a more elaborate system for submitting search engines
</pre>
<p>--<a href="User:Nickolay">Nickolay</a> 14:16, 25 July 2007 (PDT)
</p>
<h3 name="Automatic_Updates.3F">Automatic Updates?</h3>
<p>In the old Firefox-only Plugins, one could specify an URL and Update Interval to be sure, users get updates for their plugins. Is there anything similar available in OpenSearch?
--<a href="User:Andreas_Kahl">Andreas Kahl</a> 13:21, 8 September 2007 (PDT)
</p>
<dl><dd> I suppose, you could package the search plugin in an XPI that gets automatic updates. But your question should really be asked in the newsgroups. --<a href="User:Nickolay">Nickolay</a> 13:22, 9 September 2007 (PDT)
</dd></dl>
<h3 name="Wikipedia_Search_Coding">Wikipedia Search Coding</h3>
<p>I would like to make a search plugin for my company's Wiki-based knowledge base. I imagine that if I could find the coding for the integrated Wikipedia search, most of the parameters would be the same, and I could just change the addresses.  The XML file isn't in the \Mozilla Firefox\searchplugins directory though.  Can anyone direct me to a wiki search template so that I could create the search plugin? <a href="User:Ninjatek">Ninjatek</a> 18:11, 6 November 2007 (PST)
</p>
<h3 name="Can_I_add_the_search_engine_from_a_local_file.3F">Can I add the search engine from a local file?</h3>
<p>I have created a wellformed XML, but how do I add it from a local file? I made a local .html with a &lt;link... in the &lt;head&gt; and specified the path to the local xml under href= but nothing happened. Is it mandatory to upload the file somewhere?! Surely there must be some easy way to locally just import one or more search engines from xml files?
</p>
Revert to this revision