| TOC |
|
By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79.
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress.”
The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt.
The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html.
This Internet-Draft will expire on January 5, 2009.
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 Section 5 (IANA Considerations) RFCXXXX is a placeholder for this memo. This note and the document history (Document History) should be removed before publication. The draft can be discussed on the mailto:opensearch@googlegroups.com mailing list.
1.
Introduction
1.1.
link rel="search" example
1.2.
AddSearchProvider example
2.
TBD
3.
Internationalization Considerations
4.
Security Considerations
5.
IANA Considerations
5.1.
link rel="search"
5.2.
application/opensearchdescription+xml
6.
Acknowledgments
7.
References
7.1.
Normative References
7.2.
Informative References
Appendix A.
Document History
§
Author's Address
§
Intellectual Property and Copyright Statements
| TOC |
OpenSearch descriptions are a way to specify the format of search queries and results for a given topic or purpose. The [XML] (Paoli, J., Bray, T., Maler, E., and C. Sperberg-McQueen, “Extensible Markup Language (XML) 1.0 (Second Edition),” October 2000.) 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 [RFC4287] (Nottingham, M., Ed. and R. Sayre, Ed., “The Atom Syndication Format,” December 2005.), HTML, XHTML, and HTTP [I‑D.nottingham‑http‑link‑header] (Nottingham, M., “Web Linking,” April 2010.) 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 [RFC2397] (Masinter, L., “The "data" URL scheme,” August 1998.) for privacy and other reasons.
| TOC |
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" />
| TOC |
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., [XHTML] (Pemberton, S., “XHTML 1.0 The Extensible HyperText Markup Language (Second Edition),” August 2002.).
| TOC |
TBD - this is a DRAFT, see "Status of this Memo" above
| TOC |
TBD - this is a DRAFT, see "Status of this Memo" above
| TOC |
TBD - this is a DRAFT, see "Status of this Memo" above
| TOC |
| TOC |
Below you find the [I‑D.nottingham‑http‑link‑header] (Nottingham, M., “Web Linking,” April 2010.) registration template for the link "search" relation under http://www.iana.org/assignments/relation/:
- Relation name:
- search
- Description:
- a related search resource such as an OpenSearch description
- Reference:
- RFCXXXX
| TOC |
Below you find the [RFC4288] (Freed, N. and J. Klensin, “Media Type Specifications and Registration Procedures,” December 2005.) registraton template for the subtype "opensearchdescription+xml" of the "application" media type under http://www.iana.org/assignments/media-types/application/:
- Type name:
- application
- Subtype name:
- opensearchdescription+xml
- Required parameters:
- There are no required parameters.
- Optional parameters:
- charset (defaults to "UTF-8")
- Encoding considerations:
- Identical to those of "application/xml" as described in [RFC3023] (Murata, M., St. Laurent, S., and D. Kohn, “XML Media Types,” January 2001.); especially "UTF-8" [RFC3629] (Yergeau, F., “UTF-8, a transformation format of ISO 10646,” November 2003.) 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.- Security considerations:
- All general security and privacy considerations for sending queries to servers specified in an URL are applicable. See RFCXXXX Section 4 (Security Considerations) for more info.
- Interoperability considerations:
- OpenSearch descriptions use the http://a9.com/-/spec/opensearch/1.1/ XML name space, optionally in conjunction with other XML name spaces for extensions or for application specific purposes.
- Published specification:
- RFCXXXX, http://www.opensearch.org/Specifications
- Applications that use this media type:
- Various search cients including popular Web browsers, search engines, and software libraries support OpenSearch descriptions.
- Additional information:
- TBD
- Person & email address to contact for further information:
- TBD
- Intended usage:
- COMMON
- Restrictions on usage:
- TBD
- Author:
- TBD
- Change controller:
- IETF
| TOC |
DeWitt Clinton did not yet accept the idea that he is supposed to be the author or co-author of this memo... ;-)
| TOC |
| TOC |
| [RFC3023] | Murata, M., St. Laurent, S., and D. Kohn, “XML Media Types,” RFC 3023, January 2001 (TXT). |
| [RFC3629] | Yergeau, F., “UTF-8, a transformation format of ISO 10646,” STD 63, RFC 3629, November 2003 (TXT). |
| [RFC4288] | Freed, N. and J. Klensin, “Media Type Specifications and Registration Procedures,” BCP 13, RFC 4288, December 2005 (TXT). |
| [I-D.nottingham-http-link-header] | Nottingham, M., “Web Linking,” draft-nottingham-http-link-header-09 (work in progress), April 2010 (TXT). |
| TOC |
| [RFC2397] | Masinter, L., “The "data" URL scheme,” RFC 2397, August 1998 (TXT, HTML, XML). |
| [RFC3986] | Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” STD 66, RFC 3986, January 2005 (TXT, HTML, XML). |
| [RFC4287] | Nottingham, M., Ed. and R. Sayre, Ed., “The Atom Syndication Format,” RFC 4287, December 2005 (TXT, HTML, XML). |
| [XML] | Paoli, J., Bray, T., Maler, E., and C. Sperberg-McQueen, “Extensible Markup Language (XML) 1.0 (Second Edition),” World Wide Web Consortium Recommendation REC-xml-20001006, October 2000. |
| [XHTML] | Pemberton, S., “XHTML 1.0 The Extensible HyperText Markup Language (Second Edition),” World Wide Web Consortium Recommendation REC-xhtml1-20020801, August 2002. |
| [W3C.REC-xml-names-20060816] | Hollander, D., Layman, A., and T. Bray, “Namespaces in XML 1.0 (Second Edition),” World Wide Web Consortium FirstEdition REC-xml-names-20060816, August 2006 (HTML). |
| TOC |
Changes in version 01:
Changes in version 00:
| TOC |
| Frank Ellermann | |
| xyzzy | |
| Hamburg, Germany | |
| Email: | hmdmhdfmhdjmzdtjmzdtzktdkztdjz@gmail.com |
| URI: | http://purl.net/xyzzy/ |
| TOC |
Copyright © The IETF Trust (2008).
This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.
This document and the information contained herein are provided on an “AS IS” basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.
Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.
The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.
This document was produced using xml2rfc v1.35 (of http://xml.resource.org/) from a source in RFC-2629 XML format.