Skip to content

Add suggestion role #1134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Feb 13, 2020
Merged

Add suggestion role #1134

Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
fca5644
Add suggestion role
Dec 11, 2019
07e8c9b
Fix tabs
Dec 11, 2019
b6ec793
Fix tabs
Dec 11, 2019
3de920d
Add suggestion role
Dec 11, 2019
37637d0
Merge branch 'suggestion_role' of github.com:w3c/aria into suggestion…
Dec 11, 2019
74ddc01
Fix tabs
Dec 11, 2019
2a60d43
Single change
Jan 14, 2020
f288961
Add suggestion to roles categorization
Jan 14, 2020
89647d4
Add semantic sugar and improve wording
Jan 14, 2020
fd9a55c
Add example
Jan 24, 2020
d24179d
A suggestion must not include children other than the insertion/delet…
Jan 24, 2020
1871d99
Update index.html
aleventhal Jan 24, 2020
4d145ad
Update index.html
aleventhal Feb 7, 2020
8204194
Update index.html
aleventhal Feb 7, 2020
ac230b8
Update index.html
aleventhal Feb 7, 2020
96238a4
Update index.html
aleventhal Feb 7, 2020
ed3407e
Update index.html
aleventhal Feb 7, 2020
543f8cb
Don't use the term author for 2 different things
Feb 7, 2020
e544bec
Post-polish after accepting Matt's suggestions
Feb 7, 2020
6725363
Update index.html
aleventhal Feb 7, 2020
6e36557
Update index.html
aleventhal Feb 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,7 @@ <h3>Document Structure Roles</h3>
<li><rref>separator</rref> (when not focusable)</li>
<li><rref>strong</rref></li>
<li><rref>subscript</rref></li>
<li><rref>suggestion</rref></li>
<li><rref>superscript</rref></li>
<li><rref>table</rref></li>
<li><rref>term</rref></li>
Expand Down Expand Up @@ -8216,6 +8217,107 @@ <h5>Presentational Roles Conflict Resolution</h5>
</tbody>
</table>
</div>
<div class="role" id="suggestion">
<rdef>suggestion</rdef>
<div class="role-description">
<p>A single proposed change to content.</p>
<p>For example, in an editing system that supports multiple users, one user may suggest a change, and another user would be responsible
for accepting or rejecting the suggestion.</p>
<p>Authors MUST ensure that a <code>suggestion</code> contains either one <rref>insertion</rref> child or one <rref>deletion</rref> child or ensure that it contains two children where one is an <rref>insertion</rref> and the other is a <rref>deletion</rref>. Authors MUST ensure a <code>suggestion</code> does not contain any other children.</p>
<p>Authors MAY use <pref>aria-details</pref> or <pref>aria-description</pref> to associate the <code>suggestion</code> with related information such as comments, authoring info, and time stamps.</p>
<pre class="example highlight">
&lt;p&gt;
The best pet is a
&lt;span role="suggestion"&gt;
&lt;span role="deletion"&gt;cat&lt;/span&gt;
&lt;span role="insertion"&gt;dog&lt;/span&gt;
&lt;/span&gt;
&lt;/p&gt;
</pre>
<p>When a suggestion is accepted, authors SHOULD remove the <code>suggestion</code> role, indicating that the proposed revision has been made.
After the <code>suggestion</code> role is removed, child <rref>insertion</rref> and <rref>deletion</rref> elements can either be retained to document the revision or replaced with the revised content.
</p>
</div>
<table class="role-features">
<caption>Characteristics:</caption>
<thead>
<tr>
<th scope="col">Characteristic</th>
<th scope="col">Value</th>
</tr>
</thead>
<tbody>
<tr>
<th class="role-abstract-head" scope="row">Is Abstract:</th>
<td class="role-abstract"> </td>
</tr>
<tr>
<th class="role-parent-head" scope="row">Superclass Role:</th>
<td class="role-parent"><rref>section</rref></td>
</tr>
<tr>
<th class="role-base-head" scope="row">Base Concept:</th>
<td class="role-base"> </td>
</tr>
<tr>
<th class="role-related-head" scope="row">Related Concepts:</th>
<td class="role-related"> </td>
</tr>
<tr>
<th class="role-scope-head" scope="row">Required Context Role:</th>
<td class="role-scope"> </td>
</tr>
<tr>
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
<td class="role-mustcontain">
<li><rref>insertion</rref></li>
<li><rref>deletion</rref></li>
</td>
</tr>
<tr>
<th class="role-required-properties-head">Required States and Properties:</th>
<td class="role-required-properties"> </td>
</tr>
<tr>
<th class="role-properties-head" scope="row">Supported States and Properties:</th>
<td class="role-properties"> </td>
</tr>
<tr>
<th class="role-inherited-head" scope="row">Inherited States and Properties:</th>
<td class="role-inherited">Placeholder</td>
</tr>
<tr>
<th class="role-disallowed-head" scope="row">Prohibited States and Properties:</th>
<td class="role-disallowed">
<ul>
<li><pref>aria-label</pref></li>
<li><pref>aria-labelledby</pref></li>
</ul>
</td>
</tr>
<tr>
<th class="role-namefrom-head" scope="row">Name From:</th>
<td class="role-namefrom">prohibited</td>
</tr>
<tr>
<th class="role-namerequired-head" scope="row">Accessible Name Required:</th>
<td class="role-namerequired"> </td>
</tr>
<tr>
<th class="role-namerequired-inherited-head" scope="row">Inherits Name Required:</th>
<td class="role-namerequired-inherited"> </td>
</tr>
<tr>
<th class="role-childpresentational-head" scope="row">Children Presentational:</th>
<td class="role-childpresentational"> </td>
</tr>
<tr>
<th class="role-presentational-inherited-head" scope="row">Inherits Presentational:</th>
<td class="role-presentational-inherited"> </td>
</tr>
</tbody>
</table>
</div>
<div class="role" id="superscript">
<rdef>superscript</rdef>
<div class="role-description">
Expand Down