Network Working Group F. Ellermann
Internet-Draft xyzzy
Intended status: Informational June 15, 2008
Expires: December 17, 2008
The application/opensearchdescription+xml media type
draft-ellermann-opensearch-00
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 December 17, 2008.
Abstract
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.
Editorial note
In Section 3 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
<mailto:opensearch@googlegroups.com> mailing list.
Ellermann Expires December 17, 2008 [Page 1]
Internet-Draft OpenSearch Description June 2008
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
2. Internationalization Considerations . . . . . . . . . . . . . . 3
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 3
3.1. atom:link rel="search" . . . . . . . . . . . . . . . . . . 3
3.2. application/opensearchdescription+xml . . . . . . . . . . . 3
4. Security Considerations . . . . . . . . . . . . . . . . . . . . 5
5. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . 5
6. References . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6.1. Normative References . . . . . . . . . . . . . . . . . . . 5
6.2. Informative References . . . . . . . . . . . . . . . . . . 5
Appendix A. Document History . . . . . . . . . . . . . . . . . . . 6
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 6
Intellectual Property and Copyright Statements . . . . . . . . . . 7
Ellermann Expires December 17, 2008 [Page 2]
Internet-Draft OpenSearch Description June 2008
1. Introduction
TBD - this is a DRAFT, see "Status of this Memo" above
2. Internationalization Considerations
TBD - this is a DRAFT, see "Status of this Memo" above
3. IANA Considerations
IANA is asked to create one URL for each registered atom:link
relation below <http://www.iana.org/assignments/relation/> as
specified in [RFC4287] section 4.2.7.2. All existing atom:link
relation templates should get the corresponding URLs, e.g., "current"
at <http://www.iana.org/assignments/relation/current>.
For the remaining registered atom:link relations without template the
corresponding URLs should redirect to the atom:link relation
registry, e.g., for "alternate" the URL
<http://www.iana.org/assignments/relation/alternate> can be
redirected to the atom:link relation registry. For consistency the
URL <http://www.iana.org/assignments/relation/> should be used for
the atom:link registry.
3.1. atom:link rel="search"
Below you find the [RFC4287] registration template for the atom:link
"search" relation under <http://www.iana.org/assignments/relation/>:
Attribute Value: search
Description: TBD
Expected display characteristics:
TBD
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.
3.2. application/opensearchdescription+xml
Below you find the [RFC4288] registraton template for the subtype
"opensearchdescription+xml" of the "application" media type under
<http://www.iana.org/assignments/media-types/application/>:
Ellermann Expires December 17, 2008 [Page 3]
Internet-Draft OpenSearch Description June 2008
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]; 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
<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 and
<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
Ellermann Expires December 17, 2008 [Page 4]
Internet-Draft OpenSearch Description June 2008
Intended usage: COMMON
Restrictions on usage:
TBD
Author: TBD
Change controller:
IETF
4. Security Considerations
TBD - this is a DRAFT, see "Status of this Memo" above
5. Acknowledgments
TBD
6. References
6.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.
[RFC4287] Nottingham, M., Ed. and R. Sayre, Ed., "The Atom
Syndication Format", RFC 4287, December 2005.
[RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and
Registration Procedures", BCP 13, RFC 4288, December 2005.
6.2. Informative References
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
RFC 3986, January 2005.
[W3C.REC-xml-20001006]
Paoli, J., Bray, T., Maler, E., and C. Sperberg-McQueen,
"Extensible Markup Language (XML) 1.0 (Second Edition)",
World Wide Web Consortium FirstEdition REC-xml-20001006,
October 2000,
Ellermann Expires December 17, 2008 [Page 5]
Internet-Draft OpenSearch Description June 2008
<http://www.w3.org/TR/2000/REC-xml-20001006>.
[W3C.REC-xml-names-20060816]
Tobin, R., Hollander, D., Bray, T., and A. Layman,
"Namespaces in XML 1.0 (Second Edition)", World Wide Web
Consortium Recommendation REC-xml-names-20060816,
August 2006,
<http://www.w3.org/TR/2006/REC-xml-names-20060816>.
Appendix A. Document History
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 3.
Author's Address
Frank Ellermann
xyzzy
Hamburg, Germany
Email: hmdmhdfmhdjmzdtjmzdtzktdkztdjz@gmail.com
URI: http://purl.net/xyzzy/
Ellermann Expires December 17, 2008 [Page 6]
Internet-Draft OpenSearch Description June 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 December 17, 2008 [Page 7]