www/2006/auto-discovery.en.html

<!DOCTYPE html>
<html lang="en" class="formal-specification status-work-in-progress">
<head>
<title>Auto-Discovery Auto-Discovery Specification</title>
<link rel="stylesheet" href="http://suika.fam.cx/www/style/html/spec.css">
<link rel="license" href="http://suika.fam.cx/c/gnu/fdl">
</head>
<body class="has-abstract">

<div class="header">
<h1>Auto-Discovery Auto-Discovery Specification</h1>
<h2>Working Draft 3 December 2006</h2>

<dl class="versions-uri">
<dt>This Version</dt>
  <dd><code class="URI">&lt;<a href="http://suika.fam.cx/www/2006/auto-discovery"
      >http://suika.fam.cx/www/2006/auto-discovery</a>&gt;</code></dd>
<dt>Latest Version</dt>
  <dd><code class="URI">&lt;<a href="http://suika.fam.cx/www/2006/auto-discovery"
      >http://suika.fam.cx/www/2006/auto-discovery</a>&gt;</code></dd>
<!--
<dt>Latest Working Draft</dt>
  <dd><code class="URI">&lt;<a href="http://suika.fam.cx/www/2006/auto-discovery"
      >http://suika.fam.cx/www/2006/auto-discovery</a>&gt;</code></dd>
-->
<!-- <dt>Previous Version</dt> -->
</dl>
<dl class="authors">
<dt>Author</dt>
  <dd><a href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>
  <code class="mail">&lt;<a href="mailto:w@suika.fam.cx" rel="author"
      >w@suika.fam.cx</a>&gt;</code></dd>
</dl>

<p class="copyright" lang="en">&#xA9; 2006 <a
    href="http://suika.fam.cx/~wakaba/who?" rel="author">Wakaba</a>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the <a rel="license"
