| 1 |
wakaba |
1.1 |
<!DOCTYPE html> |
| 2 |
|
|
<html lang="en" class="formal-specification status-work-in-progress"> |
| 3 |
|
|
<head> |
| 4 |
|
|
<title>Auto-Discovery Auto-Discovery Specification</title> |
| 5 |
|
|
<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/spec.css"> |
| 6 |
|
|
<link rel="license" href="http://suika.fam.cx/c/gnu/fdl"> |
| 7 |
|
|
</head> |
| 8 |
|
|
<body class="has-abstract"> |
| 9 |
|
|
|
| 10 |
|
|
<div class="header"> |
| 11 |
|
|
<h1>Auto-Discovery Auto-Discovery Specification</h1> |
| 12 |
wakaba |
1.3 |
<h2>Working Draft 7 April 2007</h2> |
| 13 |
wakaba |
1.1 |
|
| 14 |
|
|
<dl class="versions-uri"> |
| 15 |
|
|
<dt>This Version</dt> |
| 16 |
|
|
<dd><code class="URI"><<a href="http://suika.fam.cx/www/2006/auto-discovery" |
| 17 |
|
|
>http://suika.fam.cx/www/2006/auto-discovery</a>></code></dd> |
| 18 |
|
|
<dt>Latest Version</dt> |
| 19 |
|
|
<dd><code class="URI"><<a href="http://suika.fam.cx/www/2006/auto-discovery" |
| 20 |
|
|
>http://suika.fam.cx/www/2006/auto-discovery</a>></code></dd> |
| 21 |
|
|
<!-- |
| 22 |
|
|
<dt>Latest Working Draft</dt> |
| 23 |
|
|
<dd><code class="URI"><<a href="http://suika.fam.cx/www/2006/auto-discovery" |
| 24 |
|
|
>http://suika.fam.cx/www/2006/auto-discovery</a>></code></dd> |
| 25 |
|
|
--> |
| 26 |
|
|
<!-- <dt>Previous Version</dt> --> |
| 27 |
|
|
</dl> |
| 28 |
wakaba |
1.3 |
<dl class="authors" id="author"> |
| 29 |
wakaba |
1.1 |
<dt>Author</dt> |
| 30 |
|
|
<dd><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a> |
| 31 |
|
|
<code class="mail"><<a href="mailto:w@suika.fam.cx" rel="author" |
| 32 |
|
|
>w@suika.fam.cx</a>></code></dd> |
| 33 |
|
|
</dl> |
| 34 |
|
|
|
| 35 |
wakaba |
1.3 |
<p class="copyright" lang="en">© 2006, 2007 <a |
| 36 |
wakaba |
1.1 |
href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>. |
| 37 |
|
|
Permission is granted to copy, distribute and/or modify this document |
| 38 |
|
|
under the terms of the <a rel="license" |
| 39 |
|
|
href="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation License</a>, |
| 40 |
|
|
Version 1.2 |
| 41 |
|
|
or any later version published by the <a |
| 42 |
|
|
href="http://www.fsf.org/">Free Software Foundation</a>; |
| 43 |
|
|
with no Invariant Sections, no Front$B!>(BCover Texts, and no Back$B!>(BCover |
| 44 |
|
|
Texts. A copy of the license is |
| 45 |
|
|
available at <code class="URI"><<a |
| 46 |
|
|
href="http://www.gnu.org/copyleft/fdl.html" |
| 47 |
|
|
rel="license">http://www.gnu.org/copyleft/fdl.html</a>></code>.</p> |
| 48 |
|
|
</div> |
| 49 |
|
|
|
| 50 |
|
|
<div id="abstract" class="section"> |
| 51 |
|
|
<h2>Abstract</h2> |
| 52 |
|
|
|
| 53 |
|
|
<div class="ed issue">...</div> |
| 54 |
|
|
|
| 55 |
|
|
</div> |
| 56 |
|
|
|
| 57 |
|
|
<div id="status" class="section"> |
| 58 |
|
|
<h2>Status of This Document</h2> |
| 59 |
|
|
|
| 60 |
wakaba |
1.3 |
<p><em>This section describes the status of this document |
| 61 |
|
|
at the time of its publication. Other documents |
| 62 |
|
|
might supersede this document.</em></p> |
| 63 |
|
|
|
| 64 |
|
|
<div class="ed issue"><p><em>Oops, it's too late for the April |
| 65 |
|
|
Fool!</em></p></div> |
| 66 |
|
|
|
| 67 |
|
|
<p>This document is a working draft. |
| 68 |
|
|
It might be updated, replaced, or obsoleted by |
| 69 |
|
|
other documents at any time. It is inappropriate to |
| 70 |
|
|
cite this document as other than <q>work in progress</q>.</p> |
| 71 |
|
|
|
| 72 |
|
|
<p>Comments on this document are welcome and |
| 73 |
|
|
may be sent to the <a href="#author">author</a>.</p> |
| 74 |
|
|
|
| 75 |
|
|
<p>Translations of thie document might be available. |
| 76 |
|
|
The English version of the document is the only |
| 77 |
|
|
normative version.</p> |
| 78 |
wakaba |
1.1 |
</div> |
| 79 |
|
|
|
| 80 |
|
|
<div id="introduction" class="section"> |
| 81 |
|
|
<h2>Introduction</h2> |
| 82 |
|
|
|
| 83 |
wakaba |
1.2 |
<p>Recently, a number of auto-discovery conventions |
| 84 |
|
|
are proposed and implemented in various Web browsers |
| 85 |
|
|
and so-called <q>Web 2.0</q> services. They provide |
| 86 |
|
|
means to extract links to resources (or other useful |
| 87 |
|
|
information) from Web documents in somewhat reliable |
| 88 |
|
|
ways. However, the syntax of these techniques |
| 89 |
|
|
vary and the implementators have to add specific |
| 90 |
|
|
code for each auto-discovery technique.</p> |
| 91 |
|
|
|
| 92 |
|
|
<p>The <dfn id="DT-autodiscovery-autodiscovery">Auto-Discovery |
| 93 |
|
|
Auto-Discovery</dfn> is a mechanism to discover |
| 94 |
|
|
auto-discovery element that contains links (or |
| 95 |
|
|
other information) for auto-discovery techniques. |
| 96 |
|
|
With the Auto-Discovery Auto-Discovery, user agents |
| 97 |
|
|
can detect auto-discovery elements without any |
| 98 |
|
|
particular knowledge to a specific auto-discovery |
| 99 |
|
|
technique.</p> |
| 100 |
wakaba |
1.1 |
|
| 101 |
|
|
</div> |
| 102 |
|
|
|
| 103 |
wakaba |
1.2 |
<div class="section" id="terminology"> |
| 104 |
|
|
<h2>Terminology</h2> |
| 105 |
|
|
|
| 106 |
|
|
<p>The key words <q><em class="rfc2119">MUST</em></q>, |
| 107 |
|
|
<q><em class="rfc2119">MUST NOT</em></q>, |
| 108 |
|
|
<q><em class="rfc2119">SHOULD</em></q>, and |
| 109 |
|
|
<q><em class="rfc2119">SHOULD NOT</em></q> in this |
| 110 |
wakaba |
1.3 |
document are to be interpreted as described in |
| 111 |
|
|
<abbr title="Request for Comments">RFC</abbr> 2119 |
| 112 |
wakaba |
1.2 |
<cite class="bibref normative">[<a href="#ref-KEYWORDS">KEYWORDS</a>]</cite>.</p> |
| 113 |
wakaba |
1.1 |
</div> |
| 114 |
|
|
|
| 115 |
wakaba |
1.2 |
<div class="section" id="for-authors"> |
| 116 |
|
|
<h2>Embeding Auto-Discovery Auto-Discovery Link</h2> |
| 117 |
wakaba |
1.1 |
|
| 118 |
|
|
<p>An <dfn id="DT-autodiscovery-autodiscovery-link">Auto-Discovery |
| 119 |
|
|
Auto-Discovery link</dfn> is a hyperlink to |
| 120 |
wakaba |
1.2 |
an auto-discovery element. |
| 121 |
wakaba |
1.1 |
The <dfn id="DT-referenced-element">referenced element</dfn> |
| 122 |
wakaba |
1.2 |
is the outermost element for the auto-discovery.</p> |
| 123 |
wakaba |
1.1 |
|
| 124 |
|
|
<p>The <dfn id="DT-referencing-element">referencing element</dfn> |
| 125 |
|
|
is the element representing an <a |
| 126 |
|
|
href="#DT-autodiscovery-autodiscovery-link">Auto-Discovery |
| 127 |
|
|
Auto-Discovery link</a>.</p> |
| 128 |
|
|
|
| 129 |
wakaba |
1.2 |
<!-- |
| 130 |
wakaba |
1.1 |
<p>The <a href="#DT-referenced-element">referenced element</a> |
| 131 |
|
|
<em class="rfc2119">MUST</em> have an |
| 132 |
wakaba |
1.2 |
<code>ID</code> attribute.</p> |
| 133 |
|
|
|
| 134 |
|
|
<div class="note memo"> |
| 135 |
|
|
<p>In HTML, the <code class="HTMLa">id</code> attribute |
| 136 |
|
|
is an <code>ID</code> attribute. In XML, the |
| 137 |
|
|
<code class="XMLa">xml:id</code> attribute may be used.</p> |
| 138 |
|
|
</div> |
| 139 |
|
|
--> |
| 140 |
wakaba |
1.1 |
|
| 141 |
|
|
<p>The <a href="#DT-referencing-element">referencing element</a> |
| 142 |
|
|
<em class="rfc2119">MUST</em> be a <code class="HTMLe">link</code> |
| 143 |
|
|
element in the <code class="URI">http://www.w3.org/1999/xhtml</code> |
| 144 |
|
|
namespace.</p> |
| 145 |
|
|
|
| 146 |
|
|
<p>The <a href="#DT-referencing-element">referencing element</a> |
| 147 |
wakaba |
1.3 |
<em class="rfc2119">MUST</em> have the <code class="HTMLa">rel</code> |
| 148 |
wakaba |
1.1 |
attribute which contains <code class="HTML">meta</code> |
| 149 |
wakaba |
1.3 |
as its only link relationship value.</p> |
| 150 |
wakaba |
1.1 |
|
| 151 |
|
|
<p>The <a href="#DT-referencing-element">referencing element</a> |
| 152 |
wakaba |
1.3 |
<em class="rfc2119">MUST</em> have the <code class="HTMLa">href</code> |
| 153 |
wakaba |
1.1 |
attribute whose value is a same-document IRI reference |
| 154 |
|
|
<cite class="bibref normative">[<a href="#ref-IRI">IRI</a>]</cite> |
| 155 |
wakaba |
1.3 |
referencing a <a href="#DT-referenced-element">referenced |
| 156 |
|
|
element</a> within the same document. The |
| 157 |
wakaba |
1.1 |
<a href="#DT-referenced-element">referenced element</a> |
| 158 |
wakaba |
1.3 |
<em class="rfc2119">MUST NOT</em> be a |
| 159 |
|
|
<a href="#DT-referencing-element">referencing element</a>.</p> |
| 160 |
wakaba |
1.1 |
|
| 161 |
|
|
<div class="issue ed"> |
| 162 |
|
|
<p>Ensure that <q>same-document IRI reference</q> |
| 163 |
|
|
is a defined term.</p> |
| 164 |
|
|
</div> |
| 165 |
|
|
|
| 166 |
wakaba |
1.3 |
<div class="note memo"> |
| 167 |
|
|
<p>The <a href="#DT-referencing-element">referencing element</a> |
| 168 |
|
|
might have any other attributes as defined in relavant specifications. |
| 169 |
|
|
For example, a <a href="#DT-referencing-element">referencing element</a> |
| 170 |
|
|
that points a <a href="#DT-referenced-element">referenced element</a> |
| 171 |
|
|
which only applied to specific media might have the |
| 172 |
|
|
<code class="HTMLa">media</code> attribute specified.</p> |
| 173 |
|
|
</div> |
| 174 |
wakaba |
1.2 |
|
| 175 |
|
|
<div class="note memo"> |
| 176 |
wakaba |
1.3 |
<p>It is necessary for a <a href="#DT-referencing-element">referencing |
| 177 |
|
|
element</a> to be inserted to the position where it is allowed. |
| 178 |
|
|
For example, no elements in the HTML namespace other than |
| 179 |
|
|
<code class="HTMLe">head</code> is allowed to contain |
| 180 |
|
|
<code class="HTMLe">link</code> elements |
| 181 |
|
|
<cite class="bibref normative">[<a href="#ref-HTML5">HTML5</a>]</cite>.</p> |
| 182 |
|
|
|
| 183 |
|
|
<p>Note also that <a href="#DT-referencing-element">referencing element</a>s |
| 184 |
|
|
might appear in non-HTML documents. For example, they might |
| 185 |
|
|
be used in the <code class="XMLe">rss</code> element |
| 186 |
|
|
of an <abbr>RSS</abbr> feed document.</p> |
| 187 |
wakaba |
1.2 |
</div> |
| 188 |
|
|
|
| 189 |
|
|
</div> |
| 190 |
|
|
|
| 191 |
|
|
</div> |
| 192 |
|
|
|
| 193 |
|
|
<div class="section" id="for-ua"> |
| 194 |
|
|
<h2>Auto-Discovering Auto-Discovery Elements</h2> |
| 195 |
|
|
|
| 196 |
wakaba |
1.1 |
<div class="ed">...</div> |
| 197 |
|
|
|
| 198 |
|
|
</div> |
| 199 |
|
|
|
| 200 |
wakaba |
1.2 |
<div class="section" id="examples"> |
| 201 |
|
|
<h2>Examples</h2> |
| 202 |
|
|
|
| 203 |
|
|
<p>This section is <em>informative</em>.</p> |
| 204 |
|
|
|
| 205 |
|
|
<div class="ed issue">...</div> |
| 206 |
|
|
|
| 207 |
|
|
<div class="example figure block"> |
| 208 |
|
|
<div class="caption">Auto-Discovery Auto-Discovery |
| 209 |
|
|
for TrackBack Auto-Discovery</div> |
| 210 |
|
|
|
| 211 |
|
|
<pre><code class="HTML"> |
| 212 |
|
|
<rdf:RDF |
| 213 |
|
|
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" |
| 214 |
|
|
xmlns:dc="http://purl.org/dc/elements/1.1/" |
| 215 |
|
|
xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/" |
| 216 |
|
|
xml:id="trackback"> |
| 217 |
|
|
<rdf:Description |
| 218 |
|
|
rdf:about="http://www.foo.example/archive.html#foo" |
| 219 |
|
|
dc:identifier="http://www.foo.example/archive.html#foo" |
| 220 |
|
|
dc:title="Foo Bar" |
| 221 |
|
|
trackback:ping="http://www.foo.example/tb.cgi/5" /> |
| 222 |
|
|
</rdf:RDF> |
| 223 |
|
|
<link rel="meta" href="#trackback"> |
| 224 |
|
|
</code></pre> |
| 225 |
|
|
</div> |
| 226 |
|
|
|
| 227 |
|
|
<div class="example figure block"> |
| 228 |
|
|
<div class="caption">Auto-Discovery Auto-Discovery |
| 229 |
|
|
for Atom Auto-Discovery</div> |
| 230 |
|
|
|
| 231 |
|
|
<pre><code class="HTML"> |
| 232 |
|
|
<link rel="meta" href="#atom"> |
| 233 |
|
|
<link id="atom" rel="feed" href="feed.atom" type="application/atom+xml"> |
| 234 |
|
|
</code></pre> |
| 235 |
wakaba |
1.1 |
</div> |
| 236 |
|
|
|
| 237 |
|
|
</div> |
| 238 |
|
|
|
| 239 |
|
|
<div id="references" class="section reference"> |
| 240 |
|
|
<h2>References</h1> |
| 241 |
|
|
|
| 242 |
|
|
<div id="normative-references" class="section normative reference"> |
| 243 |
|
|
<h3>Normative References</h3> |
| 244 |
|
|
|
| 245 |
|
|
<dl> |
| 246 |
|
|
<dt id="ref-HTML5">HTML5</dt> |
| 247 |
wakaba |
1.3 |
<dd><a href="http://www.whatwg.org/specs/web-apps/current-work/"><cite>Web |
| 248 |
|
|
Applications 1.0</cite></a>, |
| 249 |
|
|
<abbr title="Web Hypertext Application Technology Working Group">WHATWG</abbr> |
| 250 |
|
|
Working Draft. Work in progress. Latest version of the specification |
| 251 |
|
|
is referenced.</dd> |
| 252 |
wakaba |
1.1 |
<dt id="ref-IRI">IRI</dt> |
| 253 |
wakaba |
1.3 |
<dd class="ed">RFC 3987. The exact version of the specification |
| 254 |
|
|
is referenced.</dd> |
| 255 |
wakaba |
1.2 |
<dt id="ref-KEYWORDS">KEYWORDS</dt> |
| 256 |
wakaba |
1.3 |
<dd class="ed">RFC 2119. The exact version of the specification |
| 257 |
|
|
is referenced.</dd> |
| 258 |
wakaba |
1.1 |
</dl> |
| 259 |
|
|
</div> |
| 260 |
|
|
|
| 261 |
|
|
<div id="informative-references" class="section informative reference"> |
| 262 |
|
|
<h3>Informative References</h3> |
| 263 |
|
|
|
| 264 |
|
|
<dl> |
| 265 |
|
|
<dt id="ref-ACCOUNTAUTODISCOVERY">ACOUNTAUTODISCOVERY</dt> |
| 266 |
|
|
<dd class="ed">...</dd> |
| 267 |
|
|
<dt id="ref-ATOMAUTODISCOVERY">ATOMAUTODISCOVERY</dt> |
| 268 |
|
|
<dd class="ed">I-D</dd> |
| 269 |
wakaba |
1.3 |
<dt id="ref-COMMENTAPI">COMMENTAPI</dt> |
| 270 |
|
|
<dd><cite><a href="http://wellformedweb.org/story/9" |
| 271 |
|
|
>The Comment API</a></cite>, |
| 272 |
|
|
<cite>The Well-Formed Web</cite>, BitWorking, Inc, |
| 273 |
|
|
<time title="2003-01-17">17 January 2003</time>.</dd> |
| 274 |
wakaba |
1.1 |
<dt id="ref-FEEDAUTODISCOVERY">FEEDAUTODISCOVERY</dt> |
| 275 |
|
|
<dd class="ed">wiki</dd> |
| 276 |
|
|
<dt id="ref-FOAFAUTODISCOVERY">FOAFAUTODISCOVERY</dt> |
| 277 |
|
|
<dd class="ed">...</dd> |
| 278 |
|
|
<dt id="ref-MOBILEAUTODISCOVERY">MOBILEAUTODISCOVERY</dt> |
| 279 |
|
|
<dd class="ed">...</dd> |
| 280 |
wakaba |
1.3 |
<dt id="ref-OPMLAUTO">OPMLAUTO</dt> |
| 281 |
|
|
<dd><cite><a href="http://www.cleverclogs.org/2006/10/opml_autodiscov.html" |
| 282 |
|
|
>OPML Auto-discovery Bookmarklet</a></cite>, |
| 283 |
|
|
<cite>CleverClogs</cite>, Marjolein Hoekstra, 15 October 2006.</dd> |
| 284 |
wakaba |
1.1 |
<dt id="ref-PINGBACK">PINGBACK</dt> |
| 285 |
|
|
<dd class="ed">...</dd> |
| 286 |
wakaba |
1.3 |
<dt id="ref-RSSAUTO">RSSAUTO</dt> |
| 287 |
|
|
<dd><cite><a |
| 288 |
|
|
href="http://diveintomark.org/archives/2002/05/30/rss_autodiscovery" |
| 289 |
|
|
>RSS auto-discovery</a></cite>, |
| 290 |
|
|
<cite>dive into mark</cite>, Mark Pilgrim, 30 May 2002.</dd> |
| 291 |
|
|
<dd><cite><a |
| 292 |
|
|
href="http://diveintomark.org/archives/2002/06/02/important_change_to_the_link_tag" |
| 293 |
|
|
>Important change to the LINK tag</a></cite>, |
| 294 |
|
|
<cite>dive into mark</cite>, Mark Pilgrim, 2 June 2002.</dd> |
| 295 |
wakaba |
1.1 |
<dt id="ref-TRACKBACK">TRACKBACK</dt> |
| 296 |
wakaba |
1.3 |
<dd><cite><a |
| 297 |
|
|
href="http://www.sixapart.com/pronet/docs/trackback_spec" |
| 298 |
|
|
>TrackBack Technical Specification</a></cite>, |
| 299 |
|
|
Six Apart, Version 1.2, 1 August 2004.</dd> |
| 300 |
wakaba |
1.1 |
<dt id="ref-WIDGETS">WIDGETS</dt> |
| 301 |
|
|
<dd class="ed">...</dd> |
| 302 |
wakaba |
1.2 |
<dt id="ref-XMLID">XMLID</dt> |
| 303 |
|
|
<dd class="ed">xml:id</dd> |
| 304 |
wakaba |
1.1 |
</dl> |
| 305 |
|
|
</div> |
| 306 |
|
|
|
| 307 |
|
|
</div> |
| 308 |
|
|
|
| 309 |
|
|
</body> |
| 310 |
|
|
</html> |