OpenSearch

OpenSearch

OpenSearch

Protocols for syndicating search results

For the OpenSearch fork of Elasticsearch, see OpenSearch (software).

OpenSearch is a collection of technologies that allow the publishing of search results in a format suitable for syndication and aggregation. Introduced in 2005, it is a way for websites and search engines to publish search results in a standard and accessible format.

Quick Facts Internet media type, Developed by ...

OpenSearch was developed by Amazon.com subsidiary A9 and the first version, OpenSearch 1.0, was unveiled by Jeff Bezos at the O'Reilly Emerging Technology Conference on 15 March 2005.[2][3] Draft versions of OpenSearch 1.1 were released during September and December 2005. The OpenSearch specification is licensed by A9 under the Creative Commons Attribution-ShareAlike 2.5 License.[4]

Support

Web browsers that support OpenSearch include Safari,[5] Microsoft Edge,[6] Firefox[7] and Google Chrome.[8]

Mozilla have indicated that they will deprecate OpenSearch search addons in favour of WebExtensions search addons. This will not affect the ability to manually add an OpenSearch engine from a website[9] As of December 5, 2019, search engine add-ons for Firefox that are powered by OpenSearch have been removed from Mozilla Add-ons.

Design

Search suggestions in the German Wikipedia

OpenSearch consists of:

  1. OpenSearch Description files: XML files that identify and describe a search engine.
  2. OpenSearch Query Syntax: describe where to retrieve the search results
  3. OpenSearch RSS (in OpenSearch 1.0) or OpenSearch Response (in OpenSearch 1.1): format for providing open search results.
  4. OpenSearch Aggregators: Sites that can display OpenSearch results.
  5. OpenSearch "Auto-discovery" to signal the presence of a search plugin link to the user and the link embedded in the header of HTML pages

OpenSearch Description Documents list search result responses for the given website/tool. Version 1.0 of the specification only allowed one response, in RSS format; however, version 1.1 provides support for multiple responses, which may be in any format. RSS and Atom are the only ones formally supported by OpenSearch aggregators, however other types, such as HTML are perfectly acceptable.

  • Auto-discovery of an OpenSearch Description Document is available from both HTML and Atom or RSS feed documents via Link relations in the form of <atom:link rel="search" ... /> for Atom feeds[10] or <link rel="search" ... /> for RSS feeds[10] and HTML documents.[11]
  • OpenSearch Description Document must be placed on a web server of the same domain.[12]
  • OpenSearch Description Documents must be served with the application/opensearchdescription+xml Internet media type.[13]

Alternatives

Mozilla Firefox offers a bookmark keyword feature[14] where an occurrence of %s in the bookmark URI gets replaced with the terms typed in the address bar following the initial keyword.

See also

References

  1. [1]
    "OpenSearch 1.1 Draft 6". GitHub. 2019-12-08. Retrieved 2020-05-21.
  2. [2]
    "Speaker Jeffrey P. Bezos". O'Reilly Media. 2005. Archived from the original on 2012-05-04. Retrieved 2020-05-21.
  3. [3]
    Werner, Vogels (15 Mar 2005). "OpenSearch at A9". allthingsdistributed.com. Archived from the original on 13 Mar 2021. Retrieved 9 Mar 2021.
  4. [4]
    "LICENSE.txt". GitHub. 2018-05-31. Retrieved 2020-05-21.
  5. [5]
    "What's New in Safari 8.0". Apple. 2018-02-22. Retrieved 2020-05-21. In OS X, website developers can aid Safari in discovering searchable content by including an OpenSearch description document on their site, [...]
  6. [6]
    "Change your default search engine". Microsoft. 2020-04-16. Retrieved 2020-05-21. However, you can change the default search engine in Microsoft Edge to any site that uses OpenSearch technology
  7. [7]
    "Supporting search suggestions in search plugins". Mozilla. 2019-03-23. Archived from the original on 2021-01-24. Retrieved 2020-05-21. Firefox supports search suggestions in OpenSearch plugins
  8. [8]
    "FAQ for web developers". Archived from the original on 2012-01-01. Retrieved 2020-05-21. By providing an OpenSearch description document (OSDD), you enable Google Chrome to include your site in the list of search engines in the browser.
  9. [9]
    Neiman, Caitlin (2019-10-15). "Search Engine add-ons to be removed from addons.mozilla.org". Mozilla. Retrieved 2020-05-21.
  10. [10]
    "Autodiscovery in RSS/Atom". GitHub. 2019-12-08.
  11. [11]
    "Autodiscovery in HTML/XHTML". GitHub. 2019-12-08.
  12. [12]
    "How to return OpenSearch results from your search engine". Developer how to guide.wiki. 2018-04-14. Retrieved 2020-05-21.
  13. [13]
    "MIME type application/opensearchdescription+xml". GitHub. 2019-12-08.
  14. [14]
    "Bookmarks in Firefox | Firefox Help".
  15. [15]
    "Revision 1525363 | Adding search engines from web pages | MDN". wiki.developer.mozilla.org. Archived from the original on 2020-07-11.
Share this article:

This article uses material from the Wikipedia article OpenSearch, and is written by contributors. Text is available under a CC BY-SA 4.0 International License; additional terms may apply. Images, videos and audio are available under their respective licenses.