href="http://www.gnu.org/copyleft/fdl.html">GNU Free Documentation License</a>,
Version 1.2
or any later version published by the <a
href="http://www.fsf.org/">Free Software Foundation</a>;
with no Invariant Sections, no Front$B!>(BCover Texts, and no Back$B!>(BCover
Texts.  A copy of the license is
available at <code class="URI">&lt;<a
    href="http://www.gnu.org/copyleft/fdl.html"
    rel="license">http://www.gnu.org/copyleft/fdl.html</a>&gt;</code>.</p>
</div>

<div id="abstract" class="section">
<h2>Abstract</h2>

<div class="ed issue">...</div>

</div>

<div id="status" class="section">
<h2>Status of This Document</h2>

<div class="ed issue"><p>Work in progress, and just a joke:-)</p></div>

</div>

<div id="introduction" class="section">
<h2>Introduction</h2>

<p>Recently, a number of auto-discovery conventions
are proposed and implemented in various Web browsers
and so-called <q>Web 2.0</q> services.  They provide
means to extract links to resources (or other useful
information) from Web documents in somewhat reliable
ways.  However, the syntax of these techniques
vary and the implementators have to add specific
code for each auto-discovery technique.</p>

<p>The <dfn id="DT-autodiscovery-autodiscovery">Auto-Discovery
Auto-Discovery</dfn> is a mechanism to discover
auto-discovery element that contains links (or
other information) for auto-discovery techniques.
With the Auto-Discovery Auto-Discovery, user agents 
can detect auto-discovery elements without any
particular knowledge to a specific auto-discovery
technique.</p>

</div>

<div class="section" id="terminology">
<h2>Terminology</h2>

<p>The key words <q><em class="rfc2119">MUST</em></q>,
<q><em class="rfc2119">MUST NOT</em></q>,
<q><em class="rfc2119">SHOULD</em></q>, and
<q><em class="rfc2119">SHOULD NOT</em></q> in this
document are to be interpreted as described in RFC 2119
<cite class="bibref normative">[<a href="#ref-KEYWORDS">KEYWORDS</a>]</cite>.</p>
</div>

<div class="section" id="for-authors">
<h2>Embeding Auto-Discovery Auto-Discovery Link</h2>

<p>An <dfn id="DT-autodiscovery-autodiscovery-link">Auto-Discovery
Auto-Discovery link</dfn> is a hyperlink to
an auto-discovery element.  
The <dfn id="DT-referenced-element">referenced element</dfn>
is the outermost element for the auto-discovery.</p>

<p>The <dfn id="DT-referencing-element">referencing element</dfn>
is the element representing an <a
    href="#DT-autodiscovery-autodiscovery-link">Auto-Discovery 
Auto-Discovery link</a>.</p>

<!--
<p>The <a href="#DT-referenced-element">referenced element</a>
<em class="rfc2119">MUST</em> have an
<code>ID</code> attribute.</p>

  <div class="note memo">
  <p>In HTML, the <code class="HTMLa">id</code> attribute
  is an <code>ID</code> attribute.  In XML, the
  <code class="XMLa">xml:id</code> attribute may be used.</p>
  </div>
-->

<p>The <a href="#DT-referencing-element">referencing element</a>
<em class="rfc2119">MUST</em> be a <code class="HTMLe">link</code>
element in the <code class="URI">http://www.w3.org/1999/xhtml</code>
namespace.</p>

<p>The <a href="#DT-referencing-element">referencing element</a>
<em class="rfc2119">MUST</em> have a <code class="HTMLa">rel</code>
attribute which contains <code class="HTML">meta</code>
as the only link relationship value.</p>

<p>The <a href="#DT-referencing-element">referencing element</a>
<em class="rfc2119">MUST</em> have an <code class="HTMLa">id</code>
attribute whose value is a same-document IRI reference 
<cite class="bibref normative">[<a href="#ref-IRI">IRI</a>]</cite>
referencing the <a href="#DT-referenced-element">referenced
element</a> in the same document.  The
<a href="#DT-referenced-element">referenced element</a>
<em class="rfc2119">MUST NOT</em> be an element
representing an <a href="#DT-autodiscovery-autodiscovery-link">Auto-Discovery 
Auto-Discovery link</a>.</p>

<div class="issue ed">
<p>Ensure that <q>same-document IRI reference</q>
is a defined term.</p>
</div>


<p>The <a href="#DT-referencing-element">referencing element</a>
<em class="rfc2119">MAY</em> have other attributes.</p>

<p>The <a href="#DT-referencing-element">referencing element</a>
<em class="rfc2119">MUST</em> be placed where it is allowed.
In HTML5 <cite class="bibref normative">[<a
    href="#ref-HTML5">HTML5</a>]</cite>, it may be
a child of the <code class="HTMLe">head</code> element in the document.</p>

  <div class="note memo">
  <p>The <a href="#DT-referencing-element">referencing element</a>
  may appear in non-HTML document.  For example, it might
  be used in an <code class="XMLe">rss</code> element
  in an RSS feed document.</p>
  </div>

</div>

</div>

<div class="section" id="for-ua">
<h2>Auto-Discovering Auto-Discovery Elements</h2>

<div class="ed">...</div>

</div>

<div class="section" id="examples">
<h2>Examples</h2>

<p>This section is <em>informative</em>.</p>

<div class="ed issue">...</div>

<div class="example figure block">
<div class="caption">Auto-Discovery Auto-Discovery
for TrackBack Auto-Discovery</div>

<pre><code class="HTML">
  &lt;rdf:RDF
      xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
      xmlns:dc="http://purl.org/dc/elements/1.1/"
      xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/"
      xml:id="trackback">
    &lt;rdf:Description
        rdf:about="http://www.foo.example/archive.html#foo"
        dc:identifier="http://www.foo.example/archive.html#foo"
        dc:title="Foo Bar"
        trackback:ping="http://www.foo.example/tb.cgi/5" />
  &lt;/rdf:RDF>
  &lt;link rel="meta" href="#trackback">
</code></pre>
</div>

<div class="example figure block">
<div class="caption">Auto-Discovery Auto-Discovery
for Atom Auto-Discovery</div>

<pre><code class="HTML">
&lt;link rel="meta" href="#atom">
&lt;link id="atom" rel="feed" href="feed.atom" type="application/atom+xml">
</code></pre>
</div>

</div>

<div id="references" class="section reference">
<h2>References</h1>

<div id="normative-references" class="section normative reference">
<h3>Normative References</h3>

<dl>
<dt id="ref-HTML5">HTML5</dt>
  <dd class="ed">WA1</dd>
<dt id="ref-IRI">IRI</dt>
  <dd class="ed">RFC 3987</dd>
<dt id="ref-KEYWORDS">KEYWORDS</dt>
  <dd class="ed">RFC 2119</dd>
</dl>
</div>

<div id="informative-references" class="section informative reference">
<h3>Informative References</h3>

<dl>
<dt id="ref-ACCOUNTAUTODISCOVERY">ACOUNTAUTODISCOVERY</dt>
  <dd class="ed">...</dd>
<dt id="ref-ATOMAUTODISCOVERY">ATOMAUTODISCOVERY</dt>
  <dd class="ed">I-D</dd>
<dt id="ref-FEEDAUTODISCOVERY">FEEDAUTODISCOVERY</dt>
  <dd class="ed">wiki</dd>
<dt id="ref-FOAFAUTODISCOVERY">FOAFAUTODISCOVERY</dt>
  <dd class="ed">...</dd>
<dt id="ref-MOBILEAUTODISCOVERY">MOBILEAUTODISCOVERY</dt>
  <dd class="ed">...</dd>
<dt id="ref-PINGBACK">PINGBACK</dt>
  <dd class="ed">...</dd>
<dt id="ref-RSSAUTODISCOVERY">RSSAUTODISCOVERY</dt>
  <dd class="ed">...</dd>
<dt id="ref-TRACKBACK">TRACKBACK</dt>
    <dd>Six Apart, <cite><a
        href="http://www.sixapart.com/pronet/docs/trackback_spec"
        >TrackBack Technical Specification</a></cite>,
    Version 1.2, 1 August 2004.</dd>
<dt id="ref-WIDGETS">WIDGETS</dt>
  <dd class="ed">...</dd>
<dt id="ref-XMLID">XMLID</dt>
  <dd class="ed">xml:id</dd>
</dl>
</div>

</div>

</body>
</html>
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.2	<h2>Working Draft 3 December 2006</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			<dl class="authors">
29			<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			<p class="copyright" lang="en">© 2006 <a
36			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.2	<div class="ed issue"><p>Work in progress, and just a joke:-)</p></div>
61	wakaba	1.1
62			</div>
63
64			<div id="introduction" class="section">
65			<h2>Introduction</h2>
66
67	wakaba	1.2	<p>Recently, a number of auto-discovery conventions
68			are proposed and implemented in various Web browsers
69			and so-called <q>Web 2.0</q> services. They provide
70			means to extract links to resources (or other useful
71			information) from Web documents in somewhat reliable
72			ways. However, the syntax of these techniques
73			vary and the implementators have to add specific
74			code for each auto-discovery technique.</p>
75
76			<p>The <dfn id="DT-autodiscovery-autodiscovery">Auto-Discovery
77			Auto-Discovery</dfn> is a mechanism to discover
78			auto-discovery element that contains links (or
79			other information) for auto-discovery techniques.
80			With the Auto-Discovery Auto-Discovery, user agents
81			can detect auto-discovery elements without any
82			particular knowledge to a specific auto-discovery
83			technique.</p>
84	wakaba	1.1
85			</div>
86
87	wakaba	1.2	<div class="section" id="terminology">
88			<h2>Terminology</h2>
89
90			<p>The key words <q><em class="rfc2119">MUST</em></q>,
91			<q><em class="rfc2119">MUST NOT</em></q>,
92			<q><em class="rfc2119">SHOULD</em></q>, and
93			<q><em class="rfc2119">SHOULD NOT</em></q> in this
94			document are to be interpreted as described in RFC 2119
95			<cite class="bibref normative">[<a href="#ref-KEYWORDS">KEYWORDS</a>]</cite>.</p>
96	wakaba	1.1	</div>
97
98	wakaba	1.2	<div class="section" id="for-authors">
99			<h2>Embeding Auto-Discovery Auto-Discovery Link</h2>
100	wakaba	1.1
101			<p>An <dfn id="DT-autodiscovery-autodiscovery-link">Auto-Discovery
102			Auto-Discovery link</dfn> is a hyperlink to
103	wakaba	1.2	an auto-discovery element.
104	wakaba	1.1	The <dfn id="DT-referenced-element">referenced element</dfn>
105	wakaba	1.2	is the outermost element for the auto-discovery.</p>
106	wakaba	1.1
107			<p>The <dfn id="DT-referencing-element">referencing element</dfn>
108			is the element representing an <a
109			href="#DT-autodiscovery-autodiscovery-link">Auto-Discovery
110			Auto-Discovery link</a>.</p>
111
112	wakaba	1.2	<!--
113	wakaba	1.1	<p>The <a href="#DT-referenced-element">referenced element</a>
114			<em class="rfc2119">MUST</em> have an
115	wakaba	1.2	<code>ID</code> attribute.</p>
116
117			<div class="note memo">
118			<p>In HTML, the <code class="HTMLa">id</code> attribute
119			is an <code>ID</code> attribute. In XML, the
120			<code class="XMLa">xml:id</code> attribute may be used.</p>
121			</div>
122			-->
123	wakaba	1.1
124			<p>The <a href="#DT-referencing-element">referencing element</a>
125			<em class="rfc2119">MUST</em> be a <code class="HTMLe">link</code>
126			element in the <code class="URI">http://www.w3.org/1999/xhtml</code>
127			namespace.</p>
128
129			<p>The <a href="#DT-referencing-element">referencing element</a>
130			<em class="rfc2119">MUST</em> have a <code class="HTMLa">rel</code>
131			attribute which contains <code class="HTML">meta</code>
132			as the only link relationship value.</p>
133
134			<p>The <a href="#DT-referencing-element">referencing element</a>
135			<em class="rfc2119">MUST</em> have an <code class="HTMLa">id</code>
136			attribute whose value is a same-document IRI reference
137			<cite class="bibref normative">[<a href="#ref-IRI">IRI</a>]</cite>
138			referencing the <a href="#DT-referenced-element">referenced
139			element</a> in the same document. The
140			<a href="#DT-referenced-element">referenced element</a>
141			<em class="rfc2119">MUST NOT</em> be an element
142			representing an <a href="#DT-autodiscovery-autodiscovery-link">Auto-Discovery
143			Auto-Discovery link</a>.</p>
144
145			<div class="issue ed">
146			<p>Ensure that <q>same-document IRI reference</q>
147			is a defined term.</p>
148			</div>
149
150
151			<p>The <a href="#DT-referencing-element">referencing element</a>
152			<em class="rfc2119">MAY</em> have other attributes.</p>
153
154	wakaba	1.2	<p>The <a href="#DT-referencing-element">referencing element</a>
155			<em class="rfc2119">MUST</em> be placed where it is allowed.
156			In HTML5 <cite class="bibref normative">[<a
157			href="#ref-HTML5">HTML5</a>]</cite>, it may be
158			a child of the <code class="HTMLe">head</code> element in the document.</p>
159
160			<div class="note memo">
161			<p>The <a href="#DT-referencing-element">referencing element</a>
162			may appear in non-HTML document. For example, it might
163			be used in an <code class="XMLe">rss</code> element
164			in an RSS feed document.</p>
165			</div>
166
167			</div>
168
169			</div>
170
171			<div class="section" id="for-ua">
172			<h2>Auto-Discovering Auto-Discovery Elements</h2>
173
174	wakaba	1.1	<div class="ed">...</div>
175
176			</div>
177
178	wakaba	1.2	<div class="section" id="examples">
179			<h2>Examples</h2>
180
181			<p>This section is <em>informative</em>.</p>
182
183			<div class="ed issue">...</div>
184
185			<div class="example figure block">
186			<div class="caption">Auto-Discovery Auto-Discovery
187			for TrackBack Auto-Discovery</div>
188
189			<pre><code class="HTML">
190			<rdf:RDF
191			xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
192			xmlns:dc="http://purl.org/dc/elements/1.1/"
193			xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/"
194			xml:id="trackback">
195			<rdf:Description
196			rdf:about="http://www.foo.example/archive.html#foo"
197			dc:identifier="http://www.foo.example/archive.html#foo"
198			dc:title="Foo Bar"
199			trackback:ping="http://www.foo.example/tb.cgi/5" />
200			</rdf:RDF>
201			<link rel="meta" href="#trackback">
202			</code></pre>
203			</div>
204
205			<div class="example figure block">
206			<div class="caption">Auto-Discovery Auto-Discovery
207			for Atom Auto-Discovery</div>
208
209			<pre><code class="HTML">
210			<link rel="meta" href="#atom">
211			<link id="atom" rel="feed" href="feed.atom" type="application/atom+xml">
212			</code></pre>
213	wakaba	1.1	</div>
214
215			</div>
216
217			<div id="references" class="section reference">
218			<h2>References</h1>
219
220			<div id="normative-references" class="section normative reference">
221			<h3>Normative References</h3>
222
223			<dl>
224			<dt id="ref-HTML5">HTML5</dt>
225			<dd class="ed">WA1</dd>
226			<dt id="ref-IRI">IRI</dt>
227			<dd class="ed">RFC 3987</dd>
228	wakaba	1.2	<dt id="ref-KEYWORDS">KEYWORDS</dt>
229			<dd class="ed">RFC 2119</dd>
230	wakaba	1.1	</dl>
231			</div>
232
233			<div id="informative-references" class="section informative reference">
234			<h3>Informative References</h3>
235
236			<dl>
237			<dt id="ref-ACCOUNTAUTODISCOVERY">ACOUNTAUTODISCOVERY</dt>
238			<dd class="ed">...</dd>
239			<dt id="ref-ATOMAUTODISCOVERY">ATOMAUTODISCOVERY</dt>
240			<dd class="ed">I-D</dd>
241			<dt id="ref-FEEDAUTODISCOVERY">FEEDAUTODISCOVERY</dt>
242			<dd class="ed">wiki</dd>
243			<dt id="ref-FOAFAUTODISCOVERY">FOAFAUTODISCOVERY</dt>
244			<dd class="ed">...</dd>
245			<dt id="ref-MOBILEAUTODISCOVERY">MOBILEAUTODISCOVERY</dt>
246			<dd class="ed">...</dd>
247			<dt id="ref-PINGBACK">PINGBACK</dt>
248			<dd class="ed">...</dd>
249			<dt id="ref-RSSAUTODISCOVERY">RSSAUTODISCOVERY</dt>
250			<dd class="ed">...</dd>
251			<dt id="ref-TRACKBACK">TRACKBACK</dt>
252			<dd>Six Apart, <cite><a
253			href="http://www.sixapart.com/pronet/docs/trackback_spec"
254			>TrackBack Technical Specification</a></cite>,
255			Version 1.2, 1 August 2004.</dd>
256			<dt id="ref-WIDGETS">WIDGETS</dt>
257			<dd class="ed">...</dd>
258	wakaba	1.2	<dt id="ref-XMLID">XMLID</dt>
259			<dd class="ed">xml:id</dd>
260	wakaba	1.1	</dl>
261			</div>
262
263			</div>
264
265			</body>
266			</html>