Skip to content

Commit 31055aa

Browse files
authored
Discoverable destinations (#328)
* Rename within the explainer * Rename explainer * Almost all renames within destinations doc * Rename destinations doc (within section) from spec to best practices doc
1 parent 27d1b14 commit 31055aa

File tree

2 files changed

+72
-72
lines changed

2 files changed

+72
-72
lines changed

destinations/index.html

Lines changed: 24 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
33
<head>
4-
<title>WAI-Adapt: Well-known Destinations</title>
4+
<title>WAI-Adapt: Discoverable Destinations</title>
55
<meta charset="utf-8"/>
66
<meta name="color-scheme" content="dark light" />
77
<script src="https://www.w3.org/Tools/respec/respec-w3c" class="remove"></script>
@@ -17,10 +17,6 @@
1717
</head>
1818
<body>
1919
<section id="abstract">
20-
<div class=ednote>
21-
<p>This document will be renamed; it is currently referred to as &quot;well-known destinations&quot; for historical reasons.</p>
22-
</div>
23-
2420
<p>This document describes an approach that content authors can use to provide improved ease of navigation to website visitors.</p>
2521
</section>
2622

@@ -34,7 +30,7 @@ <h2>Introduction</h2>
3430
However, whilst there are several conventions when it comes to
3531
navigation, this variability can pose challenges to certain people—and
3632
user agents acting on their behalf.</p>
37-
<p>This specification aims to address the challenge of making sites more
33+
<p>This best practices document aims to address the challenge of making sites more
3834
easily navigable for both people (particularly those facing
3935
accessibility barriers) and machines. It does this by standardising
4036
machine-readable names for common page types. User Agents can then query
@@ -73,9 +69,9 @@ <h3 id="out-of-scope">Out of scope</h3>
7369
the user can navigate to supported well-known pages.</p></li>
7470
</ul>
7571
<p>Though detailed UI design is out of scope, an proof-of-concept UI for
76-
enumerating a site's well-known destinations is depicted below.</p>
72+
enumerating a site's discoverable destinations is depicted below.</p>
7773
<figure><img src="../presentations/ac2024/ext02.png"
78-
alt="A fictional ACME Inc. home page, with the extension pop-up open, showing 6 buttons, each containing emoji and accompanying text names for the well-known destinations offered by the site: home, accessibility statement, contact, help, log in, and products." />
74+
alt="A fictional ACME Inc. home page, with the extension pop-up open, showing 6 buttons, each containing emoji and accompanying text names for the discoverable destinations offered by the site: home, accessibility statement, contact, help, log in, and products." />
7975
<figcaption>Example UI, via a browser extension running on a custom shopping site</figcaption>
8076
</figure>
8177
</section>
@@ -87,7 +83,7 @@ <h2>Use Cases and Requirements</h2>
8783
</div>
8884

8985
<h3 id="user-research">User research</h3>
90-
<p>Our proposed "well-known destinations" come from work done by the <a
86+
<p>Our proposed "discoverable destinations" come from work done by the <a
9187
href="https://www.w3.org/WAI/GL/task-forces/coga/">Cognitive and
9288
Learning Disabilities Accessibility Task Force</a>.</p>
9389
<div class="note">
@@ -96,7 +92,7 @@ <h3 id="user-research">User research</h3>
9692
href="https://raw.githack.com/w3c/adapt/CR-content-2022-07-26/content/index.html#values-0">destinations
9793
that the WAI-Adapt TF inherited from COGA</a>.</p>
9894
</div>
99-
<p>An illustrative set of proposed well-known destinations is as
95+
<p>An illustrative set of proposed discoverable destinations is as
10096
follows...</p>
10197
<ul>
10298
<li><p><code>accessibility-statement</code> (for the site's <a
@@ -120,23 +116,23 @@ <h3 id="technical-requirements">Technical requirements</h3>
120116
<p>Any approch that would solve these user needs must provide the
121117
following.</p>
122118
<ol>
123-
<li><p>A way to represent each well-known destination proposed
119+
<li><p>A way to represent each discoverable destination proposed
124120
above.</p></li>
125-
<li><p>A mechanism for discovering all well-known destinations supported
121+
<li><p>A mechanism for discovering all discoverable destinations supported
126122
by a site—to be used when a UA first visits a site on behalf of the
127123
user. In order to do this efficiently, it must be possible to make this
128124
query in a single HTTP request. The results would be available to the
129125
user via the UI of the UA.</p></li>
130126
<li><p>A way to denote the scope of any particular site (or
131127
sub-site).</p></li>
132-
<li><p>A procedure for visiting a well-known destination directly (when
128+
<li><p>A procedure for visiting a discoverable destination directly (when
133129
the user activates the interface in the UA).</p></li>
134-
<li><p>A mechanism by which a well-known destination would be updated
130+
<li><p>A mechanism by which a discoverable destination would be updated
135131
(by the content author).</p></li>
136132
<li><p>Means to identify when a link on a page takes the user to a
137-
sub-page of a well-known destination page. E.g. a link to the "help on
133+
sub-page of a discoverable destination page. E.g. a link to the "help on
138134
logging in" page (as opposed to the main "help" section landing page,
139-
which is where the well-known destination alone would take the
135+
which is where the discoverable destination alone would take the
140136
user).</p></li>
141137
<li><p>Means to demarcate an element on the destination page that
142138
provides the destination content.</p></li>
@@ -154,14 +150,12 @@ <h3 id="technical-requirements">Technical requirements</h3>
154150
</section>
155151

156152
<section>
157-
<h2 id="the-well-known-destinations-approach">The "Well-known
158-
destinations" approach</h2>
153+
<h2 id="the-discoverable-destinations-approach">The "discoverable destinations" approach</h2>
159154
<p>This involves using the <code>&lt;link&gt;</code> element, and custom
160-
<code>rel</code> attribute values, to signpost well-known destinations
155+
<code>rel</code> attribute values, to signpost discoverable destinations
161156
on a site.</p>
162-
<h3 id="the-well-known-destination-namespace">The well-known destination
163-
namespace</h3>
164-
<p>All possible well-known destinations will be registered as
157+
<h3 id="the-discoverable-destination-namespace">The discoverable destination namespace</h3>
158+
<p>All possible discoverable destinations will be registered as
165159
<code>rel</code> attribute values.</p>
166160
<ul>
167161
<li><p><code>accessibility-statement</code></p></li>
@@ -172,8 +166,7 @@ <h3 id="the-well-known-destination-namespace">The well-known destination
172166
<li><p><code>search</code></p></li>
173167
</ul>
174168

175-
<h3 id="enumerating-well-known-destinations">Enumerating well-known
176-
destinations</h3>
169+
<h3 id="enumerating-discoverable-destinations">Enumerating discoverable destinations</h3>
177170
<p>On the site's home page, the destinations supported by the site would
178171
be indicated via <code>&lt;link&gt;</code> elements. For example:</p>
179172

@@ -200,24 +193,21 @@ <h3 id="defining-a-site">Defining a site</h3>
200193
move to a sub-site, the sub-site will expose all destinations on all of
201194
its pages, and thus the UA/AT will be able to present the correct
202195
destinations for the sub-site.</p>
203-
<h3 id="visiting-a-well-known-destination-directly">Visiting a
204-
well-known destination directly</h3>
196+
<h3 id="visiting-a-discoverable-destination-directly">Visiting a discoverable destination directly</h3>
205197
<ul>
206-
<li><p>The user selects the well-known destination in the UI of their
198+
<li><p>The user selects the discoverable destination in the UI of their
207199
UA.</p></li>
208200
<li><p>The corresponding URL is loaded.</p></li>
209201
</ul>
210-
<h3 id="updating-a-well-known-destination">Updating a well-known
211-
destination</h3>
202+
<h3 id="updating-a-discoverable-destination">Updating a discoverable destination</h3>
212203
<p>The content author would need to ensure that the
213204
<code>&lt;link&gt;</code> elements sent are correct. In practice this
214205
would most likely be managed by the CMS powering the site, which could
215206
take the repetition out of the authoring process.</p>
216207
<h3
217-
id="expressing-when-a-link-points-to-part-of-a-well-known-destination">Expressing
218-
when a link points to part of a well-known destination</h3>
208+
id="expressing-when-a-link-points-to-part-of-a-discoverable-destination">Expressing when a link points to part of a discoverable destination</h3>
219209
<p>When an in-page (anchor, <code>&lt;a&gt;</code>) link points to a
220-
page that is a sub-page of a well-known destination (such as the "help
210+
page that is a sub-page of a discoverable destination (such as the "help
221211
on logging in" page, rather than the "help" home page), this can be
222212
indicated by adding a <code>rel</code> value to the anchor.</p>
223213
<aside class=example>
@@ -228,10 +218,10 @@ <h3 id="updating-a-well-known-destination">Updating a well-known
228218

229219
<h3 id="demarcating-destination-content">Demarcating destination
230220
content</h3>
231-
<p>As well-known destinations are normal links, they can make use of
221+
<p>As discoverable destinations are normal links, they can make use of
232222
fragments to point to certain elements on the destination page.</p>
233223
<p>The content/UA/AT can then use this information (and the knowledge that the
234-
navigation was via the Well-known destination UI) to render the
224+
navigation was via the Discoverable Destination UI) to render the
235225
destination page in an appropriate way for the user.</p>
236226

237227
<h2 id="open-questions">Open Questions</h2>

0 commit comments

Comments
 (0)