]> The application/opensearchdescription+xml media type xyzzy
Hamburg Germany hmdmhdfmhdjmzdtjmzdtzktdkztdjz@gmail.com http://purl.net/xyzzy/
This memo defines the application/opensearchdescription+xml media type for OpenSearch descriptions. Atom and XHTML <link rel="search" .../> elements are examples where this media type is used. In RFC&rfc.number; is a placeholder for this memo. This note and the document history should be removed before publication. The draft can be discussed on the mailing list.
OpenSearch descriptions are a way to specify the format of search queries and results for a given topic or purpose. The format is supported by various user agents and search engines. Simple OpenSearch descriptions in essence specify the parameters of a Web form for a search query. A link "search" relation as used in Atom , HTML, XHTML, and HTTP allows auto-discovery of OpenSearch descriptions. User agents supporting this feature will offer to "install" the search description, i.e. make it available together with other installed search descriptions independent of the contexts where those descriptions were found. Another way to install OpenSearch descriptions is to use a function such as "AddSearchProvider" supported by some Web browsers. What such "installation" procedures actually do depends on the client software, e.g., they could replace the URI of an icon in the description by an equivalent "data:" URI for privacy and other reasons.
The following example of a "search" relation in the <head> element of an XHTML document allows auto-discovery of an OpenSearch description with title "Demo search" at the URI <http://example.org/demo.xml>:
<link rel="search" href="http://example.org/demo.xml" type="application/opensearchdescription+xml" title="Demo search" />
A script might allow the installation. The following XHTML example links to the OpenSearch description for manual inspection when the "onclick" approach is not supported:
<a href="http://example.org/demo.xml" onclick="window.external.AddSearchProvider( 'http://example.org/demo.xml'); return false" title="Add Search Provider">Demo search</a>
The "AddSearchProvider" function is not specified in this memo. For a discussion of "onclick" event handlers and the HTTP header field Content-Script-Language see a relevant specification, e.g., .
TBD - this is a DRAFT, see "Status of this Memo" above
TBD - this is a DRAFT, see "Status of this Memo" above
TBD - this is a DRAFT, see "Status of this Memo" above
Below you find the registration template for the link "search" relation under : search a related search resource such as an OpenSearch description RFC&rfc.number;
Below you find the registraton template for the subtype "opensearchdescription+xml" of the "application" media type under : application opensearchdescription+xml There are no required parameters. charset (defaults to "UTF-8") Identical to those of "application/xml" as described in ; especially "UTF-8" and its proper subset "US-ASCII" are supposed to work. For non-ASCII documents served as "text/xml" the "charset" parameter is required; this might be relevant when authors are unable to configure the server hosting their OpenSearch descriptions. All general security and privacy considerations for sending queries to servers specified in an URL are applicable. See RFC&rfc.number; for more info. OpenSearch descriptions use the XML name space, optionally in conjunction with other XML name spaces for extensions or for application specific purposes. RFC&rfc.number;, Various search cients including popular Web browsers, search engines, and software libraries support OpenSearch descriptions. TBD TBD COMMON TBD TBD IETF
DeWitt Clinton did not yet accept the idea that he is supposed to be the author or co-author of this memo... ;-)
&rfc3023; &rfc3629; &rfc4288; &rfcLINK; &rfc2397; &rfc3986; &rfc4287; Extensible Markup Language (XML) 1.0 (Second Edition) XHTML 1.0 The Extensible HyperText Markup Language (Second Edition) &xmlname;
Changes in version 01: Move registry cleanup from to the (hopefully) next . Adopt registration template in replacing the similar template. Some background info with examples parked in the introduction. Changes in version 00: This is a kind of template that could be extended to register rel="search" and application/opensearchdescription+xml if the OpenSearch community likes this approach. The change controller for a media type in the standards tree has to be a SDO (Standards Development Organization) recognized by the IESG or IAB on behalf of the IETF community, not necessarily the IETF itself. For atom:link relations IESG review is good enough. Informational IETF RFCs are approved by the IESG in a "document action", this would trigger the IANA considerations in .