Network Working Group F. Ellermann
Internet-Draft xyzzy
Intended status: Informational July 3, 2008
Expires: January 4, 2009
The application/opensearchdescription+xml media type
draft-ellermann-opensearch-01
Status of this Memo
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 4, 2009.
Abstract
This memo defines the application/opensearchdescription+xml media
type for OpenSearch descriptions. Atom and XHTML
elements are examples where this media type
is used.
Editorial note
In Section 5 RFCXXXX is a placeholder for this memo. This note and
the document history (Appendix A) should be removed before
publication. The draft can be discussed on the
mailing list.
Ellermann Expires January 4, 2009 [Page 1]
Internet-Draft OpenSearch Description July 2008
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. link rel="search" example . . . . . . . . . . . . . . . . . 3
1.2. AddSearchProvider example . . . . . . . . . . . . . . . . . 3
2. TBD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Internationalization Considerations . . . . . . . . . . . . . . 4
4. Security Considerations . . . . . . . . . . . . . . . . . . . . 4
5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 4
5.1. link rel="search" . . . . . . . . . . . . . . . . . . . . . 4
5.2. application/opensearchdescription+xml . . . . . . . . . . . 4
6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . 6
7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6
7.1. Normative References . . . . . . . . . . . . . . . . . . . 6
7.2. Informative References . . . . . . . . . . . . . . . . . . 6
Appendix A. Document History . . . . . . . . . . . . . . . . . . . 7
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 7
Intellectual Property and Copyright Statements . . . . . . . . . . 8
Ellermann Expires January 4, 2009 [Page 2]
Internet-Draft OpenSearch Description July 2008
1. Introduction
OpenSearch descriptions are a way to specify the format of search
queries and results for a given topic or purpose. The [XML] 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], HTML, XHTML, and
HTTP [I-D.nottingham-http-link-header] 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] for privacy and
other reasons.
1.1. link rel="search" example
The following example of a "search" relation in the element of
an XHTML document allows auto-discovery of an OpenSearch description
with title "Demo search" at the URI :
1.2. AddSearchProvider example
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:
Demo search
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].
Ellermann Expires January 4, 2009 [Page 3]
Internet-Draft OpenSearch Description July 2008
2. TBD
TBD - this is a DRAFT, see "Status of this Memo" above
3. Internationalization Considerations
TBD - this is a DRAFT, see "Status of this Memo" above
4. Security Considerations
TBD - this is a DRAFT, see "Status of this Memo" above
5. IANA Considerations
5.1. link rel="search"
Below you find the [I-D.nottingham-http-link-header] registration
template for the link "search" relation under
:
Relation name: search
Description: a related search resource such as an OpenSearch
description
Reference: RFCXXXX
5.2. application/opensearchdescription+xml
Below you find the [RFC4288] registraton template for the subtype
"opensearchdescription+xml" of the "application" media type under
:
Type name: application
Subtype name: opensearchdescription+xml
Required parameters:
There are no required parameters.
Optional parameters:
charset (defaults to "UTF-8")
Ellermann Expires January 4, 2009 [Page 4]
Internet-Draft OpenSearch Description July 2008
Encoding considerations:
Identical to those of "application/xml" as described
in [RFC3023]; especially "UTF-8" [RFC3629] 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 for more info.
Interoperability considerations:
OpenSearch descriptions use the
XML name
space, optionally in conjunction with other XML name
spaces for extensions or for application specific
purposes.
Published specification:
RFCXXXX,
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
Ellermann Expires January 4, 2009 [Page 5]
Internet-Draft OpenSearch Description July 2008
6. Acknowledgments
DeWitt Clinton did not yet accept the idea that he is supposed to be
the author or co-author of this memo... ;-)
7. References
7.1. Normative References
[RFC3023] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", RFC 3023, January 2001.
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, RFC 3629, November 2003.
[RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and
Registration Procedures", BCP 13, RFC 4288, December 2005.
[I-D.nottingham-http-link-header]
Nottingham, M., "HTTP Header Linking",
draft-nottingham-http-link-header-02 (work in progress),
July 2008.
7.2. Informative References
[RFC2397] Masinter, L., "The "data" URL scheme", RFC 2397,
August 1998.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, January 2005.
[RFC4287] Nottingham, M., Ed. and R. Sayre, Ed., "The Atom
Syndication Format", RFC 4287, December 2005.
[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]
Ellermann Expires January 4, 2009 [Page 6]
Internet-Draft OpenSearch Description July 2008
Tobin, R., Bray, T., Hollander, D., and A. Layman,
"Namespaces in XML 1.0 (Second Edition)", World Wide Web
Consortium Recommendation REC-xml-names-20060816,
August 2006,
.
Appendix A. Document History
Changes in version 01:
o Move registry cleanup from Section 5 to the (hopefully) next
[I-D.nottingham-http-link-header].
o Adopt registration template in [I-D.nottingham-http-link-header]
replacing the similar [RFC4287] template.
o Some background info with examples parked in the introduction.
Changes in version 00:
o 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.
o 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.
o 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 Section 5.
Author's Address
Frank Ellermann
xyzzy
Hamburg, Germany
Email: hmdmhdfmhdjmzdtjmzdtzktdkztdjz@gmail.com
URI: http://purl.net/xyzzy/
Ellermann Expires January 4, 2009 [Page 7]
Internet-Draft OpenSearch Description July 2008
Full Copyright Statement
Copyright (C) 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.
Intellectual Property
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.
Acknowledgment
This document was produced using xml2rfc v1.33 (of
http://xml.resource.org/) from a source in RFC-2629 XML format.
Ellermann Expires January 4, 2009 [Page 8]